2.1 1.2 tiles http://tiles.apache.org/tags-tiles This tag library provides Tiles tags.

]]>
insertTemplate org.apache.tiles.jsp.taglib.InsertTemplateTag JSP Insert a template.

Insert a template with the possibility to pass parameters (called attributes). A template can be seen as a procedure that can take parameters or attributes. <tiles:insertTemplate> allows to define these attributes and pass them to the inserted jsp page, called template. Attributes are defined using nested tag <tiles:putAttribute> or <tiles:putListAttribute>.

You must specify template attribute, for inserting a template

Example :

        
          <tiles:insertTemplate template="/basic/myLayout.jsp" flush="true">
             <tiles:putAttribute name="title" value="My first page" />
             <tiles:putAttribute name="header" value="/common/header.jsp" />
             <tiles:putAttribute name="footer" value="/common/footer.jsp" />
             <tiles:putAttribute name="menu" value="/basic/menu.jsp" />
             <tiles:putAttribute name="body" value="/basic/helloBody.jsp" />
          </tiles:insertTemplate>
        
      
]]>
template true true A string representing the URI of a template (for example, a JSP page).

]]>
flush false false boolean True or false. If true, current page out stream is flushed before insertion.

]]>
ignore false true boolean If this attribute is set to true, and the attribute specified by the name does not exist, simply return without writing anything. The default value is false, which will cause a runtime exception to be thrown.

]]>
role false true If the user is in the specified role, the tag is taken into account; otherwise, the tag is ignored (skipped).

]]>
preparer false true The fully qualified class name of the preparer.
insertDefinition org.apache.tiles.jsp.taglib.InsertDefinitionTag JSP Insert a definition.

Insert a definition with the possibility to override and specify parameters (called attributes). A definition can be seen as a (partially or totally) filled template that can override or complete attribute values. <tiles:insertDefinition> allows to define these attributes and pass them to the inserted jsp page, called template. Attributes are defined using nested tag <tiles:putAttribute> or <tiles:putListAttribute>.

You must specify name tag attribute, for inserting a definition from definitions factory.

Example :

        
          <tiles:insertDefinition name=".my.tiles.defininition flush="true">
             <tiles:putAttribute name="title" value="My first page" />
             <tiles:putAttribute name="header" value="/common/header.jsp" />
             <tiles:putAttribute name="footer" value="/common/footer.jsp" />
             <tiles:putAttribute name="menu" value="/basic/menu.jsp" />
             <tiles:putAttribute name="body" value="/basic/helloBody.jsp" />
          </tiles:insertDefinition>
        
      
]]>
name true true Name of the definition to insert.

]]>
template false true A string representing the URI of a template (for example, a JSP page) that will override the one used by the definition itself.

]]>
flush false false boolean True or false. If true, current page out stream is flushed before insertion.

]]>
ignore false true boolean If this attribute is set to true, and the attribute specified by the name does not exist, simply return without writing anything. The default value is false, which will cause a runtime exception to be thrown.

]]>
role false true If the user is in the specified role, the tag is taken into account; otherwise, the tag is ignored (skipped).

]]>
preparer false true The fully qualified class name of preparer.
insertAttribute org.apache.tiles.jsp.taglib.InsertAttributeTag JSP Inserts the value of an attribute into the page.

This tag can be flexibly used to insert the value of an attribute into a page. As in other usages in Tiles, every attribute can be determined to have a "type", either set explicitly when it was defined, or "computed". If the type is not explicit, then if the attribute value is a valid definition, it will be inserted as such. Otherwise, if it begins with a "/" character, it will be treated as a "template". Finally, if it has not otherwise been assigned a type, it will be treated as a String and included without any special handling.

