Package org.apache.tiles.web.jsp.taglib
Class InsertTemplateTag
java.lang.Object
jakarta.servlet.jsp.tagext.SimpleTagSupport
org.apache.tiles.web.jsp.taglib.InsertTemplateTag
- All Implemented Interfaces:
- jakarta.servlet.jsp.tagext.JspTag,- jakarta.servlet.jsp.tagext.SimpleTag
public class InsertTemplateTag
extends jakarta.servlet.jsp.tagext.SimpleTagSupport
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>
 - 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionvoiddoTag()Getter for preparer property.getRole()Getter for role property.Getter for template property.Getter for templateExpression property.Getter for templateType property.booleanisFlush()Getter for flush property.voidsetFlush(boolean flush) Setter for flush property.voidsetPreparer(String preparer) Setter for preparer property.voidSetter for role property.voidsetTemplate(String template) Setter for template property.voidsetTemplateExpression(String templateExpression) Setter for templateExpression property.voidsetTemplateType(String templateType) Setter for templateType property.Methods inherited from class jakarta.servlet.jsp.tagext.SimpleTagSupportfindAncestorWithClass, getJspBody, getJspContext, getParent, setJspBody, setJspContext, setParent
- 
Constructor Details- 
InsertTemplateTagpublic InsertTemplateTag()
 
- 
- 
Method Details- 
getTemplateGetter for template property.- Returns:
- The template to render.
 
- 
setTemplateSetter for template property.- Parameters:
- template- The template to render.
 
- 
getTemplateTypeGetter for templateType property.- Returns:
- The type of the template attribute.
 
- 
setTemplateTypeSetter for templateType property.- Parameters:
- templateType- The type of the template attribute.
 
- 
getTemplateExpressionGetter for templateExpression property.- Returns:
- The expression to evaluate to get the value of the template.
 
- 
setTemplateExpressionSetter for templateExpression property.- Parameters:
- templateExpression- The expression to evaluate to get the value of the template.
 
- 
getRoleGetter for role property.- Returns:
- A comma-separated list of roles. If present, the template will be rendered only if the current user belongs to one of the roles.
 
- 
setRoleSetter for role property.- Parameters:
- role- A comma-separated list of roles. If present, the template will be rendered only if the current user belongs to one of the roles.
 
- 
getPreparerGetter for preparer property.- Returns:
- The preparer to use to invoke before the definition is rendered. If specified, it overrides the preparer specified in the definition itself.
 
- 
setPreparerSetter for preparer property.- Parameters:
- preparer- The preparer to use to invoke before the definition is rendered. If specified, it overrides the preparer specified in the definition itself.
 
- 
isFlushpublic boolean isFlush()Getter for flush property.- Returns:
- If true, the response will be flushed after the insert.
 
- 
setFlushpublic void setFlush(boolean flush) Setter for flush property.- Parameters:
- flush- If true, the response will be flushed after the insert.
 
- 
doTag- Specified by:
- doTagin interface- jakarta.servlet.jsp.tagext.SimpleTag
- Overrides:
- doTagin class- jakarta.servlet.jsp.tagext.SimpleTagSupport
- Throws:
- jakarta.servlet.jsp.JspException
- IOException
 
 
-