Class PutAttributeTag

java.lang.Object
jakarta.servlet.jsp.tagext.SimpleTagSupport
org.apache.tiles.web.jsp.taglib.PutAttributeTag
All Implemented Interfaces:
jakarta.servlet.jsp.tagext.JspTag, jakarta.servlet.jsp.tagext.SimpleTag

public class PutAttributeTag extends jakarta.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 Details

    • PutAttributeTag

      public PutAttributeTag()
  • Method Details

    • getName

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

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

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

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

      public 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(String expression)
      Setter for expression property.
      Parameters:
      expression - The expression to calculate the value from. Use this parameter, or value, or body.
    • 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.
    • getType

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

      public void setType(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 jakarta.servlet.jsp.JspException, IOException
      Specified by:
      doTag in interface jakarta.servlet.jsp.tagext.SimpleTag
      Overrides:
      doTag in class jakarta.servlet.jsp.tagext.SimpleTagSupport
      Throws:
      jakarta.servlet.jsp.JspException
      IOException