Package org.apache.tiles.jsp.taglib

Class InsertDefinitionTag

  • All Implemented Interfaces:
    javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.SimpleTag
    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>

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void doTag()
      java.lang.String getName()
      Getter for name property.
      java.lang.String getPreparer()
      Getter for preparer property.
      java.lang.String getRole()
      Getter for role property.
      java.lang.String getTemplate()
      Getter for template property.
      java.lang.String getTemplateExpression()
      Getter for templateExpression property.
      java.lang.String getTemplateType()
      Getter for templateType property.
      boolean isFlush()
      Getter for flush property.
      void setFlush​(boolean flush)
      Setter for flush property.
      void setName​(java.lang.String definitionName)
      Setter for name property.
      void setPreparer​(java.lang.String preparer)
      Setter for preparer property.
      void setRole​(java.lang.String role)
      Setter for role property.
      void setTemplate​(java.lang.String template)
      Setter for template property.
      void setTemplateExpression​(java.lang.String templateExpression)
      Setter for templateExpression property.
      void setTemplateType​(java.lang.String templateType)
      Setter for templateType property.

      • Methods inherited from class javax.servlet.jsp.tagext.SimpleTagSupport

        findAncestorWithClass, getJspBody, getJspContext, getParent, setJspBody, setJspContext, setParent

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • InsertDefinitionTag

        public InsertDefinitionTag()

    • Method Detail

      • getName

        public java.lang.String getName()
        Getter for name property.
        Returns:
        The name of the definition to render.

      • setName

        public void setName​(java.lang.String definitionName)
        Setter for name property.
        Parameters:
        definitionName - The name of the definition to render.

      • getTemplate

        public java.lang.String getTemplate()
        Getter for template property.
        Returns:
        If specified, this template will be used instead of the one used by the definition.

      • setTemplate

        public void setTemplate​(java.lang.String template)
        Setter for template property.
        Parameters:
        template - If specified, this template will be used instead of the one used by the definition.

      • getTemplateType

        public java.lang.String getTemplateType()
        Getter for templateType property.
        Returns:
        The type of the template attribute.

      • setTemplateType

        public void setTemplateType​(java.lang.String templateType)
        Setter for templateType property.
        Parameters:
        templateType - The type of the template attribute.

      • getTemplateExpression

        public java.lang.String getTemplateExpression()
        Getter for templateExpression property.
        Returns:
        The expression to evaluate to get the value of the template.

      • setTemplateExpression

        public void setTemplateExpression​(java.lang.String templateExpression)
        Setter for templateExpression property.
        Parameters:
        templateExpression - The expression to evaluate to get the value of the template.

      • getRole

        public java.lang.String getRole()
        Getter for role property.
        Returns:
        A comma-separated list of roles. If present, the definition will be rendered only if the current user belongs to one of the roles.

      • setRole

        public void setRole​(java.lang.String role)
        Setter for role property.
        Parameters:
        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.

      • getPreparer

        public java.lang.String 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

        public void setPreparer​(java.lang.String preparer)
        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 - If true, the response will be flushed after the insert.

      • doTag

        public void doTag()
           throws javax.servlet.jsp.JspException,
                  java.io.IOException
        Specified by:
        doTag in interface javax.servlet.jsp.tagext.SimpleTag
        Overrides:
        doTag in class javax.servlet.jsp.tagext.SimpleTagSupport
        Throws:
        javax.servlet.jsp.JspException
        java.io.IOException