com.sencha.gxt.widget.core.client.form

Class CheckBox

java.lang.Object

Widget

com.sencha.gxt.widget.core.client.Component

com.sencha.gxt.widget.core.client.cell.CellComponent<T>

com.sencha.gxt.widget.core.client.form.Field<Boolean>

com.sencha.gxt.widget.core.client.form.CheckBox

All Implemented Interfaces:

HasGestureRecognizers, BeforeHideEvent.HasBeforeHideHandlers, BeforeShowContextMenuEvent.HasBeforeShowContextMenuHandler, BeforeShowEvent.HasBeforeShowHandlers, BlurEvent.HasBlurHandlers, DisableEvent.HasDisableHandlers, EnableEvent.HasEnableHandlers, FocusEvent.HasFocusHandlers, HideEvent.HasHideHandlers, InvalidEvent.HasInvalidHandlers, MoveEvent.HasMoveHandlers, ShowContextMenuEvent.HasShowContextMenuHandler, ShowEvent.HasShowHandlers, ValidEvent.HasValidHandlers, HasErrorHandler, IsField<Boolean>, HasFocusSupport, HasItemId

Direct Known Subclasses:

Radio

public class CheckBox
extends Field<Boolean>

Simple checkbox field. ValueChangeEvents are fired when the checkbox state is changed by the user, instead of waiting for a BlurEvent.

Nested Class Summary

Nested classes/interfaces inherited from class com.sencha.gxt.widget.core.client.form.Field

Field.FieldStyles

Field Summary

Fields inherited from class com.sencha.gxt.widget.core.client.form.Field

forceInvalidText, hasFocus, name, originalValue, parseError, preventMark, validationTask

Fields inherited from class com.sencha.gxt.widget.core.client.cell.CellComponent

valueUpdater

Fields inherited from class com.sencha.gxt.widget.core.client.Component

adjustSize, allowTextSelection, cacheSizes, disableContextMenu, disabled, disabledStyle, ensureVisibilityOnSizing, height, hidden, lastSize, layer, left, mask, maskMessage, monitorWindowResize, pageX, pageY, resizeHandler, shim, tabIndex, toolTip, toolTipConfig, top, width, windowResizeDelay, windowResizeTask

Constructor Summary

Constructors

Constructor and Description
CheckBox() Creates a new check box.
CheckBox(CheckBoxCell cell) Creates a new check box.

Method Summary

Modifier and Type	Method and Description
HandlerRegistration	addChangeHandler(ChangeHandler handler)
protected void	alignElements()
void	clear() Clears the value from the field.
void	clearInvalid() Clear any invalid styles / messages for this field.
SafeHtml	getBoxLabel() Returns the box label.
CheckBoxCell	getCell() Get the Cell wrapped by this widget.
protected void	markInvalid(List<EditorError> msg) Actual implementation of markInvalid, which bypasses recording an error in the editor peer.
protected void	onAttach()
protected void	onRedraw()
protected void	onResize(int width, int height) Called after the widget is resized, this method is empty by default but can be implemented by any subclass that needs to perform custom logic after a resize occurs.
void	reset() Resets the current field value to the originally loaded value and clears any validation messages.
void	setBoxLabel(SafeHtml html) The html that appears beside the checkbox (defaults to empty string).
void	setBoxLabel(String text) The text that appears beside the checkbox (defaults to empty string).
void	setTabIndex(int tabIndex) Sets the component's tab index.
void	setValue(Boolean value)

Methods inherited from class com.sencha.gxt.widget.core.client.form.Field

addInvalidHandler, addValidator, addValidHandler, addValueChangeHandler, doAutoValidate, finishEditing, flush, forceInvalid, getErrors, getErrorSupport, getName, getOriginalValue, getValidateOnBlur, getValidationDelay, getValidators, isAutoValidate, isEditing, isValid, isValid, markInvalid, onBlur, onBrowserEvent, onDetach, onDisable, onEnable, onFocus, onKeyDown, onKeyPress, onKeyUp, onLogicalBlur, onLogicalFocus, onNavigationKey, onPropertyChange, removeValidator, setAutoValidate, setDelegate, setErrors, setErrorSupport, setName, setOriginalValue, setReadOnly, setValidateOnBlur, setValidationDelay, setValue, showErrors, validate, validate, validateValue

Methods inherited from class com.sencha.gxt.widget.core.client.cell.CellComponent

createContext, getElement, getFocusEl, getKey, getKeyProvider, getValue, redraw, redraw, setKeyProvider, setValue

Methods inherited from class com.sencha.gxt.widget.core.client.Component

