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

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

All Implemented Interfaces:

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

Direct Known Subclasses:

ApplyTag, ClearTag, DeleteTag, OkTag

public class SubmitTag

extends org.apache.struts.taglib.html.SubmitTag

Overrides an HTML <input type=submit> tag, by overriding the class from Struts .

Tag attributes:

attribute	reqd.	param. class	description
fieldName	true	java.lang.String	The field name is used to default the following attributes of the tag: styleId titleKey valueKey .
readOnly	false	boolean	Specifies whether or not this submit button should be shown. If true, the submit button is not shown.
titleKey	true	java.lang.String	Specifies the localized text to use for mouse-over events.
valueKey	true	java.lang.String	Specifies the localized text to use for the button text.

Note: all the tag attributes from Stuts are included.

Since:

ivata masks 0.4 (2003-01-15)

Version:

$Revision: 1.5 $

Author:

Colin MacLeod colin.macleod@ivata.com

See Also:

Serialized Form

Field Summary

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

messages, property, text, value

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

accesskey, defaultLocale, indexed, 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

SubmitTag()

Method Summary

int	doEndTag() Overridden to check whether or not the field is read only, and to apply mandatory field attributes.
int	doStartTag() Overridden to set the value and title strings to the values represented by the localized keys in this class.
java.lang.String	getBundle() Calls MaskProperties#getBundleMaskProperites.getBundle.
MaskProperties	getMaskProperties() Stores and maintains ivata op specific mask properties.
java.util.List	getTitleArgs()
java.util.List	getValueArgs()
void	setFieldName(java.lang.String fieldName) >Name of the field to which this label refers.
void	setMaskProperties(MaskProperties maskPropertiesParam) Stores and maintains ivata op specific mask properties.
void	setReadOnly(boolean readOnly) Specifies whether or not this button should be shown, If this attribute is unset, the button will decide whether or not to dispaly on the basis of the readOnly attribute of the surrounding form.
void	setTitleArgs(java.util.List args) Refer to MaskProperties.setTitleArgs(java.util.List).
void	setTitleKey(java.lang.String titleKey) Set the value of the key used to localize the title tag attribute.
void	setValueArgs(java.util.List args) Refer to MaskProperties.setValueArgs(java.util.List).
void	setValueKey(java.lang.String valueKey) Set the value of the key used to localize the value tag attribute.

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

doAfterBody, getProperty, getValue, release, setProperty, setValue

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

getAccesskey, getAlt, getAltKey, 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, 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

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

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

SubmitTag

public SubmitTag()

Method Detail

doEndTag

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

Overridden to check whether or not the field is read only, and to apply mandatory field attributes.

Returns:

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

Throws:

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

doStartTag

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

Overridden to set the value and title strings to the values represented by the localized keys in this class.

Returns:

value returned by superclass method.

Throws:

javax.servlet.jsp.JspException - if either valueKey or titleKey have not been set, or as thrown by superclass method.

getBundle

public final java.lang.String getBundle()

Calls MaskProperties#getBundleMaskProperites.getBundle.

Returns:

the current value of bundle.

getMaskProperties

public MaskProperties getMaskProperties()

Stores and maintains ivata op specific mask properties.

Returns:

the current value of maskProperties.

getTitleArgs

public final java.util.List getTitleArgs()

getValueArgs

public final java.util.List getValueArgs()

setFieldName

public void setFieldName(java.lang.String fieldName)

>Name of the field to which this label refers. This is used in conjunction with the resourceFieldPath to retrieve the correct message resources path.

Parameters:

fieldName - the new value of fieldName.

setMaskProperties

public void setMaskProperties(MaskProperties maskPropertiesParam)

Stores and maintains ivata op specific mask properties.

Parameters:

maskPropertiesParam - the new value of maskProperties.

setReadOnly

public void setReadOnly(boolean readOnly)

Specifies whether or not this button should be shown, If this attribute is unset, the button will decide whether or not to dispaly on the basis of the readOnly attribute of the surrounding form.

Parameters:

readOnly - true if the button should always be shown, otherwise the button will only be shown if the surrounding form is not read-only.

setTitleArgs

public final void setTitleArgs(java.util.List args)

Refer to MaskProperties.setTitleArgs(java.util.List).

Parameters:

args - Refer to MaskProperties.setTitleArgs(java.util.List).

setTitleKey

public final void setTitleKey(java.lang.String titleKey)

Set the value of the key used to localize the title tag attribute.

Parameters:

titleKey - the new value of titleKey.

setValueArgs

public final void setValueArgs(java.util.List args)

Refer to MaskProperties.setValueArgs(java.util.List).

Parameters:

args - Refer to MaskProperties.setValueArgs(java.util.List).

setValueKey

public void setValueKey(java.lang.String valueKey)

Set the value of the key used to localize the value tag attribute.

Parameters:

valueKey - the new value of valueKey.