org.apache.beehive.netui.tags.template
Class DivPanel

Object
  extended by TagSupport
      extended by BodyTagSupport
          extended by AbstractClassicTag
              extended by DivPanel
All Implemented Interfaces:
Serializable, BodyTag, IterationTag, JspTag, Tag, INetuiTag, TemplateConstants

public class DivPanel
extends AbstractClassicTag
implements TemplateConstants

A DivPanel creates an HTML

tag that may contain additional
tags. There will only be a single div that is visible at a time.

See Also:
Serialized Form

Field Summary
static String DIVPANEL_DIV_ID
           
static String DIVPANEL_FIRST_PAGE
           
static String DIVPANEL_JAVASCRIPT_ATTR
           
 
Fields inherited from class AbstractClassicTag
DefaultNamingChain, EMPTY_STRING, NETUI_UNIQUE_CNT
 
Fields inherited from class BodyTagSupport
bodyContent
 
Fields inherited from class TagSupport
id, pageContext
 
Fields inherited from interface TemplateConstants
TEMPLATE_ATTRIBUTES, TEMPLATE_SECTIONS
 
Fields inherited from interface BodyTag
EVAL_BODY_BUFFERED, EVAL_BODY_TAG
 
Fields inherited from interface IterationTag
EVAL_BODY_AGAIN
 
Fields inherited from interface Tag
EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE
 
Constructor Summary
DivPanel()
           
 
Method Summary
 int doEndTag()
          Stores the buffered body content into the TEMPLATE_SECTIONS HashMap.
 int doStartTag()
          Causes the content of the section to be rendered into a buffer.
static String getCurrentPage(ServletRequest req, String tagId)
           
 String getTagName()
          Returns the name of the Tag.
protected  void localRelease()
          This is a method that will reinitialize all temporary state on a tag and should be called in the doEndTag method.
protected  String renderTagId(StringBuilder buffer)
          This method will handle creating the tagId attribute.
 void setFirstPage(String firstPage)
          Set the ID of the tag.
 void setTagId(String tagId)
          Set the ID of the tag.
 
Methods inherited from class AbstractClassicTag
addTagIdMapping, applyNamingChain, getErrorsReport, getNamingChain, getNextId, getScriptReporter, getUserLocale, hasErrors, qualifyAttribute, registerTagError, registerTagError, renderAttribute, reportAndExit, reportErrors, rewriteName, setNonEmptyValueAttribute, setRequiredValueAttribute, write
 
Methods inherited from class BodyTagSupport
doAfterBody, doInitBody, getBodyContent, getPreviousOut, release, setBodyContent
 
Methods inherited from class TagSupport
findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setPageContext, setParent, setValue
 
Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface Tag
getParent, setPageContext, setParent
 

Field Detail

DIVPANEL_JAVASCRIPT_ATTR

public static final String DIVPANEL_JAVASCRIPT_ATTR
See Also:
Constant Field Values

DIVPANEL_FIRST_PAGE

public static final String DIVPANEL_FIRST_PAGE
See Also:
Constant Field Values

DIVPANEL_DIV_ID

public static final String DIVPANEL_DIV_ID
See Also:
Constant Field Values
Constructor Detail

DivPanel

public DivPanel()
Method Detail

getCurrentPage

public static String getCurrentPage(ServletRequest req,
                                    String tagId)

getTagName

public String getTagName()
Returns the name of the Tag. This is used to identify the type of tag reporting errors.

Specified by:
getTagName in interface INetuiTag
Specified by:
getTagName in class AbstractClassicTag
Returns:
a constant string representing the name of the tag.

setTagId

public void setTagId(String tagId)
Set the ID of the tag.

Parameters:
tagId - - the tagId.

setFirstPage

public void setFirstPage(String firstPage)
Set the ID of the tag.

Parameters:
firstPage - - the name of the first page.

doStartTag

public int doStartTag()
               throws JspException
Causes the content of the section to be rendered into a buffer.

Specified by:
doStartTag in interface Tag
Overrides:
doStartTag in class BodyTagSupport
Returns:
SKIP_BODY if the visible state is false, otherwise EVAL_BODY_BUFFERED to cause the body content to be buffered.
Throws:
JspException - if there are errors.

doEndTag

public int doEndTag()
             throws JspException
Stores the buffered body content into the TEMPLATE_SECTIONS HashMap. The buffered body is accessed by the template page to obtain the content for IncludeSection tags.

Specified by:
doEndTag in interface Tag
Overrides:
doEndTag in class BodyTagSupport
Returns:
EVAL_PAGE to continue evaluating the page.
Throws:
JspException - on error.

localRelease

protected void localRelease()
Description copied from class: AbstractClassicTag
This is a method that will reinitialize all temporary state on a tag and should be called in the doEndTag method.

Overrides:
localRelease in class AbstractClassicTag

renderTagId

protected final String renderTagId(StringBuilder buffer)
This method will handle creating the tagId attribute. The tagId attribute indentifies the tag in the generated HTML. There is a lookup table created in JavaScript mapping the tagId to the actual name. The tagId is also run through the naming service so it can be scoped. Some tags will write that tagid out as the id attribute of the HTML tag being generated.

Parameters:
buffer -
Returns:
String