com.sas.servlet.tbeans.form.html
Class CheckBox

com.sas.servlet.tbeans.form.html.CheckBox

All Implemented Interfaces:

com.sas.beans.PropertyChangeSource, com.sas.lang.ObjectDataInterface, ComplexStyleInterface, FormElementModificationEventInterface, CheckBoxStyleKeysInterface, com.sas.servlet.tbeans.form.JavaScriptObjectCreationInterface, com.sas.servlet.tbeans.JavaScriptEventHandlerInterface, RenderableInterface, TransformationInterface, GenericValidatorInterface, com.sas.util.WriteToPrintWriterInterface, java.io.Serializable

Direct Known Subclasses:

CellContentsCheckBoxEditor, CellContentsRowSelectionRenderer

public class CheckBox
implements CheckBoxStyleKeysInterface, ComplexStyleInterface

The CheckBox is a TransformationBean™ that generates the appropriate HTML 4.0 for a checkbox. Checkboxes are on/off switches that may be toggled by the user. A switch is "on" when the control element's checked attribute is set. When a form is submitted, only "on" checkbox controls will be submitted. Several checkboxes in a form may share the same control name. Thus, for example, checkboxes allow users to select several values for the same property. The INPUT element is used to create a checkbox control.

Accessibility

The Section 508 Accessibility standards, such as making application tasks available through the keyboard, are incorporated into our components to improve usability for all of our software products which benefits every SAS user.

This component is fully compliant with the Web-based standards outlined in Section 508. The compliance is based on producing the correct output, having keyboard equivalent and surfacing the necessary properties to assist consumers of the component to be compliant.

The following keyboard equivalents are supported by this component:

KeyBoard Access	Behavior/Result
TAB	TAB moves the focus to the checkbox. Hitting TAB while the checkbox has focus will navigate focus to the next tabbable component.
ALT+ACCESSKEY	Pressing ALT+ACCESSKEY will navigate focus to the checkbox. The ACCESSKEY indicates the keyboard character used as a shortcut to activate the element.
SPACEBAR	Pressing the SPACEBAR while the checkbox has focus, toggles between checked and unchecked.

The following properties are provided to assist in making the application using this component accessible:

• AccessKey
• TabIndex
• KeyDown
• KeyPress
• KeyUp

The CheckBox is one of several TransformationBeans™ that rely on a set of style classes that are used by default when generating the resulting markup language. For more information on style sheets and the default style classes that apply to this TransformationBean™, refer to the AppDev Studio Developer Site. You'll find a useful reference document entitled Cascading Style Sheets, Images, and TransformationBeans™ as well as the TransformationBeans™ Style Sheet Reference.

Note that the toString() method on this class calls the write method, which may have undesirable side effects. See BaseTransformation.toString() for more information. Debuggers often use toString() to show the value of a variable, and this may cause unexpected behavior while debugging

For More Information:

Visit the AppDev Studio Developer's Site to access step-by-step examples, white papers and additional usage information at http://support.sas.com/rnd/appdev/.

Examples for this class may be found on the Examples Site.

JSP custom tags provide an alternative to using the TransformationBeans™. Visit the Custom Tag Library Reference for additional information on the sas:CheckBox custom tag.

Note: A snapshot of the AppDev Studio Developers Site is installed on your local Web server when you install AppDev Studio. To access the site from webAF, select Help -> Developer Site .

The CheckBox is one of several TransformationBeans™ that rely on JavaScript to provide some of its functionality. These JavaScript files are including automatically by the tbean. See JavaScriptIncludeHandler for more information about how these files are included and how to customize this behavior. The CheckBox uses the following JavaScript files:

sas_checkBox.js

See Also:

Serialized Form

Field Summary

Fields inherited from class com.sas.servlet.tbeans.form.BaseFormElement

RB_KEY

Fields inherited from interface com.sas.servlet.tbeans.form.html.CheckBoxStyleKeysInterface

CHECKBOX_BOX, CHECKBOX_LABEL, CHECKBOX_LABEL_SPACING

Constructor Summary

CheckBox()
Constructs a new CheckBox Transformation Bean

CheckBox(java.lang.String name)
Constructs a new CheckBox Transformation Bean with a specified name.

CheckBox(java.lang.String name, java.lang.String text)
Constructs a new CheckBox Transformation Bean with a specified name and initial text.

CheckBox(java.lang.String name, java.lang.String text, boolean selected)
Constructs a new CheckBox Transformation Bean with a specified name, initial text and initial state.

CheckBox(java.lang.String name, java.lang.String text, boolean selected, java.lang.String value)
Constructs a new CheckBox Transformation Bean with a specified name, initial text, initial state and initial value.

CheckBox(java.lang.String name, java.lang.String text, boolean selected, java.lang.String value, boolean submitUncheckedValue, java.lang.String uncheckedValue)
Constructs a new CheckBox Transformation Bean with a specified name, initial text, initial state, initial value and whether to submit the unchecked value.

Method Summary

java.util.Map	getStyleMap() Returns the style map for this checkbox.
java.lang.String	getUncheckedValue() The value assigned to the checkbox when it is unchecked.
java.lang.String	getUncheckValue() The value assigned to the checkbox when it is unchecked.
boolean	isSubmitUncheckedValue() Whether to submit the unchecked value through a hidden field when the checkbox is unchecked.
void	setSubmitUncheckedValue(boolean submit) Whether to submit the unchecked value through a hidden field when the checkbox is unchecked.
void	setUncheckedValue(java.lang.String value) The value assigned to the checkbox when it is unchecked.
void	write(java.io.PrintWriter out) Writes the transformed representation of the object

Methods inherited from class com.sas.servlet.tbeans.form.BaseCheckBox

