org.apache.myfaces.tobago.taglib.component
Class ScriptTag

java.lang.Object
  javax.servlet.jsp.tagext.TagSupport
      javax.servlet.jsp.tagext.BodyTagSupport
          org.apache.myfaces.tobago.taglib.component.ScriptTag

All Implemented Interfaces:

Serializable, BodyTag, IterationTag, JspTag, Tag

public class ScriptTag
extends BodyTagSupport

This tag add client side script to the rendered page.

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

ScriptTag()

Method Summary

int	doEndTag()
int	doStartTag()
String	getFile()
String	getOnload()
void	release()
void	setFile(String file) Absolute url to script file or script name to lookup in tobago resource path
void	setOnexit(String onexit) A script function which is invoked during onUnload Handler on the client, when the unload is invoked to a non Tobago page.
void	setOnload(String onload) A script function which is invoked during onLoad Handler on the client.
void	setOnsubmit(String onsubmit) A script function which is invoked on client just before submitting the action.
void	setOnunload(String onunload) A script function which is invoked during onUnload Handler on the client, if the action is a normal submit inside of Tobago.

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

ScriptTag

public ScriptTag()

Method Detail

doEndTag

public int doEndTag()
             throws JspException

Specified by:

doEndTag in interface Tag

Overrides:

doEndTag in class BodyTagSupport

Throws:

JspException

doStartTag

public int doStartTag()
               throws JspException

Specified by:

doStartTag in interface Tag

Overrides:

doStartTag in class BodyTagSupport

Throws:

JspException

release

public void release()

Specified by:

release in interface Tag

Overrides:

release in class BodyTagSupport

getFile

public String getFile()

setFile

public void setFile(String file)

Absolute url to script file or script name to lookup in tobago resource path

getOnload

public String getOnload()

setOnload

public void setOnload(String onload)

A script function which is invoked during onLoad Handler on the client.

setOnunload

public void setOnunload(String onunload)

A script function which is invoked during onUnload Handler on the client, if the action is a normal submit inside of Tobago.

setOnexit

public void setOnexit(String onexit)

A script function which is invoked during onUnload Handler on the client, when the unload is invoked to a non Tobago page. E.g. close-button, back-button, entering new url, etc.

setOnsubmit

public void setOnsubmit(String onsubmit)

A script function which is invoked on client just before submitting the action. This should be a single function call. If the result is typeof 'boolean' and false the further processing is canceled and the page is not submitted.