addBeforeHideHandler, addBeforeShowContextMenuHandler, addBeforeShowHandler, addBlurHandler, addDisableHandler, addEnableHandler, addFocusHandler, addGestureRecognizer, addHideHandler, addMoveHandler, addResizeHandler, addShowContextMenuHandler, addShowHandler, addStyleDependentName, addStyleOnOver, adjustPosition, adjustSize, applyState, assertAfterRender, assertPreRender, blur, clearSizeCache, disable, disableContextMenu, disableEvents, enable, enableEvents, fireCancellableEvent, fireEvent, focus, getData, getFocusSupport, getGestureRecognizer, getGestureRecognizerCount, getHideMode, getId, getItemId, getOffsetHeight, getOffsetWidth, getPositionEl, getShadow, getShadowPosition, getStateId, getTabIndex, getToolTip, hide, hideShadow, hideToolTip, isAllowTextSelection, isAutoHeight, isAutoWidth, isDeferHeight, isEnabled, isMonitorWindowResize, isRendered, isStateful, isVisible, isVisible, mask, mask, notifyHide, notifyShow, onAfterFirstAttach, onHide, onHideContextMenu, onLoad, onPosition, onRightClick, onShow, onShowContextMenu, onTouch, onUnload, onWindowResize, removeStyleDependentName, removeStyleOnOver, removeToolTip, setAllowTextSelection, setBorders, setBounds, setBounds, setContextMenu, setData, setDeferHeight, setEnabled, setHeight, setHeight, setHideMode, setId, setItemId, setMonitorWindowResize, setPagePosition, setPixelSize, setPosition, setShadow, setShadowPosition, setSize, setStateful, setStateId, setStyleDependentName, setToolTip, setToolTipConfig, setVisible, setWidth, setWidth, show, sync, syncSize, unmask

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sencha.gxt.widget.core.client.event.BlurEvent.HasBlurHandlers

addBlurHandler

Constructor Detail

CheckBox

public CheckBox()

Creates a new check box.

CheckBox

public CheckBox(CheckBoxCell cell)

Creates a new check box.

Parameters:

cell - the check box cell

Method Detail

addChangeHandler

public HandlerRegistration addChangeHandler(ChangeHandler handler)

clear

public void clear()

Clears the value from the field.

Specified by:

clear in interface IsField<Boolean>

Overrides:

clear in class Field<Boolean>

See Also:

to remove validation messages, to restore to original value and remove validation messages

clearInvalid

public void clearInvalid()

Description copied from class: Field

Clear any invalid styles / messages for this field.

Specified by:

clearInvalid in interface IsField<Boolean>

Overrides:

clearInvalid in class Field<Boolean>

getBoxLabel

public SafeHtml getBoxLabel()

Returns the box label.

Returns:

the box label

getCell

public CheckBoxCell getCell()

Description copied from class: CellComponent

Get the Cell wrapped by this widget.

Overrides:

getCell in class Field<Boolean>

Returns:

the Cell being wrapped

setBoxLabel

public void setBoxLabel(String text)

The text that appears beside the checkbox (defaults to empty string).

Parameters:

text - the box label text

setBoxLabel

public void setBoxLabel(SafeHtml html)

The html that appears beside the checkbox (defaults to empty string).

Parameters:

html - the box label html

setTabIndex

public void setTabIndex(int tabIndex)

Description copied from class: Component

Sets the component's tab index. Subclasses may override this to set the tab index on a specific element for better focus behavior - they are also responsible for setting the tabIndex field.

Overrides:

setTabIndex in class Component

Parameters:

tabIndex - the tab index

setValue

public void setValue(Boolean value)

Description copied from class: CellComponent

This method will redraw the widget if the new value does not equal the existing value.

Overrides:

setValue in class CellComponent<Boolean>

alignElements

protected void alignElements()

markInvalid

protected void markInvalid(List<EditorError> msg)

Description copied from class: Field

Actual implementation of markInvalid, which bypasses recording an error in the editor peer.

Overrides:

markInvalid in class Field<Boolean>

Parameters:

msg - the validation message

reset

public void reset()

Description copied from interface: IsField

Resets the current field value to the originally loaded value and clears any validation messages.

Specified by:

reset in interface IsField<Boolean>

Overrides:

reset in class Field<Boolean>

onAttach

protected void onAttach()

Overrides:

onAttach in class Component

onResize

protected void onResize(int width,
                        int height)

Description copied from class: Component

Called after the widget is resized, this method is empty by default but can be implemented by any subclass that needs to perform custom logic after a resize occurs.

Overrides:

onResize in class CellComponent<Boolean>

Parameters:

width - the width

height - the height

onRedraw

protected void onRedraw()

Overrides:

onRedraw in class Field<Boolean>