Example :

        
          <tiles:insertAttribute name="body" />
        
      
]]>
name false true Name of the attribute to insert. This attribute will be ignored if the value attribute is specified.

]]>
value false true java.lang.Object Attribute object to render directly. If it specified, the name attribute will be ignored.

]]>
flush false false boolean True or false. If true, current page out stream is flushed before insertion.

]]>
ignore false true boolean If this attribute is set to true, and the attribute specified by the name does not exist, simply return without writing anything. The default value is false, which will cause a runtime exception to be thrown.

]]>
role false true If the user is in the specified role, the tag is taken into account; otherwise, the tag is ignored (skipped).

]]>
preparer false true The fully qualified name of the preparer.
definition org.apache.tiles.jsp.taglib.definition.DefinitionTag JSP Create a definition at runtime.

Create a new definition at runtime. Newly created definition will be available across the entire request.

]]>
name false true Specifies the name under which the newly created definition bean will be saved.

]]>
template false true A string representing the URI of a template (a JSP page).

]]>
role false true Role to check before inserting this definition. If role is not defined for current user, definition is not inserted. Checking is done at insert time, not during definition process.

]]>
extends false true Name of a parent definition that is used to initialize this new definition. Parent definition is searched in definitions factory.

]]>
preparer false true Specifies the preparer name to use. The specified preparer will be executed before rendering this newly created definition.

]]>
putAttribute org.apache.tiles.jsp.taglib.PutAttributeTag JSP Put an attribute in enclosing attribute container tag.

Enclosing attribute container tag can be :

  • <initContainer>
  • <definition>
  • <insertAttribute>
  • <insertDefinition>
  • <putListAttribute>
(or any other tag which implements the PutAttributeTagParent interface. Exception is thrown if no appropriate tag can be found.

Put tag can have following atributes :

  • name : Name of the attribute
  • value : value to put as attribute
  • type : value type. Possible type are : string (value is used as direct string), template (value is used as a page url to insert), definition (value is used as a definition name to insert), object (value is used as it is)
  • role : Role to check when 'insertAttribute' will be called.

Value can also come from tag body. Tag body is taken into account only if value is not set by one of the tag attributes. In this case Attribute type is "string", unless tag body define another type.

]]>
name true true Name of the attribute.

]]>
value false true java.lang.Object Attribute value. Could be a String or an Object.

]]>
type false false Specify content type: string, template or definition.

  • string : Content is printed directly.
  • template : Content is included from specified URL. Value is used as an URL.
  • definition : Value is the name of a definition defined in factory (xml file). Definition will be searched in the inserted tile, in a <tiles:insertAttribute name="attributeName"> tag, where 'attributeName' is the name used for this tag.
  • object: the value is used as it is.
]]>
role false true If the user is in the specified role, the tag is taken into account; otherwise, the tag is ignored (skipped).

]]>
cascade false false boolean If true, the attribute value will be cascaded to nested templates and definitions.

]]>
putListAttribute org.apache.tiles.jsp.taglib.PutListAttributeTag JSP Declare a list that will be pass as attribute to tile.

Declare a list that will be pass as attribute to tile. List elements are added using the tags 'addAttribute' or 'addListAttribute'. This tag can only be used inside 'insertTemplate', 'insertDefinition', 'definition' tags.

]]>
name true true Name of the list.

]]>
cascade false false boolean If true, the attribute value will be cascaded to nested templates and definitions.

]]>
inherit false false boolean If true, the attribute will put the elements of the attribute with the same name of the parent definition before the ones specified here. By default, it is 'false'.

]]>
addAttribute org.apache.tiles.jsp.taglib.AddAttributeTag JSP Add an element to the surrounding list. Equivalent to 'putAttribute', but for list element.

