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

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

All Implemented Interfaces:

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

public class CheckboxTag

extends org.apache.struts.taglib.html.CheckboxTag

Overrides an HTML <input type=checkbox> 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 .
mandatory	false	boolean	Specifies data for this tag must be entered when the form is submitted.
readOnly	false	boolean	Specifies the form elements should be displayed only and cannot be altered.

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

Since:

ivata masks 0.4 (2003-02-02)

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.CheckboxTag

messages, name, 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

CheckboxTag()

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 call MaskProperties initialization.
java.lang.String	getLabel() Get the current clear-text label which will be displayed alongside the check box.
java.util.List	getLabelArgs()
MaskProperties	getMaskProperties() Stores and maintains ivata op specific mask properties.
java.util.List	getTitleArgs()
void	setFieldName(java.lang.String fieldName) >Name of the field to which this label refers.
void	setLabel(java.lang.String labelParam) Called by MaskProperties to set the label.
void	setLabelArgs(java.util.List args) Refer to MaskProperties.setLabelArgs(java.util.List).
void	setLabelKey(java.lang.String labelKey) Localization key of a string which will appear to the right of the check box.
void	setMandatory(boolean mandatory) Set whether or not the value this control must be entered.
void	setMaskProperties(MaskProperties maskPropertiesParam) Stores and maintains ivata op specific mask properties.
void	setReadOnly(boolean readOnlyParam) Refer to MaskProperties.setReadOnly(boolean).
void	setTitleArgs(java.util.List args) Refer to MaskProperties.setTitleArgs(java.util.List).
void	setTitleKey(java.lang.String titleKeyParam) Refer to MaskProperties.setTitleKey(java.lang.String).

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

doAfterBody, getName, getProperty, getValue, isChecked, release, setName, setProperty, setValue

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, 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

CheckboxTag

public CheckboxTag()

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 call MaskProperties initialization.

Returns:

value returned by superclass method, or SKIP_BODY if this tag is read-only.

Throws:

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

getLabel

public java.lang.String getLabel()

Get the current clear-text label which will be displayed alongside the check box.

Returns:

Returns the label.

getLabelArgs

public final java.util.List getLabelArgs()

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()

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.

setLabel

public void setLabel(java.lang.String labelParam)

Called by MaskProperties to set the label.

Parameters:

labelParam - new text to be displayed as the label.

setLabelArgs

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

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

Parameters:

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

setLabelKey

public void setLabelKey(java.lang.String labelKey)

Localization key of a string which will appear to the right of the check box.

Parameters:

labelKey - the new value of labelKey.

setMandatory

public void setMandatory(boolean mandatory)

Set whether or not the value this control must be entered.

Parameters:

mandatory - true if this field must be entered, otherwise false if the field is optional.

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 readOnlyParam)

Refer to MaskProperties.setReadOnly(boolean).

Parameters:

readOnlyParam - Refer to MaskProperties.setReadOnly(boolean).

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 titleKeyParam)

Refer to MaskProperties.setTitleKey(java.lang.String).

Parameters:

titleKeyParam - Refer to MaskProperties.setTitleKey(java.lang.String).