to.etc.domui.dom.html

Class Checkbox

java.lang.Object

to.etc.domui.dom.css.CssBase

to.etc.domui.dom.html.NodeBase

to.etc.domui.dom.html.Checkbox

All Implemented Interfaces:

INodeErrorDelegate, IActionControl, IControl<Boolean>, IHasChangeListener, IHasModifiedIndication, INativeChangeListener

public class Checkbox
extends NodeBase
implements INativeChangeListener, IControl<Boolean>, IHasModifiedIndication

Field Summary

Fields

Modifier and Type	Field and Description
static String	TYPE_HINT

Constructor Summary

Constructors

Constructor and Description
Checkbox()

Method Summary

Modifier and Type	Method and Description
boolean	acceptRequestParameter(String[] values)
String	getDisabledBecause()
IValueChanged<?>	getOnValueChanged() Deprecated.
Boolean	getValue() Returns the current value of this input component.
Boolean	getValueSafe() Like IControl.getValue() this returns the value of the component, but this returns null if the value was invalid.
boolean	hasError() Return T if this node currently has an error associated with it.
void	immediate()
void	immediate(boolean immediate)
boolean	isChecked()
boolean	isDisabled() Returns T if the control is currently in disabled.
boolean	isImmediate()
boolean	isMandatory() Returns T if this control is a mandatory input.
boolean	isModified() Returns the modified-by-user flag.
boolean	isReadOnly() Checkboxes cannot be readonly; we make them disabled instead.
void	setChecked(boolean checked)
void	setDisabled(boolean disabled) Set the input to disabled mode.
void	setDisabledBecause(String msg)
void	setMandatory(boolean mandatory) Make the control mandatory.
void	setModified(boolean as) Set or clear the modified by user flag.
void	setOnValueChanged(IValueChanged<?> onValueChanged) Deprecated.
void	setReadOnly(boolean readOnly) Sets the input to readonly-mode.
void	setValue(Boolean v) Set a new value into this control.
void	visit(INodeVisitor v) This must visit the appropriate method in the node visitor.

Methods inherited from class to.etc.domui.dom.html.NodeBase

$, addBinding, addCssClass, addGlobalMessage, addNotificationListener, afterCreateContent, alignToLeft, alignToLeft, alignToMiddle, alignToMiddle, alignTopToBottom, alignTopToBottom, alignToRight, alignToRight, alignToTop, alignToTop, appendAfterMe, appendBeforeMe, appendCreateJS, appendJavascript, appendJQuerySelector, appendJsCustomUpdatesContributor, appendShowOverflowTextAsTitleJs, appendStatement, appendTreeErrors, beforeCreateContent, bind, bind, bindErrors, build, calcTestID, changed, changedJavascriptState, clearFocusRequested, clearGlobalMessage, clearGlobalMessage, clearGlobalMessage, clearMessage, clearValidationFailure, componentHandleWebAction, componentHandleWebDataRequest, createContent, createStatement, findComponentBundle, findParent, forceRebuild, getActualID, getAllocationTracepoint, getBindingErrors, getBindingList, getBrowserWindowSize, getCalculatedTestID, getClicked, getClientBounds, getComponentBundle, getComponentDataURL, getComponentDataURL, getComponentInfo, getComponentJSONURL, getCreateJS, getCssClass, getErrorList, getErrorLocation, getFocusID, getMessage, getOnClickJS, getOnMouseDownJS, getOnSizeAndPositionChange, getPage, getParent, getParent, getParent, getParentOfTypes, getSharedContext, getSharedContextFactory, getSpecialAttribute, getSpecialAttributeList, getTag, getTestID, getTestRepeatId, getThemedResourceRURL, getTitle, getUserObject, handleDrop, hasCssClass, hasParent, internalClearDelta, internalClearDeltaFully, internalCreateFrame, internalGetNodeCount, internalGetOldParent, internalGetParent, internalHasChangedAttributes, internalNeedClickHandler, internalOnBeforeRender, internalOnClicked, internalOnValueChanged, internalRenderJavascriptDelta, internalRenderJavascriptState, internalSetHasChangedAttributes, internalSetHasChangedAttributes, internalSetLogAllocations, internalSetTag, internalShelve, internalUnshelve, isAttached, isBuilt, isFocusable, isFocusRequested, isRendersOwnClose, isStretchHeight, lc, notify, notifyParentOrOpenerPage, onAddedToPage, onBeforeFullRender, onBeforeRender, onForceRebuild, onHeaderContributors, onRefresh, onRemoveFromPage, onShelve, onUnshelve, refresh, remove, removeBinding, removeCssClass, renderJavascriptDelta, renderJavascriptState, renderJavascriptState, replaceWith, setBrowserWindowSize, setCalculcatedId, setCalculcatedId, setClicked, setClientBounds, setComponentBundle, setCssClass, setErrorLocation, setFocus, setMessage, setOnClickJS, setOnMouseDownJS, setOnSizeAndPositionChange, setOverrideTitle, setSpecialAttribute, setStretchHeight, setTestID, setTestRepeatID, setTitle, setUserObject, toString

