public class InsertDefinitionTag
extends javax.servlet.jsp.tagext.SimpleTagSupport
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 :
<code> <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> </code>
Constructor and Description |
---|
InsertDefinitionTag() |
Modifier and Type | Method and Description |
---|---|
void |
doTag() |
String |
getName()
Getter for name property.
|
String |
getPreparer()
Getter for preparer property.
|
String |
getRole()
Getter for role property.
|
String |
getTemplate()
Getter for template property.
|
String |
getTemplateExpression()
Getter for templateExpression property.
|
String |
getTemplateType()
Getter for templateType property.
|
boolean |
isFlush()
Getter for flush property.
|
void |
setFlush(boolean flush)
Setter for flush property.
|
void |
setName(String definitionName)
Setter for name property.
|
void |
setPreparer(String preparer)
Setter for preparer property.
|
void |
setRole(String role)
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.
|
public String getName()
public void setName(String definitionName)
definitionName
- The name of the definition to render.public String getTemplate()
public void setTemplate(String template)
template
- If specified, this template will be used instead of the
one used by the definition.public String getTemplateType()
public void setTemplateType(String templateType)
templateType
- The type of the template attribute.public String getTemplateExpression()
public void setTemplateExpression(String templateExpression)
templateExpression
- The expression to evaluate to get the value of the template.public String getRole()
public void setRole(String role)
role
- A comma-separated list of roles. If present, the definition
will be rendered only if the current user belongs to one of the roles.public String getPreparer()
public void setPreparer(String preparer)
preparer
- The preparer to use to invoke before the definition is
rendered. If specified, it overrides the preparer specified in the
definition itself.public boolean isFlush()
true
, the response will be flushed after the insert.public void setFlush(boolean flush)
flush
- If true
, the response will be flushed after the insert.public void doTag() throws javax.servlet.jsp.JspException, IOException
doTag
in interface javax.servlet.jsp.tagext.SimpleTag
doTag
in class javax.servlet.jsp.tagext.SimpleTagSupport
javax.servlet.jsp.JspException
IOException
Copyright © 2001-2017 The Apache Software Foundation. All Rights Reserved.