Define Tag Library - Tag Documentation

Tag Documentation

The following document contains a summary of all theJellytag libraries.

Tag Libraries

Library	Description
jelly:define	Tag library which allows the creation of new tags using Jelly script itself.

jelly:define

Tag library which allows the creation of new tags using Jelly script itself.

Tag Name	Description
attribute	This tag is bound onto a Java Bean class. When the tag is invoked a bean will be createdusing the tags attributes.The bean may also have an invoke method called invoke(), run(), execute() or some such methodwhich will be invoked after the bean has been configured.
bean	Binds a Java bean to the given named Jelly tag so that the attributes ofthe tag set the bean properties..
classLoader	Creates a new `URLClassLoader` to dynamicallyload tags froms.
dynaBean	Binds a Java bean to the given named Jelly tag so that the attributes ofthe tag set the bean properties..
extend	<extend>is used to extend a dynamic tag defined in an inheriteddynamic tag library
invoke	The <invoke>tag will invoke a given Script instance.It can be used with the <script>tag which defines scriptsas variables that can later be invoked by this <invoke>tag.
invokeBody	<invokeBody>tag is used inside a <tag>tag(i.e. the definition of a dynamic tag) to invoke the tags body whenthe tag is invoked.
jellyBean	Binds a Java bean to the given named Jelly tag so that the attributes ofthe tag set the bean properties. After the body of this tag is invokedthen the beans invoke() method will be called, if the bean has one.
script	<script>tag is used to assign a Script objectto a variable. The script can then be called whenever the user wishesmaybe from inside an expression or more typically via the <invoke>tag.
super	<super>tag is used to invoke a parent tag implementation, whena tag extends an existing tag
tag	<tag>is used to define a new tagusing a Jelly script to implement the behaviour of the tag.Parameters can be passed into the new tag using normal XML attributenotations. Inside the body of the tag definition, the attributes canbe accessed as normal Jelly variables.
taglib	The <taglib>tag is used to define a new tag libraryusing a Jelly script. The tag library is identified by its URI.The tags for a taglib are declared using the org.apache.commons.jelly.tags.define.TagTag.You can 'inherit' tags from a previously defined taglib, as well,allowing runtime extension of tag libraries

This tag is bound onto a Java Bean class. When the tag is invoked a bean will be createdusing the tags attributes.The bean may also have an invoke method called invoke(), run(), execute() or some such methodwhich will be invoked after the bean has been configured.

Attribute Name	Type	Description
defaultValue	org.apache.commons.jelly.expression.Expression	Sets the default value of this attribute
escapeText	boolean
name	java.lang.String	Sets the name of the attribute
required	boolean	Sets whether this attribute is mandatory or not
trim	boolean

define:bean

Binds a Java bean to the given named Jelly tag so that the attributes ofthe tag set the bean properties..

Attribute Name	Type	Description
classLoader	java.lang.ClassLoader	Sets the ClassLoader to use to load the class.If no value is set then the current threads context classloader is used.
className	java.lang.String	Sets the Java class name to use for the tag
escapeText	boolean
name	java.lang.String	Sets the name of the tag to create
trim	boolean
varAttribute	java.lang.String	Sets the name of the attribute used to define the bean variable that this dynamictag will output its results as. This defaults to 'var' though this propertycan be used to change this if it conflicts with a bean property called 'var'.

define:classLoader

Creates a new URLClassLoader to dynamicallyload tags froms.

Attribute Name	Type	Description
classLoader	java.lang.ClassLoader	Sets the ClassLoader to use to load the class.If no value is set then the current threads context classloader is used.
className	java.lang.String	Sets the Java class name to use for the tag
escapeText	boolean
name	java.lang.String	Sets the name of the tag to create
trim	boolean
url	java.lang.String
var	java.lang.String
varAttribute	java.lang.String	Sets the name of the attribute used to define the bean variable that this dynamictag will output its results as. This defaults to 'var' though this propertycan be used to change this if it conflicts with a bean property called 'var'.

