META-INF.template-suite.xml Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of tiles-template Show documentation
Show all versions of tiles-template Show documentation
Common code for integration of Tiles for different templating technologies.
<org.apache.tiles.autotag.model.TemplateSuite> <name>tiles</name> <templateClasses class="linked-hash-map"> <entry> <string>org.apache.tiles.template.InsertDefinitionModel</string> <org.apache.tiles.autotag.model.TemplateClass> <name>org.apache.tiles.template.InsertDefinitionModel</name> <tagName>insertDefinition</tagName> <tagClassPrefix>InsertDefinition</tagClassPrefix> <documentation><p> <strong>Insert a definition.</strong> </p> <p> 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. <code>&lt;tiles:insertDefinition&gt;</code> allows to define these attributes and pass them to the inserted jsp page, called template. Attributes are defined using nested tag <code>&lt;tiles:putAttribute&gt;</code> or <code>&lt;tiles:putListAttribute&gt;</code>. </p> <p> You must specify <code>name</code> tag attribute, for inserting a definition from definitions factory. </p> <p> <strong>Example : </strong> </p> <pre> &lt;code&gt; &lt;tiles:insertDefinition name=&quot;.my.tiles.defininition flush=&quot;true&quot;&gt; &lt;tiles:putAttribute name=&quot;title&quot; value=&quot;My first page&quot; /&gt; &lt;tiles:putAttribute name=&quot;header&quot; value=&quot;/common/header.jsp&quot; /&gt; &lt;tiles:putAttribute name=&quot;footer&quot; value=&quot;/common/footer.jsp&quot; /&gt; &lt;tiles:putAttribute name=&quot;menu&quot; value=&quot;/basic/menu.jsp&quot; /&gt; &lt;tiles:putAttribute name=&quot;body&quot; value=&quot;/basic/helloBody.jsp&quot; /&gt; &lt;/tiles:insertDefinition&gt; &lt;/code&gt; </pre></documentation> <executeMethod> <name>execute</name> <documentation>Executes the operation.</documentation> <parameters class="linked-hash-map"> <entry> <string>definitionName</string> <org.apache.tiles.autotag.model.TemplateParameter> <name>definitionName</name> <exportedName>name</exportedName> <documentation>The name of the definition to render.</documentation> <type>java.lang.String</type> <required>true</required> <request>false</request> </org.apache.tiles.autotag.model.TemplateParameter> </entry> <entry> <string>template</string> <org.apache.tiles.autotag.model.TemplateParameter> <name>template</name> <exportedName>template</exportedName> <documentation>If specified, this template will be used instead of the one used by the definition.</documentation> <type>java.lang.String</type> <required>false</required> <request>false</request> </org.apache.tiles.autotag.model.TemplateParameter> </entry> <entry> <string>templateType</string> <org.apache.tiles.autotag.model.TemplateParameter> <name>templateType</name> <exportedName>templateType</exportedName> <documentation>The type of the template attribute.</documentation> <type>java.lang.String</type> <required>false</required> <request>false</request> </org.apache.tiles.autotag.model.TemplateParameter> </entry> <entry> <string>templateExpression</string> <org.apache.tiles.autotag.model.TemplateParameter> <name>templateExpression</name> <exportedName>templateExpression</exportedName> <documentation>The expression to evaluate to get the value of the template.</documentation> <type>java.lang.String</type> <required>false</required> <request>false</request> </org.apache.tiles.autotag.model.TemplateParameter> </entry> <entry> <string>role</string> <org.apache.tiles.autotag.model.TemplateParameter> <name>role</name> <exportedName>role</exportedName> <documentation>A comma-separated list of roles. If present, the definition will be rendered only if the current user belongs to one of the roles.</documentation> <type>java.lang.String</type> <required>false</required> <request>false</request> </org.apache.tiles.autotag.model.TemplateParameter> </entry> <entry> <string>preparer</string> <org.apache.tiles.autotag.model.TemplateParameter> <name>preparer</name> <exportedName>preparer</exportedName> <documentation>The preparer to use to invoke before the definition is rendered. If specified, it overrides the preparer specified in the definition itself.</documentation> <type>java.lang.String</type> <required>false</required> <request>false</request> </org.apache.tiles.autotag.model.TemplateParameter> </entry> <entry> <string>flush</string> <org.apache.tiles.autotag.model.TemplateParameter> <name>flush</name> <exportedName>flush</exportedName> <documentation>If <code>true</code>, the response will be flushed after the insert.</documentation> <type>boolean</type> <required>false</required> <request>false</request> </org.apache.tiles.autotag.model.TemplateParameter> </entry> <entry> <string>request</string> <org.apache.tiles.autotag.model.TemplateParameter> <name>request</name> <exportedName>request</exportedName> <documentation>The request.</documentation> <type>org.apache.tiles.request.Request</type> <required>false</required> <request>true</request> </org.apache.tiles.autotag.model.TemplateParameter> </entry> <entry> <string>modelBody</string> <org.apache.tiles.autotag.model.TemplateParameter> <name>modelBody</name> <exportedName>modelBody</exportedName> <documentation>The body.</documentation> <type>org.apache.tiles.autotag.core.runtime.ModelBody</type> <required>false</required> <request>false</request> </org.apache.tiles.autotag.model.TemplateParameter> </entry> </parameters> </executeMethod> </org.apache.tiles.autotag.model.TemplateClass> </entry> <entry> <string>org.apache.tiles.template.InsertTemplateModel</string> <org.apache.tiles.autotag.model.TemplateClass> <name>org.apache.tiles.template.InsertTemplateModel</name> <tagName>insertTemplate</tagName> <tagClassPrefix>InsertTemplate</tagClassPrefix> <documentation><p> <strong>Insert a template.</strong> </p> <p> 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. <code>&lt;tiles:insertTemplate&gt;</code> allows to define these attributes and pass them to the inserted jsp page, called template. Attributes are defined using nested tag <code>&lt;tiles:putAttribute&gt;</code> or <code>&lt;tiles:putListAttribute&gt;</code>. </p> <p> You must specify <code>template</code> attribute, for inserting a template </p> <p> <strong>Example : </strong> </p> <pre> &lt;code&gt; &lt;tiles:insertTemplate template=&quot;/basic/myLayout.jsp&quot; flush=&quot;true&quot;&gt; &lt;tiles:putAttribute name=&quot;title&quot; value=&quot;My first page&quot; /&gt; &lt;tiles:putAttribute name=&quot;header&quot; value=&quot;/common/header.jsp&quot; /&gt; &lt;tiles:putAttribute name=&quot;footer&quot; value=&quot;/common/footer.jsp&quot; /&gt; &lt;tiles:putAttribute name=&quot;menu&quot; value=&quot;/basic/menu.jsp&quot; /&gt; &lt;tiles:putAttribute name=&quot;body&quot; value=&quot;/basic/helloBody.jsp&quot; /&gt; &lt;/tiles:insertTemplate&gt; &lt;/code&gt; </pre></documentation> <executeMethod> <name>execute</name> <documentation>Executes the operation.</documentation> <parameters class="linked-hash-map"> <entry> <string>template</string> <org.apache.tiles.autotag.model.TemplateParameter> <name>template</name> <exportedName>template</exportedName> <documentation>The template to render.</documentation> <type>java.lang.String</type> <required>true</required> <request>false</request> </org.apache.tiles.autotag.model.TemplateParameter> </entry> <entry> <string>templateType</string> <org.apache.tiles.autotag.model.TemplateParameter> <name>templateType</name> <exportedName>templateType</exportedName> <documentation>The type of the template attribute.</documentation> <type>java.lang.String</type> <required>false</required> <request>false</request> </org.apache.tiles.autotag.model.TemplateParameter> </entry> <entry> <string>templateExpression</string> <org.apache.tiles.autotag.model.TemplateParameter> <name>templateExpression</name> <exportedName>templateExpression</exportedName> <documentation>The expression to evaluate to get the value of the template.</documentation> <type>java.lang.String</type> <required>false</required> <request>false</request> </org.apache.tiles.autotag.model.TemplateParameter> </entry> <entry> <string>role</string> <org.apache.tiles.autotag.model.TemplateParameter> <name>role</name> <exportedName>role</exportedName> <documentation>A comma-separated list of roles. If present, the template will be rendered only if the current user belongs to one of the roles.</documentation> <type>java.lang.String</type> <required>false</required> <request>false</request> </org.apache.tiles.autotag.model.TemplateParameter> </entry> <entry> <string>preparer</string> <org.apache.tiles.autotag.model.TemplateParameter> <name>preparer</name> <exportedName>preparer</exportedName> <documentation>The preparer to use to invoke before the definition is rendered. If specified, it overrides the preparer specified in the definition itself.</documentation> <type>java.lang.String</type> <required>false</required> <request>false</request> </org.apache.tiles.autotag.model.TemplateParameter> </entry> <entry> <string>flush</string> <org.apache.tiles.autotag.model.TemplateParameter> <name>flush</name> <exportedName>flush</exportedName> <documentation>If <code>true</code>, the response will be flushed after the insert.</documentation> <type>boolean</type> <required>false</required> <request>false</request> </org.apache.tiles.autotag.model.TemplateParameter> </entry> <entry> <string>request</string> <org.apache.tiles.autotag.model.TemplateParameter> <name>request</name> <exportedName>request</exportedName> <documentation>The request.</documentation> <type>org.apache.tiles.request.Request</type> <required>false</required> <request>true</request> </org.apache.tiles.autotag.model.TemplateParameter> </entry> <entry> <string>modelBody</string> <org.apache.tiles.autotag.model.TemplateParameter> <name>modelBody</name> <exportedName>modelBody</exportedName> <documentation>The body.</documentation> <type>org.apache.tiles.autotag.core.runtime.ModelBody</type> <required>false</required> <request>false</request> </org.apache.tiles.autotag.model.TemplateParameter> </entry> </parameters> </executeMethod> </org.apache.tiles.autotag.model.TemplateClass> </entry> <entry> <string>org.apache.tiles.template.ImportAttributeModel</string> <org.apache.tiles.autotag.model.TemplateClass> <name>org.apache.tiles.template.ImportAttributeModel</name> <tagName>importAttribute</tagName> <tagClassPrefix>ImportAttribute</tagClassPrefix> <documentation><p> <strong>Import attribute(s) in specified context.</strong> </p> <p> 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. </p></documentation> <executeMethod> <name>execute</name> <documentation>Executes the model.</documentation> <parameters class="linked-hash-map"> <entry> <string>name</string> <org.apache.tiles.autotag.model.TemplateParameter> <name>name</name> <exportedName>name</exportedName> <documentation>The name of the attribute to import. If it is <code>null</code>, all the attributes will be imported.</documentation> <type>java.lang.String</type> <required>false</required> <request>false</request> </org.apache.tiles.autotag.model.TemplateParameter> </entry> <entry> <string>scope</string> <org.apache.tiles.autotag.model.TemplateParameter> <name>scope</name> <exportedName>scope</exportedName> <documentation>The scope into which the attribute(s) will be imported. If <code>null</code>, the import will go in page scope.</documentation> <type>java.lang.String</type> <required>false</required> <request>false</request> </org.apache.tiles.autotag.model.TemplateParameter> </entry> <entry> <string>toName</string> <org.apache.tiles.autotag.model.TemplateParameter> <name>toName</name> <exportedName>toName</exportedName> <documentation>The name of the attribute into which the attribute will be imported. To be used in conjunction to <code>name</code>. If <code>null</code>, the value of <code>name</code> will be used.</documentation> <type>java.lang.String</type> <required>false</required> <request>false</request> </org.apache.tiles.autotag.model.TemplateParameter> </entry> <entry> <string>ignore</string> <org.apache.tiles.autotag.model.TemplateParameter> <name>ignore</name> <exportedName>ignore</exportedName> <documentation>If <code>true</code>, if the attribute is not present, the problem will be ignored.</documentation> <type>boolean</type> <required>false</required> <request>false</request> </org.apache.tiles.autotag.model.TemplateParameter> </entry> <entry> <string>request</string> <org.apache.tiles.autotag.model.TemplateParameter> <name>request</name> <exportedName>request</exportedName> <documentation>The request.</documentation> <type>org.apache.tiles.request.Request</type> <required>false</required> <request>true</request> </org.apache.tiles.autotag.model.TemplateParameter> </entry> </parameters> </executeMethod> </org.apache.tiles.autotag.model.TemplateClass> </entry> <entry> <string>org.apache.tiles.template.PutAttributeModel</string> <org.apache.tiles.autotag.model.TemplateClass> <name>org.apache.tiles.template.PutAttributeModel</name> <tagName>putAttribute</tagName> <tagClassPrefix>PutAttribute</tagClassPrefix> <documentation><p> <strong>Put an attribute in enclosing attribute container tag.</strong> </p> <p> Enclosing attribute container tag can be : <ul> <li>&lt;initContainer&gt;</li> <li>&lt;definition&gt;</li> <li>&lt;insertAttribute&gt;</li> <li>&lt;insertDefinition&gt;</li> <li>&lt;putListAttribute&gt;</li> </ul> (or any other tag which implements the <code>PutAttributeTagParent</code> interface. Exception is thrown if no appropriate tag can be found. </p> <p> Put tag can have following atributes : <ul> <li>name : Name of the attribute</li> <li>value : value to put as attribute</li> <li>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)</li> <li>role : Role to check when 'insertAttribute' will be called.</li> </ul> </p> <p> 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. </p></documentation> <executeMethod> <name>execute</name> <documentation>Executes the operation.</documentation> <parameters class="linked-hash-map"> <entry> <string>name</string> <org.apache.tiles.autotag.model.TemplateParameter> <name>name</name> <exportedName>name</exportedName> <documentation>The name of the attribute to put.</documentation> <type>java.lang.String</type> <required>true</required> <request>false</request> </org.apache.tiles.autotag.model.TemplateParameter> </entry> <entry> <string>value</string> <org.apache.tiles.autotag.model.TemplateParameter> <name>value</name> <exportedName>value</exportedName> <documentation>The value of the attribute. Use this parameter, or expression, or body.</documentation> <type>java.lang.Object</type> <required>false</required> <request>false</request> </org.apache.tiles.autotag.model.TemplateParameter> </entry> <entry> <string>expression</string> <org.apache.tiles.autotag.model.TemplateParameter> <name>expression</name> <exportedName>expression</exportedName> <documentation>The expression to calculate the value from. Use this parameter, or value, or body.</documentation> <type>java.lang.String</type> <required>false</required> <request>false</request> </org.apache.tiles.autotag.model.TemplateParameter> </entry> <entry> <string>role</string> <org.apache.tiles.autotag.model.TemplateParameter> <name>role</name> <exportedName>role</exportedName> <documentation>A comma-separated list of roles. If present, the attribute will be rendered only if the current user belongs to one of the roles.</documentation> <type>java.lang.String</type> <required>false</required> <request>false</request> </org.apache.tiles.autotag.model.TemplateParameter> </entry> <entry> <string>type</string> <org.apache.tiles.autotag.model.TemplateParameter> <name>type</name> <exportedName>type</exportedName> <documentation>The type (renderer) of the attribute.</documentation> <type>java.lang.String</type> <required>false</required> <request>false</request> </org.apache.tiles.autotag.model.TemplateParameter> </entry> <entry> <string>cascade</string> <org.apache.tiles.autotag.model.TemplateParameter> <name>cascade</name> <exportedName>cascade</exportedName> <documentation>If <code>true</code> the attribute will be cascaded to all nested attributes.</documentation> <type>boolean</type> <required>false</required> <request>false</request> </org.apache.tiles.autotag.model.TemplateParameter> </entry> <entry> <string>request</string> <org.apache.tiles.autotag.model.TemplateParameter> <name>request</name> <exportedName>request</exportedName> <documentation>The request.</documentation> <type>org.apache.tiles.request.Request</type> <required>false</required> <request>true</request> </org.apache.tiles.autotag.model.TemplateParameter> </entry> <entry> <string>modelBody</string> <org.apache.tiles.autotag.model.TemplateParameter> <name>modelBody</name> <exportedName>modelBody</exportedName> <documentation>The body.</documentation> <type>org.apache.tiles.autotag.core.runtime.ModelBody</type> <required>false</required> <request>false</request> </org.apache.tiles.autotag.model.TemplateParameter> </entry> </parameters> </executeMethod> </org.apache.tiles.autotag.model.TemplateClass> </entry> <entry> <string>org.apache.tiles.template.AddListAttributeModel</string> <org.apache.tiles.autotag.model.TemplateClass> <name>org.apache.tiles.template.AddListAttributeModel</name> <tagName>addListAttribute</tagName> <tagClassPrefix>AddListAttribute</tagClassPrefix> <documentation><p> <strong>Declare a list that will be pass as an attribute. </strong> </p> <p> 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. </p></documentation> <executeMethod> <name>execute</name> <documentation>Executes the model.</documentation> <parameters class="linked-hash-map"> <entry> <string>role</string> <org.apache.tiles.autotag.model.TemplateParameter> <name>role</name> <exportedName>role</exportedName> <documentation>The comma-separated list of roles that can use the list attribute.</documentation> <type>java.lang.String</type> <required>false</required> <request>false</request> </org.apache.tiles.autotag.model.TemplateParameter> </entry> <entry> <string>request</string> <org.apache.tiles.autotag.model.TemplateParameter> <name>request</name> <exportedName>request</exportedName> <documentation>The request.</documentation> <type>org.apache.tiles.request.Request</type> <required>false</required> <request>true</request> </org.apache.tiles.autotag.model.TemplateParameter> </entry> <entry> <string>modelBody</string> <org.apache.tiles.autotag.model.TemplateParameter> <name>modelBody</name> <exportedName>modelBody</exportedName> <documentation>The body.</documentation> <type>org.apache.tiles.autotag.core.runtime.ModelBody</type> <required>false</required> <request>false</request> </org.apache.tiles.autotag.model.TemplateParameter> </entry> </parameters> </executeMethod> </org.apache.tiles.autotag.model.TemplateClass> </entry> <entry> <string>org.apache.tiles.template.GetAsStringModel</string> <org.apache.tiles.autotag.model.TemplateClass> <name>org.apache.tiles.template.GetAsStringModel</name> <tagName>getAsString</tagName> <tagClassPrefix>GetAsString</tagClassPrefix> <documentation><p> <strong> Render the value of the specified template attribute to the current Writer</strong> </p> <p> Retrieve the value of the specified template attribute property, and render it to the current Writer as a String. The usual toString() conversions is applied on found value. </p></documentation> <executeMethod> <name>execute</name> <documentation>Executes the operation.</documentation> <parameters class="linked-hash-map"> <entry> <string>ignore</string> <org.apache.tiles.autotag.model.TemplateParameter> <name>ignore</name> <exportedName>ignore</exportedName> <documentation>If <code>true</code>, if an exception happens during rendering, of if the attribute is null, the problem will be ignored.</documentation> <type>boolean</type> <required>false</required> <request>false</request> </org.apache.tiles.autotag.model.TemplateParameter> </entry> <entry> <string>preparer</string> <org.apache.tiles.autotag.model.TemplateParameter> <name>preparer</name> <exportedName>preparer</exportedName> <documentation>The preparer to invoke before rendering the attribute.</documentation> <type>java.lang.String</type> <required>false</required> <request>false</request> </org.apache.tiles.autotag.model.TemplateParameter> </entry> <entry> <string>role</string> <org.apache.tiles.autotag.model.TemplateParameter> <name>role</name> <exportedName>role</exportedName> <documentation>A comma-separated list of roles. If present, the attribute will be rendered only if the current user belongs to one of the roles.</documentation> <type>java.lang.String</type> <required>false</required> <request>false</request> </org.apache.tiles.autotag.model.TemplateParameter> </entry> <entry> <string>defaultValue</string> <org.apache.tiles.autotag.model.TemplateParameter> <name>defaultValue</name> <exportedName>defaultValue</exportedName> <documentation>The default value of the attribute. To use only if the attribute was not computed.</documentation> <type>java.lang.Object</type> <required>false</required> <request>false</request> </org.apache.tiles.autotag.model.TemplateParameter> </entry> <entry> <string>defaultValueRole</string> <org.apache.tiles.autotag.model.TemplateParameter> <name>defaultValueRole</name> <exportedName>defaultValueRole</exportedName> <documentation>The default comma-separated list of roles. To use only if the attribute was not computed.</documentation> <type>java.lang.String</type> <required>false</required> <request>false</request> </org.apache.tiles.autotag.model.TemplateParameter> </entry> <entry> <string>defaultValueType</string> <org.apache.tiles.autotag.model.TemplateParameter> <name>defaultValueType</name> <exportedName>defaultValueType</exportedName> <documentation>The default type of the attribute. To use only if the attribute was not computed.</documentation> <type>java.lang.String</type> <required>false</required> <request>false</request> </org.apache.tiles.autotag.model.TemplateParameter> </entry> <entry> <string>name</string> <org.apache.tiles.autotag.model.TemplateParameter> <name>name</name> <exportedName>name</exportedName> <documentation>The name of the attribute.</documentation> <type>java.lang.String</type> <required>true</required> <request>false</request> </org.apache.tiles.autotag.model.TemplateParameter> </entry> <entry> <string>value</string> <org.apache.tiles.autotag.model.TemplateParameter> <name>value</name> <exportedName>value</exportedName> <documentation>The attribute to use immediately, if not null.</documentation> <type>org.apache.tiles.Attribute</type> <required>false</required> <request>false</request> </org.apache.tiles.autotag.model.TemplateParameter> </entry> <entry> <string>request</string> <org.apache.tiles.autotag.model.TemplateParameter> <name>request</name> <exportedName>request</exportedName> <documentation>The request.</documentation> <type>org.apache.tiles.request.Request</type> <required>false</required> <request>true</request> </org.apache.tiles.autotag.model.TemplateParameter> </entry> <entry> <string>modelBody</string> <org.apache.tiles.autotag.model.TemplateParameter> <name>modelBody</name> <exportedName>modelBody</exportedName> <documentation>The body.</documentation> <type>org.apache.tiles.autotag.core.runtime.ModelBody</type> <required>false</required> <request>false</request> </org.apache.tiles.autotag.model.TemplateParameter> </entry> </parameters> </executeMethod> </org.apache.tiles.autotag.model.TemplateClass> </entry> <entry> <string>org.apache.tiles.template.AddAttributeModel</string> <org.apache.tiles.autotag.model.TemplateClass> <name>org.apache.tiles.template.AddAttributeModel</name> <tagName>addAttribute</tagName> <tagClassPrefix>AddAttribute</tagClassPrefix> <documentation><p> <strong>Add an element to the surrounding list. Equivalent to 'putAttribute', but for list element.</strong> </p> <p> 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") </p></documentation> <executeMethod> <name>execute</name> <documentation>Executes the operation.</documentation> <parameters class="linked-hash-map"> <entry> <string>value</string> <org.apache.tiles.autotag.model.TemplateParameter> <name>value</name> <exportedName>value</exportedName> <documentation>The value of the attribute. Use this parameter, or expression, or body.</documentation> <type>java.lang.Object</type> <required>false</required> <request>false</request> </org.apache.tiles.autotag.model.TemplateParameter> </entry> <entry> <string>expression</string> <org.apache.tiles.autotag.model.TemplateParameter> <name>expression</name> <exportedName>expression</exportedName> <documentation>The expression to calculate the value from. Use this parameter, or value, or body.</documentation> <type>java.lang.String</type> <required>false</required> <request>false</request> </org.apache.tiles.autotag.model.TemplateParameter> </entry> <entry> <string>role</string> <org.apache.tiles.autotag.model.TemplateParameter> <name>role</name> <exportedName>role</exportedName> <documentation>A comma-separated list of roles. If present, the attribute will be rendered only if the current user belongs to one of the roles.</documentation> <type>java.lang.String</type> <required>false</required> <request>false</request> </org.apache.tiles.autotag.model.TemplateParameter> </entry> <entry> <string>type</string> <org.apache.tiles.autotag.model.TemplateParameter> <name>type</name> <exportedName>type</exportedName> <documentation>The type (renderer) of the attribute.</documentation> <type>java.lang.String</type> <required>false</required> <request>false</request> </org.apache.tiles.autotag.model.TemplateParameter> </entry> <entry> <string>request</string> <org.apache.tiles.autotag.model.TemplateParameter> <name>request</name> <exportedName>request</exportedName> <documentation>The request.</documentation> <type>org.apache.tiles.request.Request</type> <required>false</required> <request>true</request> </org.apache.tiles.autotag.model.TemplateParameter> </entry> <entry> <string>modelBody</string> <org.apache.tiles.autotag.model.TemplateParameter> <name>modelBody</name> <exportedName>modelBody</exportedName> <documentation>The body.</documentation> <type>org.apache.tiles.autotag.core.runtime.ModelBody</type> <required>false</required> <request>false</request> </org.apache.tiles.autotag.model.TemplateParameter> </entry> </parameters> </executeMethod> </org.apache.tiles.autotag.model.TemplateClass> </entry> <entry> <string>org.apache.tiles.template.SetCurrentContainerModel</string> <org.apache.tiles.autotag.model.TemplateClass> <name>org.apache.tiles.template.SetCurrentContainerModel</name> <tagName>setCurrentContainer</tagName> <tagClassPrefix>SetCurrentContainer</tagClassPrefix> <documentation>Selects a container to be used as the "current" container.</documentation> <executeMethod> <name>execute</name> <documentation>Executes the model.</documentation> <parameters class="linked-hash-map"> <entry> <string>containerKey</string> <org.apache.tiles.autotag.model.TemplateParameter> <name>containerKey</name> <exportedName>containerKey</exportedName> <documentation>The key of the container to be used as "current". If <code>null</code>, the default one will be used.</documentation> <type>java.lang.String</type> <required>false</required> <request>false</request> </org.apache.tiles.autotag.model.TemplateParameter> </entry> <entry> <string>request</string> <org.apache.tiles.autotag.model.TemplateParameter> <name>request</name> <exportedName>request</exportedName> <documentation>The request.</documentation> <type>org.apache.tiles.request.Request</type> <required>false</required> <request>true</request> </org.apache.tiles.autotag.model.TemplateParameter> </entry> </parameters> </executeMethod> </org.apache.tiles.autotag.model.TemplateClass> </entry> <entry> <string>org.apache.tiles.template.InsertAttributeModel</string> <org.apache.tiles.autotag.model.TemplateClass> <name>org.apache.tiles.template.InsertAttributeModel</name> <tagName>insertAttribute</tagName> <tagClassPrefix>InsertAttribute</tagClassPrefix> <documentation><p> <strong>Inserts the value of an attribute into the page.</strong> </p> <p> 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. </p> <p> <strong>Example : </strong> </p> <pre> &lt;code&gt; &lt;tiles:insertAttribute name=&quot;body&quot; /&gt; &lt;/code&gt; </pre></documentation> <executeMethod> <name>execute</name> <documentation>Executes the operation.</documentation> <parameters class="linked-hash-map"> <entry> <string>ignore</string> <org.apache.tiles.autotag.model.TemplateParameter> <name>ignore</name> <exportedName>ignore</exportedName> <documentation>If <code>true</code>, if an exception happens during rendering, of if the attribute is null, the problem will be ignored.</documentation> <type>boolean</type> <required>false</required> <request>false</request> </org.apache.tiles.autotag.model.TemplateParameter> </entry> <entry> <string>preparer</string> <org.apache.tiles.autotag.model.TemplateParameter> <name>preparer</name> <exportedName>preparer</exportedName> <documentation>The preparer to invoke before rendering the attribute.</documentation> <type>java.lang.String</type> <required>false</required> <request>false</request> </org.apache.tiles.autotag.model.TemplateParameter> </entry> <entry> <string>role</string> <org.apache.tiles.autotag.model.TemplateParameter> <name>role</name> <exportedName>role</exportedName> <documentation>A comma-separated list of roles. If present, the attribute will be rendered only if the current user belongs to one of the roles.</documentation> <type>java.lang.String</type> <required>false</required> <request>false</request> </org.apache.tiles.autotag.model.TemplateParameter> </entry> <entry> <string>defaultValue</string> <org.apache.tiles.autotag.model.TemplateParameter> <name>defaultValue</name> <exportedName>defaultValue</exportedName> <documentation>The default value of the attribute. To use only if the attribute was not computed.</documentation> <type>java.lang.Object</type> <required>false</required> <request>false</request> </org.apache.tiles.autotag.model.TemplateParameter> </entry> <entry> <string>defaultValueRole</string> <org.apache.tiles.autotag.model.TemplateParameter> <name>defaultValueRole</name> <exportedName>defaultValueRole</exportedName> <documentation>The default comma-separated list of roles. To use only if the attribute was not computed.</documentation> <type>java.lang.String</type> <required>false</required> <request>false</request> </org.apache.tiles.autotag.model.TemplateParameter> </entry> <entry> <string>defaultValueType</string> <org.apache.tiles.autotag.model.TemplateParameter> <name>defaultValueType</name> <exportedName>defaultValueType</exportedName> <documentation>The default type of the attribute. To use only if the attribute was not computed.</documentation> <type>java.lang.String</type> <required>false</required> <request>false</request> </org.apache.tiles.autotag.model.TemplateParameter> </entry> <entry> <string>name</string> <org.apache.tiles.autotag.model.TemplateParameter> <name>name</name> <exportedName>name</exportedName> <documentation>The name of the attribute.</documentation> <type>java.lang.String</type> <required>false</required> <request>false</request> </org.apache.tiles.autotag.model.TemplateParameter> </entry> <entry> <string>value</string> <org.apache.tiles.autotag.model.TemplateParameter> <name>value</name> <exportedName>value</exportedName> <documentation>The attribute to use immediately, if not null.</documentation> <type>org.apache.tiles.Attribute</type> <required>false</required> <request>false</request> </org.apache.tiles.autotag.model.TemplateParameter> </entry> <entry> <string>flush</string> <org.apache.tiles.autotag.model.TemplateParameter> <name>flush</name> <exportedName>flush</exportedName> <documentation>If <code>true</code>, the response will be flushed after the insert.</documentation> <type>boolean</type> <required>false</required> <request>false</request> </org.apache.tiles.autotag.model.TemplateParameter> </entry> <entry> <string>request</string> <org.apache.tiles.autotag.model.TemplateParameter> <name>request</name> <exportedName>request</exportedName> <documentation>The request.</documentation> <type>org.apache.tiles.request.Request</type> <required>false</required> <request>true</request> </org.apache.tiles.autotag.model.TemplateParameter> </entry> <entry> <string>modelBody</string> <org.apache.tiles.autotag.model.TemplateParameter> <name>modelBody</name> <exportedName>modelBody</exportedName> <documentation>The body.</documentation> <type>org.apache.tiles.autotag.core.runtime.ModelBody</type> <required>false</required> <request>false</request> </org.apache.tiles.autotag.model.TemplateParameter> </entry> </parameters> </executeMethod> </org.apache.tiles.autotag.model.TemplateClass> </entry> <entry> <string>org.apache.tiles.template.PutListAttributeModel</string> <org.apache.tiles.autotag.model.TemplateClass> <name>org.apache.tiles.template.PutListAttributeModel</name> <tagName>putListAttribute</tagName> <tagClassPrefix>PutListAttribute</tagClassPrefix> <documentation><p> <strong>Declare a list that will be pass as attribute to tile. </strong> </p> <p> 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. </p></documentation> <executeMethod> <name>execute</name> <documentation>Executes the model.</documentation> <parameters class="linked-hash-map"> <entry> <string>name</string> <org.apache.tiles.autotag.model.TemplateParameter> <name>name</name> <exportedName>name</exportedName> <documentation>The name of the attribute to put.</documentation> <type>java.lang.String</type> <required>true</required> <request>false</request> </org.apache.tiles.autotag.model.TemplateParameter> </entry> <entry> <string>role</string> <org.apache.tiles.autotag.model.TemplateParameter> <name>role</name> <exportedName>role</exportedName> <documentation>A comma-separated list of roles. If present, the attribute will be rendered only if the current user belongs to one of the roles.</documentation> <type>java.lang.String</type> <required>false</required> <request>false</request> </org.apache.tiles.autotag.model.TemplateParameter> </entry> <entry> <string>inherit</string> <org.apache.tiles.autotag.model.TemplateParameter> <name>inherit</name> <exportedName>inherit</exportedName> <documentation>If <code>true</code>, the list attribute will use, as first elements, the list contained in the list attribute, put with the same name, of the containing definition.</documentation> <type>boolean</type> <required>false</required> <request>false</request> </org.apache.tiles.autotag.model.TemplateParameter> </entry> <entry> <string>cascade</string> <org.apache.tiles.autotag.model.TemplateParameter> <name>cascade</name> <exportedName>cascade</exportedName> <documentation>If <code>true</code> the attribute will be cascaded to all nested attributes.</documentation> <type>boolean</type> <required>false</required> <request>false</request> </org.apache.tiles.autotag.model.TemplateParameter> </entry> <entry> <string>request</string> <org.apache.tiles.autotag.model.TemplateParameter> <name>request</name> <exportedName>request</exportedName> <documentation>The request.</documentation> <type>org.apache.tiles.request.Request</type> <required>false</required> <request>true</request> </org.apache.tiles.autotag.model.TemplateParameter> </entry> <entry> <string>modelBody</string> <org.apache.tiles.autotag.model.TemplateParameter> <name>modelBody</name> <exportedName>modelBody</exportedName> <documentation>The body.</documentation> <type>org.apache.tiles.autotag.core.runtime.ModelBody</type> <required>false</required> <request>false</request> </org.apache.tiles.autotag.model.TemplateParameter> </entry> </parameters> </executeMethod> </org.apache.tiles.autotag.model.TemplateClass> </entry> <entry> <string>org.apache.tiles.template.DefinitionModel</string> <org.apache.tiles.autotag.model.TemplateClass> <name>org.apache.tiles.template.DefinitionModel</name> <tagName>definition</tagName> <tagClassPrefix>Definition</tagClassPrefix> <documentation><p> <strong>Create a definition at runtime. </strong> </p> <p> Create a new definition at runtime. Newly created definition will be available across the entire request. </p></documentation> <executeMethod> <name>execute</name> <documentation>Executes the operation.</documentation> <parameters class="linked-hash-map"> <entry> <string>name</string> <org.apache.tiles.autotag.model.TemplateParameter> <name>name</name> <exportedName>name</exportedName> <documentation>The name of the definition to create. If not specified, an anonymous definition will be created.</documentation> <type>java.lang.String</type> <required>false</required> <request>false</request> </org.apache.tiles.autotag.model.TemplateParameter> </entry> <entry> <string>template</string> <org.apache.tiles.autotag.model.TemplateParameter> <name>template</name> <exportedName>template</exportedName> <documentation>The template of this definition.</documentation> <type>java.lang.String</type> <required>false</required> <request>false</request> </org.apache.tiles.autotag.model.TemplateParameter> </entry> <entry> <string>role</string> <org.apache.tiles.autotag.model.TemplateParameter> <name>role</name> <exportedName>role</exportedName> <documentation>A comma-separated list of roles. If present, the definition will be rendered only if the current user belongs to one of the roles.</documentation> <type>java.lang.String</type> <required>false</required> <request>false</request> </org.apache.tiles.autotag.model.TemplateParameter> </entry> <entry> <string>extendsParam</string> <org.apache.tiles.autotag.model.TemplateParameter> <name>extendsParam</name> <exportedName>extends</exportedName> <documentation>The definition name that this definition extends.</documentation> <type>java.lang.String</type> <required>false</required> <request>false</request> </org.apache.tiles.autotag.model.TemplateParameter> </entry> <entry> <string>preparer</string> <org.apache.tiles.autotag.model.TemplateParameter> <name>preparer</name> <exportedName>preparer</exportedName> <documentation>The preparer to use to invoke before the definition is rendered.</documentation> <type>java.lang.String</type> <required>false</required> <request>false</request> </org.apache.tiles.autotag.model.TemplateParameter> </entry> <entry> <string>request</string> <org.apache.tiles.autotag.model.TemplateParameter> <name>request</name> <exportedName>request</exportedName> <documentation>The request.</documentation> <type>org.apache.tiles.request.Request</type> <required>false</required> <request>true</request> </org.apache.tiles.autotag.model.TemplateParameter> </entry> <entry> <string>modelBody</string> <org.apache.tiles.autotag.model.TemplateParameter> <name>modelBody</name> <exportedName>modelBody</exportedName> <documentation>The body.</documentation> <type>org.apache.tiles.autotag.core.runtime.ModelBody</type> <required>false</required> <request>false</request> </org.apache.tiles.autotag.model.TemplateParameter> </entry> </parameters> </executeMethod> </org.apache.tiles.autotag.model.TemplateClass> </entry> </templateClasses> </org.apache.tiles.autotag.model.TemplateSuite>
© 2015 - 2025 Weber Informatics LLC | Privacy Policy