Package org.apache.tiles.jsp.taglib
Class InsertTemplateTag
java.lang.Object
javax.servlet.jsp.tagext.SimpleTagSupport
org.apache.tiles.jsp.taglib.InsertTemplateTag
- All Implemented Interfaces:
javax.servlet.jsp.tagext.JspTag
,javax.servlet.jsp.tagext.SimpleTag
public class InsertTemplateTag
extends javax.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 :
<code> <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> </code>
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
doTag()
Getter for preparer property.getRole()
Getter for role property.Getter for template property.Getter for templateExpression property.Getter for templateType property.boolean
isFlush()
Getter for flush property.void
setFlush
(boolean flush) Setter for flush property.void
setPreparer
(String preparer) Setter for preparer property.void
Setter for role property.void
setTemplate
(String template) Setter for template property.void
setTemplateExpression
(String templateExpression) Setter for templateExpression property.void
setTemplateType
(String templateType) Setter for templateType property.Methods inherited from class javax.servlet.jsp.tagext.SimpleTagSupport
findAncestorWithClass, getJspBody, getJspContext, getParent, setJspBody, setJspContext, setParent
-
Constructor Details
-
InsertTemplateTag
public InsertTemplateTag()
-
-
Method Details
-
getTemplate
Getter for template property.- Returns:
- The template to render.
-
setTemplate
Setter for template property.- Parameters:
template
- The template to render.
-
getTemplateType
Getter for templateType property.- Returns:
- The type of the template attribute.
-
setTemplateType
Setter for templateType property.- Parameters:
templateType
- The type of the template attribute.
-
getTemplateExpression
Getter for templateExpression property.- Returns:
- The expression to evaluate to get the value of the template.
-
setTemplateExpression
Setter for templateExpression property.- Parameters:
templateExpression
- The expression to evaluate to get the value of the template.
-
getRole
Getter 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.
-
setRole
Setter 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.
-
getPreparer
Getter 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.
-
setPreparer
Setter 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.
-
isFlush
public boolean isFlush()Getter for flush property.- Returns:
- If
true
, the response will be flushed after the insert.
-
setFlush
public void setFlush(boolean flush) Setter for flush property.- Parameters:
flush
- Iftrue
, the response will be flushed after the insert.
-
doTag
- Specified by:
doTag
in interfacejavax.servlet.jsp.tagext.SimpleTag
- Overrides:
doTag
in classjavax.servlet.jsp.tagext.SimpleTagSupport
- Throws:
javax.servlet.jsp.JspException
IOException
-