com.extjs.gxt.ui.client.widget.form
Class CheckBox

java.lang.Object
  extended by com.google.gwt.user.client.ui.UIObject
      extended by com.google.gwt.user.client.ui.Widget
          extended by com.extjs.gxt.ui.client.widget.Component
              extended by com.extjs.gxt.ui.client.widget.BoxComponent
                  extended by com.extjs.gxt.ui.client.widget.form.Field<java.lang.Boolean>
                      extended by com.extjs.gxt.ui.client.widget.form.CheckBox
All Implemented Interfaces:
Observable, com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.IsWidget
Direct Known Subclasses:
Radio

public class CheckBox
extends Field<java.lang.Boolean>

Single checkbox field. Unlike other fields, checkbox fires change events when the radios state is changed, not on blur.

Inherited Events:
Field Focus
Field Blur
Field Change
Field Invalid
Field Valid
Field KeyPress
Field SpecialKey
BoxComponent Move
BoxComponent Resize
Component Enable
Component Disable
Component BeforeHide
Component Hide
Component BeforeShow
Component Show
Component Attach
Component Detach
Component BeforeRender
Component Render
Component BrowserEvent
Component BeforeStateRestore
Component StateRestore
Component BeforeStateSave
Component SaveState


Nested Class Summary
 
Nested classes/interfaces inherited from class com.extjs.gxt.ui.client.widget.form.Field
Field.FieldImages, Field.FieldMessages
 
Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject
com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled
 
Field Summary
protected  El boxLabelEl
           
protected  El input
           
protected  El wrap
           
 
Fields inherited from class com.extjs.gxt.ui.client.widget.form.Field
autoValidate, emptyText, errorIcon, fieldStyle, focusStyle, focusValue, forceInvalidText, hasFocus, images, invalidStyle, messages, name, originalValue, preventMark, propertyEditor, readOnly, readOnlyFieldStyle, validationDelay, validationTask, value
 
Fields inherited from class com.extjs.gxt.ui.client.widget.BoxComponent
adjustSize, cacheSizes, ensureVisibilityOnSizing, height, lastSize, layer, shim, width
 
Fields inherited from class com.extjs.gxt.ui.client.widget.Component
afterRender, attachables, baseStyle, disabled, disabledStyle, disableTextSelection, dummy, focusable, hidden, mask, maskMessage, maskMessageStyleName, monitorWindowResize, rendered, resizeHandler, setElementRender, stateId, swallowEvents, toolTip, windowResizeDelay, windowResizeTask
 
Fields inherited from class com.google.gwt.user.client.ui.UIObject
DEBUG_ID_PREFIX
 
Constructor Summary
CheckBox()
           
 
Method Summary
protected  void alignElements()
           
 void clearInvalid()
          Clear any invalid styles / messages for this field.
 java.lang.String getBoxLabel()
           
protected  El getFocusEl()
           
protected  El getInputEl()
          Provides support for wrapping the actual input element.
 java.lang.String getRawValue()
          Returns the raw data value which may or may not be a valid, defined value.
protected  El getStyleEl()
           
 java.lang.Boolean getValue()
          Returns the typed value of the field.
 java.lang.String getValueAttribute()
          Returns the value property of the input element
 void markInvalid(java.lang.String msg)
          Marks this field as invalid.
protected  void notifyShow()
           
protected  void onAttach()
           
protected  void onBlur(ComponentEvent be)
           
protected  void onClick(ComponentEvent ce)
           
protected  void onFocus(ComponentEvent ce)
           
protected  void onRender(com.google.gwt.user.client.Element target, int index)
          Subclasses must override and ensure setElement is called for lazy rendered components.
protected  void onResize(int width, int height)
          Called after the component 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.
protected  void setAriaState(java.lang.String stateName, java.lang.String stateValue)
           
 void setBoxLabel(java.lang.String boxLabel)
          The text that appears beside the checkbox (defaults to null).
 void setRawValue(java.lang.String value)
          Sets the underlying DOM field's value directly, bypassing validation.
 void setValue(java.lang.Boolean value)
          Sets a data value into the field and validates it.
 void setValueAttribute(java.lang.String valueAttribute)
          Sets a new value attribute to the input element
 
