com.ivata.mask.web.tag.html
Class HelpTag

java.lang.Object
  javax.servlet.jsp.tagext.TagSupport
      javax.servlet.jsp.tagext.BodyTagSupport
          org.apache.struts.taglib.html.BaseHandlerTag
              com.ivata.mask.web.tag.html.HelpTag

All Implemented Interfaces:

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

public class HelpTag

extends org.apache.struts.taglib.html.BaseHandlerTag

Create a JavaScript button which links to window with help functionality for ivata op

This class uses the class to detect whether or not the client browser is capable of displaying Java Script . If not, the button will not appear.

Tag attributes:

attribute	reqd.	param. class	description
key	false	java.lang.String	Specifies a key to use to display the correct page in the help window. If this parameter is left out, the default welcome help page is displayed.

Note: all the tag attributes from BaseHandlerTag are also included.

Since:

ivata masks 0.4 (2003-01-15)

Version:

$Revision: 1.2 $

Author:

Colin MacLeod colin.macleod@ivata.com

See Also:

Serialized Form

Field Summary

Fields inherited from class org.apache.struts.taglib.html.BaseHandlerTag

accesskey, defaultLocale, indexed, messages, tabindex

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

HelpTag()

Method Summary

int	doEndTag() Overridden to output the JavaScript and input button.
java.lang.String	getKey() Get the key of the default help page to display.
JavaScriptWindow	getWindow() Generates the JavaScript to display the help window.
void	setKey(java.lang.String keyParam) Set the key of the default help page to display.
void	setWindow(JavaScriptWindow windowParam) Generates the JavaScript to display the help window.

Methods inherited from class org.apache.struts.taglib.html.BaseHandlerTag

getAccesskey, getAlt, getAltKey, getBundle, getDisabled, getElementClose, getIndexed, getLocale, getOnblur, getOnchange, getOnclick, getOndblclick, getOnfocus, getOnkeydown, getOnkeypress, getOnkeyup, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, getOnselect, getReadonly, getStyle, getStyleClass, getStyleId, getTabindex, getTitle, getTitleKey, isXhtml, lookupProperty, message, prepareEventHandlers, prepareFocusEvents, prepareIndex, prepareKeyEvents, prepareMouseEvents, prepareStyles, prepareTextEvents, release, setAccesskey, setAlt, setAltKey, setBundle, setDisabled, setIndexed, setLocale, setOnblur, setOnchange, setOnclick, setOndblclick, setOnfocus, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setOnselect, setReadonly, setStyle, setStyleClass, setStyleId, setTabindex, setTitle, setTitleKey

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

doAfterBody, doInitBody, doStartTag, 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

HelpTag

public HelpTag()

Method Detail

getKey

public java.lang.String getKey()

Get the key of the default help page to display. If null, the default welcome help page is shown.

Returns:

the current value of key.

setKey

public void setKey(java.lang.String keyParam)

Set the key of the default help page to display. If null, the default welcome help page is shown.

Parameters:

keyParam - the new value of key.

doEndTag

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

Overridden to output the JavaScript and input button.

Returns:

EVAL_PAGE since we want to evaluate the page after this tag.

Throws:

javax.servlet.jsp.JspException - if there is an error writing to out.print()

getWindow

public final JavaScriptWindow getWindow()

Generates the JavaScript to display the help window.

Returns:

the current value of window.

setWindow

public final void setWindow(JavaScriptWindow windowParam)

Generates the JavaScript to display the help window.

Parameters:

windowParam - the new value of window.