com.ideo.sweetdevria.taglib.zone
Class ZoneTag

java.lang.Object
  javax.servlet.jsp.tagext.TagSupport
      com.ideo.sweetdevria.taglib.AbstractTagDrawer
          com.ideo.sweetdevria.taglib.AbstractComponentTagSupport
              com.ideo.sweetdevria.taglib.BaseTagSupport
                  com.ideo.sweetdevria.taglib.BaseStateTagSupport
                      com.ideo.sweetdevria.taglib.zone.ZoneTag

All Implemented Interfaces:

Hideable, IRiaTag, java.io.Serializable, javax.servlet.jsp.tagext.BodyTag, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag

public class ZoneTag
extends BaseStateTagSupport
implements IRiaTag, Hideable

See Also:

Serialized Form

Field Summary

protected java.lang.String	addInputs
protected java.lang.String	afterOnCallServer
protected static java.lang.String	BUILDER_ID Builder Id.
protected boolean	loadAtStartup
protected java.lang.String	onLoad
protected int	refreshDelay
protected java.lang.String	url url of the zone.

Fields inherited from class com.ideo.sweetdevria.taglib.BaseStateTagSupport

stateful

Fields inherited from class com.ideo.sweetdevria.taglib.BaseTagSupport

frameDisplayed, style, styleClass

Fields inherited from class com.ideo.sweetdevria.taglib.AbstractComponentTagSupport

bodyContent, rendered

Fields inherited from class com.ideo.sweetdevria.taglib.AbstractTagDrawer

builder, messageKeys, templateEnd, templateStart

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

ZoneTag()
Constructor.

Method Summary

int	doStartTag() Default processing of the start tag.
java.lang.String	getAddInputs()
java.lang.String	getAfterOnCallServer()
java.lang.String	getBuilderId() Return the targeted builder id for this component as specified in the configuration file.
ZoneModel	getModel()
java.lang.Class	getModelClass()
java.lang.String	getOnLoad()
int	getRefreshDelay()
java.lang.String	getUrl()
boolean	isLoadAtStartup()
void	release() Release method which must call super.release !
void	setAddInputs(java.lang.String addInputs) Set some input names to submit as parameters of the zone
void	setAfterOnCallServer(java.lang.String afterOnCallServer) Set the function
void	setLoadAtStartup(boolean loadAtStartup) Set the behavior on loading
void	setModelClass(java.lang.Class model) // SWTRIA-947 Set the model class of the component
void	setOnLoad(java.lang.String onLoad) Set the function
void	setPageContext(javax.servlet.jsp.PageContext pageContext) Used by HTTP container.
void	setRefreshDelay(int refreshDelay) Set the delay of refresh of this zone, in millis
void	setUrl(java.lang.String url) Set the url that will be loaded in this zone

Methods inherited from class com.ideo.sweetdevria.taglib.BaseStateTagSupport

isStateful, setId, setStateful

Methods inherited from class com.ideo.sweetdevria.taglib.BaseTagSupport

addCssClass, addCssStyle, getStyle, getStyleClass, setStyle, setStyleClass

Methods inherited from class com.ideo.sweetdevria.taglib.AbstractComponentTagSupport

checkId, doAfterBody, doEndTag, doInitBody, getBodyContent, getId, isRendered, refractorContext, setBodyContent, setRendered

Methods inherited from class com.ideo.sweetdevria.taglib.AbstractTagDrawer

generateHtmlContent, getBuilder, getMessageKeys, getPageContext, getTemplateEnd, getTemplateStart, setTemplateEnd, setTemplateStart

Methods inherited from class javax.servlet.jsp.tagext.TagSupport

findAncestorWithClass, getParent, getValue, getValues, removeValue, setParent, setValue

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.ideo.sweetdevria.taglib.IRiaTag

doEndTag, getMessageKeys, getPageContext, getTemplateEnd, getTemplateStart, setTemplateEnd, setTemplateStart

Methods inherited from interface com.ideo.sweetdevria.taglib.Hideable

isRendered, setRendered

Methods inherited from interface javax.servlet.jsp.tagext.BodyTag