Add an element to the surrounding list. This tag can only be used inside 'putListAttribute' or 'addListAttribute' tags. Value can come from a direct assignment (value="aValue")

]]>
value false true java.lang.Object Attribute value. Can be a String or Object.

]]>
type false false Specify content type: string, template or definition.

  • string : Content is printed directly.
  • template : Content is included from specified URL. Value is used as an URL.
  • definition : Value denote a definition defined in factory (xml file). Definition will be searched in the inserted tile, in a <insertAttribute name="attributeName"> tag, where 'attributeName' is the name used for this tag.
  • object: the value is used as it is.
]]>
role false true If the user is in the specified role, the tag is taken into account; otherwise, the tag is ignored (skipped).

]]>
addListAttribute org.apache.tiles.jsp.taglib.AddListAttributeTag JSP Declare a list that will be pass as an attribute.

Declare a list that will be pass as an attribute . List elements are added using the tag 'addAttribute' or 'addListAttribute'. This tag can only be used inside 'insertTemplate', 'insertDefinition' or 'definition' tag.

]]>
getAsString org.apache.tiles.jsp.taglib.GetAsStringTag empty Render the value of the specified template attribute to the current JspWriter

Retrieve the value of the specified template attribute property, and render it to the current JspWriter as a String. The usual toString() conversions is applied on found value.

Throw a JSPException if named value is not found.

]]>
name true true Attribute name.

]]>
ignore false true boolean If this attribute is set to true, and the attribute specified by the name does not exist, simply return without writing anything. The default value is false, which will cause a runtime exception to be thrown.

]]>
role false true If the user is in the specified role, the tag is taken into account; otherwise, the tag is ignored (skipped).

]]>
useAttribute org.apache.tiles.jsp.taglib.UseAttributeTag org.apache.tiles.jsp.taglib.UseAttributeTag$Tei empty Use attribute value inside page.

Declare a Java variable, and an attribute in the specified scope, using its attribute value.

Java variable and attribute will have the name specified by 'id', or the original name if not specified.

]]>
id false true Declared attribute and variable name.

]]>
classname false true Class of the declared variable.

]]>
scope false false Scope of the declared attribute. Default to 'page'.

]]>
name true true Attribute name.

]]>
ignore false true boolean If this attribute is set to true, and the attribute specified by the name does not exist, simply return without error. The default value is false, which will cause a runtime exception to be thrown.

]]>
importAttribute org.apache.tiles.jsp.taglib.ImportAttributeTag empty Import attribute(s) in specified context.

Import attribute(s) to requested scope. Attribute name and scope are optional. If not specified, all attributes are imported in page scope. Once imported, an attribute can be used as any other beans from jsp contexts.

]]>
name false true Attribute name. If not specified, all attributes are imported.

]]>
toName false true Name of the destination bean. If not specified, the name will be the same as specified in name attribute

]]>
scope false false Scope into which attribute is imported. Default to page.

]]>
ignore false true boolean If this attribute is set to true, and the attribute specified by the name does not exist, simply return without error. The default value is false, which will cause a runtime exception to be thrown.

]]>
initContainer org.apache.tiles.jsp.taglib.definition.InitContainerTag JSP Initialize the TilesContainer.

In order to use the Tiles system, a TilesContainer must be instantiated. This initialization is generally done by the TilesListener (or perhaps the TilesServlet or TilesFilter).

If the intialization needs to be dynamic, you can initialize the container using this tag. Realize however, that this tag MUST be executed prior to invoking any other definitions. Additionally, the initilization may only be done once, and any subsequent invocations will be ignored.

]]>
containerFactory false true Container Factory implementation used to instantiate the container.

]]>
containerKey false true The key under which the container will be stored.

If not defined, the container will be the default container

]]>
destroyContainer org.apache.tiles.jsp.taglib.definition.DestroyContainerTag empty Destroy the TilesContainer.

]]>
containerKey false true The key of the container to destroy.

If not defined, the destroyed container will be the default container

]]>
setCurrentContainer org.apache.tiles.jsp.taglib.definition.SetCurrentContainerTag empty Sets the current Tiles container to use in Tiles tags.

]]>
containerKey false true The key of the container that will be set as "current".

If not defined, the current container will be the default container

]]>