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

java.lang.Object
  com.google.gwt.user.client.ui.UIObject
      com.google.gwt.user.client.ui.Widget
          com.extjs.gxt.ui.client.widget.Component
              com.extjs.gxt.ui.client.widget.BoxComponent
                  com.extjs.gxt.ui.client.widget.form.Field<java.lang.Boolean>
                      com.extjs.gxt.ui.client.widget.form.CheckBox

All Implemented Interfaces:

Observable, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener

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

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

CheckBox()

Method Summary

void	clearInvalid() Clear any invalid styles / messages for this field.
java.lang.String	getBoxLabel()
java.lang.String	getRawValue() Returns the raw data value which may or may not be a valid, defined value.
java.lang.String	getValueAttribute() Returns the value property of the input element
void	markInvalid(java.lang.String msg) Marks this field as invalid.
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	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, focus, forceInvalid, getAutoValidate, getEmptyText, getErrorMessage, getFieldLabel, getImages, getLabelSeparator, getLabelStyle, getMessages, getMessageTarget, getName, getOriginalValue, getPropertyEditor, getValidateOnBlur, getValidationDelay, getValue, isDirty, isFireChangeEventOnSetValue, isHideLabel, isInEditor, isReadOnly, isValid, isValid, onComponentEvent, removeInputStyleName, removeKeyListener, reset, setAutoValidate, setEmptyText, setFieldLabel, setFireChangeEventOnSetValue, setHideLabel, setImages, setInEditor, setLabelSeparator, setLabelStyle, setMessages, setMessageTarget, setName, setOriginalValue, setPropertyEditor, setReadOnly, setTabIndex, setValidateOnBlur, setValidationDelay, setValue, updateOriginalValue, validate, validate

Methods inherited from class com.extjs.gxt.ui.client.widget.BoxComponent

getBounds, getHeight, getHeight, getPosition, getShadow, getShadowOffset, getShadowPosition, getSize, getWidth, getWidth, isAutoHeight, isAutoWidth, isDeferHeight, isShim, 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

addListener, addPlugin, addStyleName, addWidgetListener, clearState, disable, disableEvents, disableTextSelection, el, enable, enableEvents, fireEvent, fireEvent, fireEvent, fly, getBaseStyle, getBorders, getContextMenu, getData, getElement, getHideMode, getId, getItemId, getListeners, getModel, getState, getStateId, getToolTip, hasListeners, hasListeners, hide, hideToolTip, isDisabledEvents, isEnabled, isRendered, isStateful, isVisible, mask, mask, mask, onBrowserEvent, recalculate, removeAllListeners, removeFromParent, removeListener, removeStyleName, removeSwallow, removeToolTip, removeWidgetListener, render, render, repaint, saveState, setBorders, setContextMenu, setData, setElement, setEnabled, setHideMode, setId, setIntStyleAttribute, setItemId, setStateful, setStateId, setStyleAttribute, setStyleName, setTitle, setToolTip, setToolTip, setVisible, setZIndex, show, sinkEvents, swallowEvent, swallowEvent, toString, unmask

Methods inherited from class com.google.gwt.user.client.ui.Widget

fireEvent, getParent, isAttached

Methods inherited from class com.google.gwt.user.client.ui.UIObject

addStyleDependentName, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getOffsetHeight, getOffsetWidth, getStyleName, getStylePrimaryName, getTitle, isVisible, removeStyleDependentName, setStylePrimaryName, setVisible, unsinkEvents

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

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

setValueAttribute

public void setValueAttribute(java.lang.String valueAttribute)

Sets a new value attribute to the input element

Parameters:

valueAttribute - the value attribute to set