Methods inherited from class com.extjs.gxt.ui.client.widget.form.Field
addInputStyleName, addKeyListener, afterRender, alignErrorIcon, clear, createComponentEvent, doDetachChildren, findLabelElement, fireChangeEvent, fireKey, focus, forceInvalid, getAutoValidate, getEmptyText, getErrorMessage, getFieldLabel, getImages, getLabelSeparator, getLabelStyle, getMessages, getMessageTarget, getName, getOriginalValue, getPropertyEditor, getValidateOnBlur, getValidationDelay, initValue, isDirty, isFireChangeEventOnSetValue, isHideLabel, isInEditor, isReadOnly, isValid, isValid, onComponentEvent, onDetach, onDisable, onEnable, onHide, onKeyDown, onKeyPress, onKeyUp, onShow, removeInputStyleName, removeKeyListener, reset, setAutoValidate, setEmptyText, setFieldLabel, setFireChangeEventOnSetValue, setHideLabel, setImages, setInEditor, setInputStyleAttribute, setLabelSeparator, setLabelStyle, setMessages, setMessageTarget, setName, setOriginalValue, setPropertyEditor, setReadOnly, setTabIndex, setValidateOnBlur, setValidationDelay, updateOriginalValue, validate, validate, validateValue
 
Methods inherited from class com.extjs.gxt.ui.client.widget.BoxComponent
adjustPosition, adjustSize, getBounds, getHeight, getHeight, getPosition, getPositionEl, getResizeEl, getShadow, getShadowOffset, getShadowPosition, getSize, getWidth, getWidth, hideShadow, hideShim, hideUnders, isAutoHeight, isAutoWidth, isDeferHeight, isShim, onPosition, onUnload, setAutoHeight, setAutoWidth, setBounds, setBounds, setDeferHeight, setHeight, setHeight, setPagePosition, setPagePosition, setPixelSize, setPosition, setShadow, setShadowOffset, setShadowPosition, setShim, setSize, setSize, setWidth, setWidth, sync, syncSize
 
Methods inherited from class com.extjs.gxt.ui.client.widget.Component
addAttachable, addListener, addPlugin, addStyleName, addStyleOnOver, addWidgetListener, applyState, assertAfterRender, assertPreRender, beforeRender, blur, clearState, createObservable, createStyles, disable, disableContextMenu, disableEvents, disableTextSelection, doAttachChildren, el, enable, enableEvents, fireEvent, fireEvent, fireEvent, fly, frame, getAriaSupport, getBaseStyle, getBorders, getContextMenu, getData, getElement, getFocusSupport, getHideMode, getId, getItemId, getListeners, getModel, getObservable, getPlugins, getState, getStateId, getTabIndex, getTitle, getToolTip, getWindowResizeDelay, hasListeners, hasListeners, hide, hideToolTip, initState, isDisabledEvents, isDisableTextSelection, isEnabled, isMasked, isMonitorWindowResize, isRendered, isStateful, isVisible, isVisible, mask, mask, mask, notifyHide, onBrowserEvent, onDetachHelper, onEnsureDebugId, onHideContextMenu, onLoad, onRightClick, onShowContextMenu, onWindowResize, previewEvent, recalculate, removeAllListeners, removeAttachagle, removeFromParent, removeListener, removeStyleName, removeStyleOnOver, removeSwallow, removeToolTip, removeWidgetListener, render, render, repaint, saveState, setAriaRole, setAriaSupport, setBorders, setContextMenu, setData, setEl, setElement, setElement, setEnabled, setFiresEvents, setHideMode, setId, setIntStyleAttribute, setItemId, setModel, setMonitorWindowResize, setParent, setStateful, setStateId, setStyleAttribute, setStyleName, setTitle, setToolTip, setToolTip, setVisible, setWindowResizeDelay, setZIndex, show, sinkEvents, swallowEvent, swallowEvent, toString, unframe, unmask
 