doInitBody, setBodyContent

Methods inherited from interface javax.servlet.jsp.tagext.IterationTag

doAfterBody

Methods inherited from interface javax.servlet.jsp.tagext.Tag

doEndTag, getParent, setParent

Field Detail

BUILDER_ID

protected static final java.lang.String BUILDER_ID

Builder Id.

See Also:

Constant Field Values

url

protected java.lang.String url

url of the zone.

refreshDelay

protected int refreshDelay

loadAtStartup

protected boolean loadAtStartup

addInputs

protected java.lang.String addInputs

onLoad

protected java.lang.String onLoad

afterOnCallServer

protected java.lang.String afterOnCallServer

Constructor Detail

ZoneTag

public ZoneTag()

Constructor.

Method Detail

release

public void release()

Description copied from interface: IRiaTag

Release method which must call super.release !

Specified by:

release in interface IRiaTag

Specified by:

release in interface javax.servlet.jsp.tagext.Tag

Overrides:

release in class BaseStateTagSupport

See Also:

BaseTagSupport.release()

doStartTag

public int doStartTag()
               throws javax.servlet.jsp.JspException

Description copied from interface: IRiaTag

Default processing of the start tag.

Specified by:

doStartTag in interface IRiaTag

Specified by:

doStartTag in interface javax.servlet.jsp.tagext.Tag

Overrides:

doStartTag in class AbstractComponentTagSupport

Returns:

EVAL_BODY_AGAIN, EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY or SKIP_PAGE.

Throws:

javax.servlet.jsp.JspException

See Also:

IRiaTag.doStartTag()

setPageContext

public void setPageContext(javax.servlet.jsp.PageContext pageContext)

Description copied from interface: IRiaTag

Used by HTTP container. We should release tag here.

Specified by:

setPageContext in interface IRiaTag

Specified by:

setPageContext in interface javax.servlet.jsp.tagext.Tag

Overrides:

setPageContext in class AbstractTagDrawer

See Also:

com.ideo.sweetdevria.taglib

getBuilderId

public java.lang.String getBuilderId()

Description copied from interface: IRiaTag

Return the targeted builder id for this component as specified in the configuration file.

Specified by:

getBuilderId in interface IRiaTag

Specified by:

getBuilderId in class AbstractTagDrawer

Returns:

id targeted builder id

See Also:

com.ideo.sweetdevria.taglib

isLoadAtStartup

public boolean isLoadAtStartup()

setLoadAtStartup

public void setLoadAtStartup(boolean loadAtStartup)

Set the behavior on loading

Parameters:

loadAtStartup - A boolean indicating whether the content of this zone must be loaded at startup. Default is true.

getRefreshDelay

public int getRefreshDelay()

setRefreshDelay

public void setRefreshDelay(int refreshDelay)

Set the delay of refresh of this zone, in millis

Parameters:

refreshDelay - An integer indicating the refresh delay in millis.

getUrl

public java.lang.String getUrl()

setUrl

public void setUrl(java.lang.String url)

Set the url that will be loaded in this zone

Parameters:

url - The url of this zone (absolute, relative, or application root)

getAddInputs

public java.lang.String getAddInputs()

setAddInputs

public void setAddInputs(java.lang.String addInputs)

Set some input names to submit as parameters of the zone

Parameters:

addInputs - A list of inputs names in the page, comma separated

getOnLoad

public java.lang.String getOnLoad()

Returns:

the onLoad

setOnLoad

public void setOnLoad(java.lang.String onLoad)

Set the function

Parameters:

onLoad -

getAfterOnCallServer

public java.lang.String getAfterOnCallServer()

Returns:

the afterOnCallServer

setAfterOnCallServer

public void setAfterOnCallServer(java.lang.String afterOnCallServer)

Set the function

Parameters:

afterOnCallServer -

getModelClass

public java.lang.Class getModelClass()

setModelClass

public void setModelClass(java.lang.Class model)

// SWTRIA-947 Set the model class of the component

Parameters:

modelClass -

getModel

public ZoneModel getModel()