nl.imsystems.atag.tags
Class PageTag

java.lang.Object
  javax.servlet.jsp.tagext.TagSupport
      javax.servlet.jsp.tagext.BodyTagSupport
          nl.imsystems.atag.tags.ATagBase
              nl.imsystems.atag.tags.ContainerBase
                  nl.imsystems.atag.tags.PageTag

All Implemented Interfaces:

Serializable, BodyTag, IterationTag, JspTag, Tag

public class PageTag
extends ContainerBase

Tag handler for <a:page/> tag.

This tag is used on the root page to define the ATag area on that page.
A <a:page/> tag can contain 1 or more <a:panelRef/> tags.

Attributes

Name	Required	Default	Description
scriptLocation	Yes		Location of supporting javascript file (atag.js) on the server. URLs starting with a double forward slash '//' are interpreted as relative to the application context.
debug	No	false	Set true to display an alert on the browser containing the responses to every ATag event.
async	No	true	This value represents the value supplied to the third parameter of the open method on the XMLHttpRequest object. Must be set to true (default) for Firefox to work, but helps to set it to false when using IE and debug is on.
postForm	No	false	Globally turns on postForm for the all ATag components on the page, overriding any assignments on the <a:action/> tag.

Supported By

<a:page/> is the root tag and cannot be placed inside any other ATag.

Supports

<a:panelRef/>
<a:page/> tag can contain 1 or more <a:panelRef/> tags, referencing panel definitions.

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

PageTag()

Method Summary

protected void	addReference(ReferenceBase reference) Empty implementation.
int	doEndTag()
int	doStartTag() Default implementation that returns EVAL_BODY_BUFFERED.
String	getAsync()
String	getDebug()
String	getPostForm()
protected String	getSchedules(HttpServletRequest request)
String	getScriptLocation()
void	release() Resets the Tag handler.
void	setAsync(String async)
void	setDebug(String debug)
void	setPostForm(String postForm)
void	setScriptLocation(String scriptLocation)

Methods inherited from class nl.imsystems.atag.tags.ContainerBase

addAction, addDependent, addParam, compileActions, getActions, getActions, getContollerUrl, getDependentsList, getParams, getParamsCSV, getViewUrl, isParentDependent, setControllerUrl, setDependents, 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

PageTag

public PageTag()

Method Detail

getDebug

public String getDebug()

setDebug

public void setDebug(String debug)

getAsync

public String getAsync()

setAsync

public void setAsync(String async)

getPostForm

public String getPostForm()

setPostForm

public void setPostForm(String postForm)

getScriptLocation

public String getScriptLocation()

setScriptLocation

public void setScriptLocation(String scriptLocation)

addReference

protected void addReference(ReferenceBase reference)
                     throws JspException

Description copied from class: ContainerBase

Empty implementation. Overriden by subclasses.

Overrides:

addReference in class ContainerBase

Throws:

JspException

getSchedules

protected String getSchedules(HttpServletRequest request)

doStartTag

public int doStartTag()
               throws JspException

Description copied from class: ContainerBase

Default implementation that returns EVAL_BODY_BUFFERED.

Specified by:

doStartTag in interface Tag

Overrides:

doStartTag in class ContainerBase

Throws:

JspException

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