Methods inherited from class com.google.gwt.user.client.ui.Widget
addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, setLayoutData
 
Methods inherited from class com.google.gwt.user.client.ui.UIObject
addStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, removeStyleDependentName, setElement, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkBitlessEvent, unsinkEvents
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

wrap

protected El wrap

input

protected El input

boxLabelEl

protected El boxLabelEl
Constructor Detail

CheckBox

public CheckBox()
Method Detail

clearInvalid

public void clearInvalid()
Description copied from class: Field
Clear any invalid styles / messages for this field.

Overrides:
clearInvalid in class Field<java.lang.Boolean>

getBoxLabel

public java.lang.String getBoxLabel()

getRawValue

public java.lang.String getRawValue()
Description copied from class: Field
Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see Field.getValue().

Overrides:
getRawValue in class Field<java.lang.Boolean>
Returns:
the raw value

getValue

public java.lang.Boolean getValue()
Description copied from class: Field
Returns the typed value of the field.

Overrides:
getValue in class Field<java.lang.Boolean>
Returns:
the fields value

getValueAttribute

public java.lang.String getValueAttribute()
Returns the value property of the input element


markInvalid

public void markInvalid(java.lang.String msg)
Description copied from class: Field
Marks this field as invalid. Validation will still run if called again, and the error message will be changed or cleared based on validation. To set a error message that will not be cleared until manually cleared see Field.forceInvalid(String)

Overrides:
markInvalid in class Field<java.lang.Boolean>
Parameters:
msg - the validation message

setBoxLabel

public void setBoxLabel(java.lang.String boxLabel)
The text that appears beside the checkbox (defaults to null).

Parameters:
boxLabel - the box label

setRawValue

public void setRawValue(java.lang.String value)
Description copied from class: Field
Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see Field.setValue(D).

Overrides:
setRawValue in class Field<java.lang.Boolean>
Parameters:
value - the raw value

setValue

public void setValue(java.lang.Boolean value)
Description copied from class: Field
Sets a data value into the field and validates it. If the field is rendered, To set the value directly without validation see Field.setRawValue(java.lang.String).

Overrides:
setValue in class Field<java.lang.Boolean>
Parameters:
value - the value to set

setValueAttribute

public void setValueAttribute(java.lang.String valueAttribute)
Sets a new value attribute to the input element

Parameters:
valueAttribute - the value attribute to set

alignElements

protected void alignElements()

getFocusEl

protected El getFocusEl()
Overrides:
getFocusEl in class Component

getInputEl

protected El getInputEl()
Description copied from class: Field
Provides support for wrapping the actual input element.

Overrides:
getInputEl in class Field<java.lang.Boolean>
Returns:
the input element

getStyleEl

protected El getStyleEl()
Overrides:
getStyleEl in class Field<java.lang.Boolean>

notifyShow

protected void notifyShow()
Overrides:
notifyShow in class Component

onAttach

protected void onAttach()
Overrides:
onAttach in class Component

onBlur

protected void onBlur(ComponentEvent be)
Overrides:
onBlur in class Field<java.lang.Boolean>

onClick

protected void onClick(ComponentEvent ce)
Overrides:
onClick in class Field<java.lang.Boolean>

onFocus

protected void onFocus(ComponentEvent ce)
Overrides:
onFocus in class Field<java.lang.Boolean>

onRender

protected void onRender(com.google.gwt.user.client.Element target,
                        int index)
Description copied from class: Component
Subclasses must override and ensure setElement is called for lazy rendered components.

Overrides:
onRender in class Field<java.lang.Boolean>
Parameters:
target - the target element
index - the insert location

onResize

protected void onResize(int width,
                        int height)
Description copied from class: BoxComponent
Called after the component 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 Field<java.lang.Boolean>
Parameters:
width - the width
height - the height

setAriaState

protected void setAriaState(java.lang.String stateName,
                            java.lang.String stateValue)
Overrides:
setAriaState in class Component