Methods inherited from class to.etc.domui.dom.css.CssBase

getBackgroundAttachment, getBackgroundColor, getBackgroundImage, getBackgroundPosition, getBackgroundRepeat, getBorderBottomColor, getBorderBottomStyle, getBorderBottomWidth, getBorderLeftColor, getBorderLeftStyle, getBorderLeftWidth, getBorderRightColor, getBorderRightStyle, getBorderRightWidth, getBorderTopColor, getBorderTopStyle, getBorderTopWidth, getBottom, getCachedStyle, getClear, getColor, getDisplay, getFloat, getFontFamily, getFontSize, getFontSizeAdjust, getFontStyle, getFontVariant, getFontWeight, getHeight, getLeft, getLineHeight, getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOverflow, getPaddingBottom, getPaddingLeft, getPaddingRight, getPaddingTop, getPosition, getRight, getTextAlign, getTop, getTransform, getVerticalAlign, getVisibility, getWidth, getZIndex, internalSetDisplay, setBackgroundAttachment, setBackgroundColor, setBackgroundImage, setBackgroundPosition, setBackgroundRepeat, setBorder, setBorder, setBorderBottomColor, setBorderBottomStyle, setBorderBottomWidth, setBorderColor, setBorderLeftColor, setBorderLeftStyle, setBorderLeftWidth, setBorderRightColor, setBorderRightStyle, setBorderRightWidth, setBorderStyle, setBorderTopColor, setBorderTopStyle, setBorderTopWidth, setBorderWidth, setBottom, setBottom, setCachedStyle, setClear, setColor, setDisplay, setFloat, setFontFamily, setFontSize, setFontSizeAdjust, setFontStyle, setFontVariant, setFontWeight, setHeight, setLeft, setLeft, setLineHeight, setMargin, setMarginBottom, setMarginLeft, setMarginRight, setMarginTop, setMaxHeight, setMaxWidth, setMinHeight, setMinWidth, setOverflow, setPadding, setPaddingBottom, setPaddingLeft, setPaddingRight, setPaddingTop, setPosition, setRight, setRight, setTextAlign, setTop, setTop, setTransform, setVerticalAlign, setVisibility, setWidth, setZIndex

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface to.etc.domui.dom.html.IControl

getErrorLocation, setErrorLocation

Methods inherited from interface to.etc.domui.dom.html.IActionControl

setTestID

Methods inherited from interface to.etc.domui.dom.errors.INodeErrorDelegate

clearMessage, getMessage, setMessage

Field Detail

TYPE_HINT

public static final String TYPE_HINT

See Also:

Constant Field Values

Constructor Detail

Checkbox

public Checkbox()

Method Detail

visit

public void visit(INodeVisitor v)
           throws Exception

Description copied from class: NodeBase

This must visit the appropriate method in the node visitor. It should NOT recurse it's children.

Specified by:

visit in class NodeBase

Throws:

Exception

isChecked

public boolean isChecked()

setChecked

public void setChecked(boolean checked)

isDisabled

public boolean isDisabled()

Description copied from interface: IControl

Returns T if the control is currently in disabled. Controls that do not have a readonly ability (comboboxes) will use disabled as the readonly state. For those controls the readonly state mirrors the disabled state.

Specified by:

isDisabled in interface IControl<Boolean>

Returns:

setDisabled

public void setDisabled(boolean disabled)

Description copied from interface: IActionControl

Set the input to disabled mode.

Specified by:

setDisabled in interface IActionControl

getDisabledBecause

@Nullable
public String getDisabledBecause()

setDisabledBecause

public void setDisabledBecause(@Nullable
                               String msg)

isReadOnly

public boolean isReadOnly()

Checkboxes cannot be readonly; we make them disabled instead.