getSelected, getText, getValue, isLabelBolding, setLabelBolding, setSelected, setText, setValue

Methods inherited from class com.sas.servlet.tbeans.form.BaseFormElement

getAccessKey, getErrorHandler, getModificationEventName, getName, getOnBlur, getOnChange, getOnClick, getOnDblClick, getOnFocus, getOnKeyDown, getOnKeyPress, getOnKeyUp, getOnMouseDown, getOnMouseMove, getOnMouseOut, getOnMouseOver, getOnMouseUp, getOnSelect, getStyleInfo, getTabIndex, getTitle, getValidationFunctions, getValidator, isEnabled, isValid, isValidationEnabled, setAccessKey, setEnabled, setErrorHandler, setId, setModificationEventName, setName, setOnBlur, setOnChange, setOnClick, setOnDblClick, setOnFocus, setOnKeyDown, setOnKeyPress, setOnKeyUp, setOnMouseDown, setOnMouseMove, setOnMouseOut, setOnMouseOver, setOnMouseUp, setOnSelect, setStyleInfo, setTabIndex, setTitle, setValidator, writeJavaScriptObject, writeJavaScriptObjectValidate, writeJavaScriptValidatorObject, writeValidationScript

Methods inherited from class com.sas.servlet.tbeans.BaseTransformation

addPropertyChangeListener, addPropertyChangeListener, cleanUpResources, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getCustomAttributes, getDescription, getId, getInputTransform, getLocale, getObjectData, getObjectDataProperty, getOutputTransform, getRequest, getResponse, getTagEpilog, getTagProlog, hasListeners, isCleanUpResourcesOn, isVisible, removePropertyChangeListener, removePropertyChangeListener, setCleanUpResourcesOn, setCustomAttributes, setDescription, setInputTransform, setLocale, setLocaleDependentProperties, setObjectData, setObjectDataProperty, setOutputTransform, setRequest, setResponse, setTagEpilog, setTagProlog, setVisible, toString, write, write, write

Constructor Detail

CheckBox

public CheckBox()

Constructs a new CheckBox Transformation Bean

CheckBox

public CheckBox(java.lang.String name)

Constructs a new CheckBox Transformation Bean with a specified name.

Parameters:

name - The CheckBox name

CheckBox

public CheckBox(java.lang.String name,
                java.lang.String text)

Constructs a new CheckBox Transformation Bean with a specified name and initial text.

Parameters:

name - The CheckBox name

text - The initial text associated with a CheckBox

CheckBox

public CheckBox(java.lang.String name,
                java.lang.String text,
                boolean selected)

Constructs a new CheckBox Transformation Bean with a specified name, initial text and initial state.

Parameters:

name - The CheckBox name

text - The initial text associated with a CheckBox

selected - The initial state of the CheckBox

CheckBox

public CheckBox(java.lang.String name,
                java.lang.String text,
                boolean selected,
                java.lang.String value)

Constructs a new CheckBox Transformation Bean with a specified name, initial text, initial state and initial value.

Parameters:

name - The CheckBox name

text - The initial text to be displayed with the CheckBox

selected - The initial state of the CheckBox

value - The initial value associated with a CheckBox

CheckBox

public CheckBox(java.lang.String name,
                java.lang.String text,
                boolean selected,
                java.lang.String value,
                boolean submitUncheckedValue,
                java.lang.String uncheckedValue)

Constructs a new CheckBox Transformation Bean with a specified name, initial text, initial state, initial value and whether to submit the unchecked value.

Parameters:

name - The CheckBox name

text - The initial text to be displayed with the CheckBox

selected - The initial state of the CheckBox

value - The initial value associated with a CheckBox

submitUncheckedValue - Whether to submit the uncheckedValue

uncheckedValue - The initial value when the CheckBox is unchecked

Method Detail

setSubmitUncheckedValue

public void setSubmitUncheckedValue(boolean submit)

Whether to submit the unchecked value through a hidden field when the checkbox is unchecked. By default a checkbox will not be submitted when it is unchecked. The hidden field will be the name of the checkbox.

Parameters:

submitUncheckedValue - Whether to submit the uncheckedValue

isSubmitUncheckedValue

public boolean isSubmitUncheckedValue()

Whether to submit the unchecked value through a hidden field when the checkbox is unchecked. By default a checkbox will not be submitted when it is unchecked. The hidden field will be the name of the checkbox.

Returns:

Whether to submit the uncheckedValue

setUncheckedValue

public void setUncheckedValue(java.lang.String value)

The value assigned to the checkbox when it is unchecked. The default value is "off".

Parameters:

uncheckedValue - The value when the checkbox is unchecked

getUncheckValue

public java.lang.String getUncheckValue()

The value assigned to the checkbox when it is unchecked. The default value is "off".

Returns:

The value when the checkbox is unchecked

getUncheckedValue

public java.lang.String getUncheckedValue()

The value assigned to the checkbox when it is unchecked. The default value is "off".

Returns:

The value when the checkbox is unchecked

getStyleMap

public java.util.Map getStyleMap()

Returns the style map for this checkbox.

STYLE KEY	DEFAULT STYLE
CHECKBOX_BOX	NONE
CHECKBOX_LABEL	NONE
CHECKBOX_LABEL_SPACING	NONE

Specified by:

getStyleMap in interface ComplexStyleInterface

Returns:

The styles used for this CheckBox

write

public void write(java.io.PrintWriter out)
           throws java.io.IOException

Writes the transformed representation of the object

Specified by:

write in interface TransformationInterface

Specified by:

write in interface com.sas.util.WriteToPrintWriterInterface

Overrides:

write in class BaseFormElement

Parameters:

out - The output stream

Throws:

java.io.IOException - Thrown if some type of I/O error occurs