Class InsertAttributeTag

java.lang.Object
javax.servlet.jsp.tagext.SimpleTagSupport
org.apache.tiles.jsp.taglib.InsertAttributeTag
All Implemented Interfaces:
javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.SimpleTag

public class InsertAttributeTag extends javax.servlet.jsp.tagext.SimpleTagSupport

Inserts the value of an attribute into the page.

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.

Example :

 <code>
           <tiles:insertAttribute name="body" />
         </code>
 
  • Constructor Details

    • InsertAttributeTag

      public InsertAttributeTag()
  • Method Details

    • isIgnore

      public boolean isIgnore()
      Getter for ignore property.
      Returns:
      If true, if an exception happens during rendering, of if the attribute is null, the problem will be ignored.
    • setIgnore

      public void setIgnore(boolean ignore)
      Setter for ignore property.
      Parameters:
      ignore - If true, if an exception happens during rendering, of if the attribute is null, the problem will be ignored.
    • getPreparer

      public String getPreparer()
      Getter for preparer property.
      Returns:
      The preparer to invoke before rendering the attribute.
    • setPreparer

      public void setPreparer(String preparer)
      Setter for preparer property.
      Parameters:
      preparer - The preparer to invoke before rendering the attribute.
    • getRole

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

      public void setRole(String role)
      Setter for role property.
      Parameters:
      role - A comma-separated list of roles. If present, the attribute will be rendered only if the current user belongs to one of the roles.
    • getDefaultValue

      public Object getDefaultValue()
      Getter for defaultValue property.
      Returns:
      The default value of the attribute. To use only if the attribute was not computed.
    • setDefaultValue

      public void setDefaultValue(Object defaultValue)
      Setter for defaultValue property.
      Parameters:
      defaultValue - The default value of the attribute. To use only if the attribute was not computed.
    • getDefaultValueRole

      public String getDefaultValueRole()
      Getter for defaultValueRole property.
      Returns:
      The default comma-separated list of roles. To use only if the attribute was not computed.
    • setDefaultValueRole

      public void setDefaultValueRole(String defaultValueRole)
      Setter for defaultValueRole property.
      Parameters:
      defaultValueRole - The default comma-separated list of roles. To use only if the attribute was not computed.
    • getDefaultValueType

      public String getDefaultValueType()
      Getter for defaultValueType property.
      Returns:
      The default type of the attribute. To use only if the attribute was not computed.
    • setDefaultValueType

      public void setDefaultValueType(String defaultValueType)
      Setter for defaultValueType property.
      Parameters:
      defaultValueType - The default type of the attribute. To use only if the attribute was not computed.
    • getName

      public String getName()
      Getter for name property.
      Returns:
      The name of the attribute.
    • setName

      public void setName(String name)
      Setter for name property.
      Parameters:
      name - The name of the attribute.
    • getValue

      public Attribute getValue()
      Getter for value property.
      Returns:
      The attribute to use immediately, if not null.
    • setValue

      public void setValue(Attribute value)
      Setter for value property.
      Parameters:
      value - The attribute to use immediately, if not null.
    • 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, 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
      IOException