Package org.apache.tiles.jsp.taglib

Class PutAttributeTag

  • All Implemented Interfaces:
    javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.SimpleTag
    public class PutAttributeTag
extends javax.servlet.jsp.tagext.SimpleTagSupport

    Put an attribute in enclosing attribute container tag.

    Enclosing attribute container tag can be :

    • <initContainer>
    • <definition>
    • <insertAttribute>
    • <insertDefinition>
    • <putListAttribute>
    (or any other tag which implements the PutAttributeTagParent interface. Exception is thrown if no appropriate tag can be found.

    Put tag can have following atributes :

    • name : Name of the attribute
    • value : value to put as attribute
    • type : value type. Possible type are : string (value is used as direct string), template (value is used as a page url to insert), definition (value is used as a definition name to insert), object (value is used as it is)
    • role : Role to check when 'insertAttribute' will be called.

    Value can also come from tag body. Tag body is taken into account only if value is not set by one of the tag attributes. In this case Attribute type is "string", unless tag body define another type.

    • Constructor Summary

      Constructors 
      Constructor Description
      PutAttributeTag()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void doTag()
      java.lang.String getExpression()
      Getter for expression property.
      java.lang.String getName()
      Getter for name property.
      java.lang.String getRole()
      Getter for role property.
      java.lang.String getType()
      Getter for type property.
      java.lang.Object getValue()
      Getter for value property.
      boolean isCascade()
      Getter for cascade property.
      void setCascade​(boolean cascade)
      Setter for cascade property.
      void setExpression​(java.lang.String expression)
      Setter for expression property.
      void setName​(java.lang.String name)
      Setter for name property.
      void setRole​(java.lang.String role)
      Setter for role property.
      void setType​(java.lang.String type)
      Setter for type property.
      void setValue​(java.lang.Object value)
      Setter for value 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

      • PutAttributeTag

        public PutAttributeTag()

    • Method Detail

      • getName

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

      • setName

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

      • getValue

        public java.lang.Object getValue()
        Getter for value property.
        Returns:
        The value of the attribute. Use this parameter, or expression, or body.

      • setValue

        public void setValue​(java.lang.Object value)
        Setter for value property.
        Parameters:
        value - The value of the attribute. Use this parameter, or expression, or body.

      • getExpression

        public java.lang.String getExpression()
        Getter for expression property.
        Returns:
        The expression to calculate the value from. Use this parameter, or value, or body.

      • setExpression

        public void setExpression​(java.lang.String expression)
        Setter for expression property.
        Parameters:
        expression - The expression to calculate the value from. Use this parameter, or value, or body.

      • getRole

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

      • getType

        public java.lang.String getType()
        Getter for type property.
        Returns:
        The type (renderer) of the attribute.

      • setType

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

      • isCascade

        public boolean isCascade()
        Getter for cascade property.
        Returns:
        If true the attribute will be cascaded to all nested attributes.

      • setCascade

        public void setCascade​(boolean cascade)
        Setter for cascade property.
        Parameters:
        cascade - If true the attribute will be cascaded to all nested attributes.

      • 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