Specified by:

isReadOnly in interface IControl<Boolean>

Returns:

See Also:

IControl.isReadOnly()

setReadOnly

public void setReadOnly(boolean readOnly)

Description copied from interface: IControl

Sets the input to readonly-mode. Components that do not implement readonly mode (comboboxes) will usually set themselves to disabled which works much the same.

Specified by:

setReadOnly in interface IControl<Boolean>

acceptRequestParameter

public boolean acceptRequestParameter(@Nonnull
                                      String[] values)

Overrides:

acceptRequestParameter in class NodeBase

getValue

@Nonnull
public Boolean getValue()

Description copied from interface: IControl

Returns the current value of this input component. If the component contains no value this returns null. All text input components will return null when their value is the empty string! If the component, during conversion or validation of the input value, discovers that the input is invalid it will set itself in "error" mode, post an error message up the form, and throw a ValidationException. This means that this call either delivers correct input (as defined by it's converter and validators), null (when empty) or throws an exception. When a ValidationException occurs the framework mostly ignores it - it does not produce a stacktrace or error in the client. Instead the resulting error as posted by the error handling framework gets displayed on the form when the request completes.

To get the value of a component while ignoring exceptions call IControl.getValueSafe().

Specified by:

getValue in interface IControl<Boolean>

Returns:

See Also:

IControl.getValue()

setValue

public void setValue(@Nullable
                     Boolean v)

Description copied from interface: IControl

Set a new value into this control. Setting a value to null means the control holds no value. This value is converted to a presentable form using any (implicitly) defined converters; it will not be validated though! This means that if you set an invalid value for a validator this will not be seen until the value is gotten from the control again.

Specified by:

setValue in interface IControl<Boolean>

See Also:

IControl.setValue(java.lang.Object)

getValueSafe

public Boolean getValueSafe()

Description copied from interface: IControl

Like IControl.getValue() this returns the value of the component, but this returns null if the value was invalid. For this method NULL either means the value was invalid OR it's content was empty. To distinguish between the two call IControl.hasError() or use IControl.getValue() instead of this call.

Specified by:

getValueSafe in interface IControl<Boolean>

Returns:

See Also:

IControl.getValueSafe()

hasError

public boolean hasError()

Description copied from class: NodeBase

Return T if this node currently has an error associated with it.

Specified by:

hasError in interface IControl<Boolean>

Overrides:

hasError in class NodeBase

Returns:

See Also:

IControl.hasError()

isMandatory

public boolean isMandatory()

Description copied from interface: IControl

Returns T if this control is a mandatory input.

Specified by:

isMandatory in interface IControl<Boolean>

Returns:

setMandatory

public void setMandatory(boolean mandatory)

Description copied from interface: IControl

Make the control mandatory.

Specified by:

setMandatory in interface IControl<Boolean>

getOnValueChanged

@Deprecated
public IValueChanged<?> getOnValueChanged()

Deprecated.

Do not use for Checkbox!!! There is a big bug in Internet Explorer where it does not call onchange for checkboxes. A workaround has been added to DomUI, but it cannot be made transparent. It is better to use NodeBase.setClicked(IClickBase) to handle checkbox change events!

Specified by:

getOnValueChanged in interface IHasChangeListener

Specified by:

getOnValueChanged in interface INativeChangeListener

See Also:

IHasChangeListener.getOnValueChanged()

setOnValueChanged

@Deprecated
public void setOnValueChanged(IValueChanged<?> onValueChanged)

Deprecated.

Do not use for Checkbox!!! There is a big bug in Internet Explorer where it does not call onchange for checkboxes. A workaround has been added to DomUI, but it cannot be made transparant. It is better to use NodeBase.setClicked(IClickBase) to handle checkbox change events!

Specified by:

setOnValueChanged in interface IHasChangeListener

See Also:

IHasChangeListener.setOnValueChanged(to.etc.domui.dom.html.IValueChanged)

isModified

public boolean isModified()

Returns the modified-by-user flag.

Specified by:

isModified in interface IHasModifiedIndication

See Also:

IHasModifiedIndication.isModified()

setModified

public void setModified(boolean as)

Set or clear the modified by user flag.

Specified by:

setModified in interface IHasModifiedIndication

See Also:

IHasModifiedIndication.setModified(boolean)

isImmediate

public boolean isImmediate()

immediate

public void immediate(boolean immediate)

immediate

public void immediate()