Package org.apache.velocity.tools.generic

Class MarkupTool

java.lang.Object

org.apache.velocity.tools.generic.SafeConfig

org.apache.velocity.tools.generic.MarkupTool

All Implemented Interfaces:

java.io.Serializable

@DefaultKey("mark")
public class MarkupTool
extends SafeConfig
implements java.io.Serializable

NOTE: This tools is considered "alpha" quality due to lack of testing and a generally unpolished API. Feel free to use but expect changes. Also, this is not automatically provided via the default tools.xml file.

A tool to make it easy to generate XML or HTML on the fly. It uses a CSS-type syntax with a vaguely jQuery-ish API to help you generate the markup you need.

 Example uses in a template:
   #set( $foospan = $markup.span.id($foo.id).body($foo) )
   $markup.tag('table tr.bar td').body("This is $foospan")

 Output:
   <table>
     <tr class="bar">
       <td>This is <span id="foo1">my first foo.</span></td>
     </tr>
   </table>


 Example tools.xml config:
 <tools>
   <toolbox scope="application">
     <tool class="org.apache.velocity.tools.generic.alpha.MarkupTool"/>
   </toolbox>
 </tools>
 

Since:

VelocityTools 2.0

Version:

$Id$

Author:

Nathan Bubna

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MarkupTool.Tag

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	DEFAULT_DELIMITER
static java.lang.String	DEFAULT_TAB

Fields inherited from class org.apache.velocity.tools.generic.SafeConfig

LOCK_CONFIG_KEY, log, LOGGER_NAME_KEY, SAFE_MODE_KEY, USE_CLASS_LOGGER_KEY

Constructor Summary

Constructors

Constructor	Description
MarkupTool()

Method Summary

Modifier and Type	Method	Description
MarkupTool.Tag	get(java.lang.String tag)
java.lang.String	getTab()
protected MarkupTool.Tag	parse(java.lang.String definition)
void	setTab(java.lang.String tab)	Configuration
protected java.lang.String[]	split(java.lang.String me)
MarkupTool.Tag	tag(java.lang.String definition)

Methods inherited from class org.apache.velocity.tools.generic.SafeConfig

configure, configure, getLog, initLogger, isConfigLocked, isSafeMode, setLockConfig, setSafeMode

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_TAB

public static final java.lang.String DEFAULT_TAB

See Also:

Constant Field Values

DEFAULT_DELIMITER

public static final java.lang.String DEFAULT_DELIMITER

See Also:

Constant Field Values

Constructor Detail

MarkupTool

public MarkupTool()

Method Detail

setTab

public void setTab(java.lang.String tab)

Configuration

Parameters:

tab - tab string

getTab

public java.lang.String getTab()

get

public MarkupTool.Tag get(java.lang.String tag)

tag

public MarkupTool.Tag tag(java.lang.String definition)

split

protected java.lang.String[] split(java.lang.String me)

parse

protected MarkupTool.Tag parse(java.lang.String definition)