/*
    * This file was automatically generated by Apache Tiles Autotag.
    */
   package org.apache.tiles.jsp.taglib;
   
   import java.io.IOException;
   
   import javax.servlet.jsp.JspException;
   import javax.servlet.jsp.tagext.SimpleTagSupport;
  
  import org.apache.tiles.autotag.core.runtime.ModelBody;
  import org.apache.tiles.autotag.core.runtime.AutotagRuntime;
  
  /**
   * <p>
   * <strong>Put an attribute in enclosing attribute container tag.</strong>
   * </p>
   * <p>
   * Enclosing attribute container tag can be :
   * <ul>
   * <li>&lt;initContainer&gt;</li>
   * <li>&lt;definition&gt;</li>
   * <li>&lt;insertAttribute&gt;</li>
   * <li>&lt;insertDefinition&gt;</li>
   * <li>&lt;putListAttribute&gt;</li>
   * </ul>
   * (or any other tag which implements the <code>PutAttributeTagParent</code>
   * interface. Exception is thrown if no appropriate tag can be found.
   * </p>
   * <p>
   * Put tag can have following atributes :
   * <ul>
   * <li>name : Name of the attribute</li>
   * <li>value : value to put as attribute</li>
   * <li>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)</li>
   * <li>role : Role to check when 'insertAttribute' will be called.</li>
   * </ul>
   * </p>
   * <p>
   * 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.
   * </p>
   */
  public class PutAttributeTag extends SimpleTagSupport {
  
      /**
       * The template model.
       */
      private org.apache.tiles.template.PutAttributeModel model = new org.apache.tiles.template.PutAttributeModel();
  
      /**
       * The name of the attribute to put.
       */
      private java.lang.String name;
  
      /**
       * The value of the attribute. Use this parameter, or
       * expression, or body.
       */
      private java.lang.Object value;
  
      /**
       * The expression to calculate the value from. Use this
       * parameter, or value, or body.
       */
      private java.lang.String expression;
  
      /**
       * A comma-separated list of roles. If present, the attribute
       * will be rendered only if the current user belongs to one of the roles.
       */
      private java.lang.String role;
  
      /**
       * The type (renderer) of the attribute.
       */
      private java.lang.String type;
  
      /**
       * If <code>true</code> the attribute will be cascaded to all nested attributes.
       */
      private boolean cascade;
  
      /**
       * Getter for name property.
       *
       * @return
       * The name of the attribute to put.
       */
      public java.lang.String getName() {
          return name;
      }
  
      /**
       * Setter for name property.
       *
      * @param name
      * The name of the attribute to put.
      */
     public void setName(java.lang.String name) {
         this.name = name;
     }
 
     /**
      * Getter for value property.
      *
      * @return
      * The value of the attribute. Use this parameter, or
      * expression, or body.
      */
     public java.lang.Object getValue() {
         return value;
     }
 
     /**
      * Setter for value property.
      *
      * @param value
      * The value of the attribute. Use this parameter, or
      * expression, or body.
      */
     public void setValue(java.lang.Object value) {
         this.value = value;
     }
 
     /**
      * Getter for expression property.
      *
      * @return
      * The expression to calculate the value from. Use this
      * parameter, or value, or body.
      */
     public java.lang.String getExpression() {
         return expression;
     }
 
     /**
      * Setter for expression property.
      *
      * @param expression
      * The expression to calculate the value from. Use this
      * parameter, or value, or body.
      */
     public void setExpression(java.lang.String expression) {
         this.expression = expression;
     }
 
     /**
      * Getter for role property.
      *
      * @return
      * A comma-separated list of roles. If present, the attribute
      * will be rendered only if the current user belongs to one of the roles.
      */
     public java.lang.String getRole() {
         return role;
     }
 
     /**
      * Setter for role property.
      *
      * @param 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.
      */
     public void setRole(java.lang.String role) {
         this.role = role;
     }
 
     /**
      * Getter for type property.
      *
      * @return
      * The type (renderer) of the attribute.
      */
     public java.lang.String getType() {
         return type;
     }
 
     /**
      * Setter for type property.
      *
      * @param type
      * The type (renderer) of the attribute.
      */
     public void setType(java.lang.String type) {
         this.type = type;
     }
 
     /**
      * Getter for cascade property.
      *
      * @return
      * If <code>true</code> the attribute will be cascaded to all nested attributes.
      */
     public boolean isCascade() {
         return cascade;
     }
 
     /**
      * Setter for cascade property.
      *
      * @param cascade
      * If <code>true</code> the attribute will be cascaded to all nested attributes.
      */
     public void setCascade(boolean cascade) {
         this.cascade = cascade;
     }
 
     /** {@inheritDoc} */
     @Override
     public void doTag() throws JspException, IOException {
         AutotagRuntime<org.apache.tiles.request.Request> runtime = new org.apache.tiles.request.jsp.autotag.JspAutotagRuntime();
         if (runtime instanceof SimpleTagSupport) {
             SimpleTagSupport tag = (SimpleTagSupport) runtime;
             tag.setJspContext(getJspContext());
             tag.setJspBody(getJspBody());
             tag.setParent(getParent());
             tag.doTag();
         }
         org.apache.tiles.request.Request request = runtime.createRequest();        
         ModelBody modelBody = runtime.createModelBody();
         model.execute(
             name,
             value,
             expression,
             role,
             type,
             cascade,
             request, modelBody
         );
     }
 }