define:dynaBean

Binds a Java bean to the given named Jelly tag so that the attributes ofthe tag set the bean properties..

Attribute Name	Type	Description
dynaClass	org.apache.commons.beanutils.DynaClass	Sets the org.apache.commons.beanutils.DynaClasswhich will be bound to this dynamic tag.
escapeText	boolean
name	java.lang.String	Sets the name of the tag to create
trim	boolean
varAttribute	java.lang.String	Sets the name of the attribute used to define the bean variable that this dynamictag will output its results as. This defaults to 'var' though this propertycan be used to change this if it conflicts with a bean property called 'var'.

define:extend

<extend>is used to extend a dynamic tag defined in an inheriteddynamic tag library

Attribute Name	Type	Description
escapeText	boolean
name	java.lang.String	Sets the name of the tag to create
trim	boolean

define:invoke

The <invoke>tag will invoke a given Script instance.It can be used with the <script>tag which defines scriptsas variables that can later be invoked by this <invoke>tag.

Attribute Name	Type	Description
escapeText	boolean
script	org.apache.commons.jelly.Script	Sets the Script to be invoked by this tag, which typically has been previouslydefined by the use of the <script>tag.
trim	boolean

define:invokeBody

<invokeBody>tag is used inside a <tag>tag(i.e. the definition of a dynamic tag) to invoke the tags body whenthe tag is invoked.

Attribute Name	Type	Description
escapeText	boolean
trim	boolean

define:jellyBean

Binds a Java bean to the given named Jelly tag so that the attributes ofthe tag set the bean properties. After the body of this tag is invokedthen the beans invoke() method will be called, if the bean has one.

Attribute Name	Type	Description
classLoader	java.lang.ClassLoader	Sets the ClassLoader to use to load the class.If no value is set then the current threads context classloader is used.
className	java.lang.String	Sets the Java class name to use for the tag
escapeText	boolean
method	java.lang.String	Sets the name of the method to invoke on the bean.This defaults to "run" so that Runnable objects can beinvoked, but this property can be set to whatever is required,such as "execute" or "invoke"
name	java.lang.String	Sets the name of the tag to create
trim	boolean
varAttribute	java.lang.String	Sets the name of the attribute used to define the bean variable that this dynamictag will output its results as. This defaults to 'var' though this propertycan be used to change this if it conflicts with a bean property called 'var'.

define:script

Attribute Name	Type	Description
escapeText	boolean
trim	boolean
var	java.lang.String	Sets the variable name of the tag to create

define:super

<super>tag is used to invoke a parent tag implementation, whena tag extends an existing tag

Attribute Name	Type	Description
escapeText	boolean
trim	boolean

define:tag

<tag>is used to define a new tagusing a Jelly script to implement the behaviour of the tag.Parameters can be passed into the new tag using normal XML attributenotations. Inside the body of the tag definition, the attributes canbe accessed as normal Jelly variables.

Attribute Name	Type	Description
escapeText	boolean
name	java.lang.String	Sets the name of the tag to create
trim	boolean

define:taglib

The <taglib>tag is used to define a new tag libraryusing a Jelly script. The tag library is identified by its URI.The tags for a taglib are declared using the org.apache.commons.jelly.tags.define.TagTag.You can 'inherit' tags from a previously defined taglib, as well,allowing runtime extension of tag libraries

Attribute Name	Type	Description
escapeText	boolean
inherit	boolean	Sets whether this dynamic tag should inherit from the current existing tag libraryof the same URI. This feature is enabled by default so that tags can easily besome tags can be overridden in an existing library, such as when making Mock Tags.You can disable this option if you want to disable any tags in the base library,turning them into just normal static XML.
trim	boolean
uri	java.lang.String	Sets the namespace URI to register this new dynamic tag library with