nl.imsystems.atag.tags
Class WrapperTag

java.lang.Object
  extended by javax.servlet.jsp.tagext.TagSupport
      extended by javax.servlet.jsp.tagext.BodyTagSupport
          extended by nl.imsystems.atag.tags.ATagBase
              extended by nl.imsystems.atag.tags.ContainerBase
                  extended by nl.imsystems.atag.tags.WrapperTag
All Implemented Interfaces:
Serializable, BodyTag, IterationTag, JspTag, Tag

public class WrapperTag
extends ContainerBase

Tag handler for <a:wrapper/> tag.

A <a:wrapper/> is used within a panel definition in order to create an inline ATag component.

<a:wrapper/> can contain no more than 1 html element.

Wrapped components can never be refreshed independently of their container panel. However, they can fire events and consequently refresh their dependents.

Attributes

Name Required Default Description
controllerUrl No Current url Url to which events generated by the wrapped component should be posted.
dependents No   A comma separated list of ids identifing components that should be refreshed after the component wrapped by this wrapper fires a server event.
render No true Set false in order to prevent the contents of the wrapper from being rendered.

Supported By

<a:panel/>
<a:wrapper/> can only be placed inside a <a:panel/> tag.

Supports

<a:action/>
Actions can be added to <a:wrapper/> in order to propagate events from the wrapped component to the server.
<a:wrapper/> can only contains a single html element.

Author:
kayvan

See Also:
Serialized Form

Field Summary
 
Fields inherited from class javax.servlet.jsp.tagext.BodyTagSupport
bodyContent
 
Fields inherited from class javax.servlet.jsp.tagext.TagSupport
id, pageContext
 
Fields inherited from interface javax.servlet.jsp.tagext.BodyTag
EVAL_BODY_BUFFERED, EVAL_BODY_TAG
 
Fields inherited from interface javax.servlet.jsp.tagext.IterationTag
EVAL_BODY_AGAIN
 
Fields inherited from interface javax.servlet.jsp.tagext.Tag
EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE
 
Constructor Summary
WrapperTag()
           
 
Method Summary
 int doEndTag()
           
 String getDependents()
           
 String getRender()
           
 void release()
          Resets the Tag handler.
 void setDependents(String dependents)
          Sets the dependent given a comma separated list of relative or absolute ids.
 void setRender(String render)
           
 
Methods inherited from class nl.imsystems.atag.tags.ContainerBase
addAction, addDependent, addParam, addReference, compileActions, doStartTag, getActions, getActions, getContollerUrl, getDependentsList, getParams, getParamsCSV, getViewUrl, isParentDependent, setControllerUrl, setViewUrl
 
Methods inherited from class nl.imsystems.atag.tags.ATagBase
getAlias, getATagContext, getContextPath, getNamingContext, getParentTag, getRefererId, getRequest, getResponse, getTagId, popContext, pushContext, resolveRelativeName
 
Methods inherited from class javax.servlet.jsp.tagext.BodyTagSupport
doAfterBody, doInitBody, getBodyContent, getPreviousOut, setBodyContent
 
Methods inherited from class javax.servlet.jsp.tagext.TagSupport
findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setPageContext, setParent, setValue
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface javax.servlet.jsp.tagext.Tag
getParent, setPageContext, setParent
 

Constructor Detail

WrapperTag

public WrapperTag()
Method Detail

getDependents

public String getDependents()

setDependents

public void setDependents(String dependents)
Description copied from class: ContainerBase
Sets the dependent given a comma separated list of relative or absolute ids.

Overrides:
setDependents in class ContainerBase
Parameters:
dependents - The comma separated list of dependents.

getRender

public String getRender()

setRender

public void setRender(String render)

doEndTag

public int doEndTag()
             throws JspException
Specified by:
doEndTag in interface Tag
Overrides:
doEndTag in class BodyTagSupport
Throws:
JspException

release

public void release()
Description copied from class: ContainerBase
Resets the Tag handler.

Specified by:
release in interface Tag
Overrides:
release in class ContainerBase