public class CheckBox extends ButtonBase implements HasName, HasValue<Boolean>, HasWordWrap, HasDirectionalSafeHtml, HasDirectionEstimator, IsEditor<LeafValueEditor<Boolean>>, HasFormValue, HasChangeHandlers
Radio
.
setDirectionEstimator(boolean)
or
passing a DirectionEstimator parameter to the constructor, and is off by
default.
UIObject.DebugIdImpl, UIObject.DebugIdImplEnabled
Modifier and Type | Field and Description |
---|---|
protected InputElement |
inputElem |
protected SpanElement |
labelElem |
DEBUG_ID_PREFIX
Modifier | Constructor and Description |
---|---|
|
CheckBox() |
protected |
CheckBox(Element element,
InputElement inputElement) |
|
CheckBox(SafeHtml label)
Creates a check box with the specified text label.
|
|
CheckBox(SafeHtml label,
DirectionEstimator directionEstimator)
Creates a check box with the specified text label.
|
|
CheckBox(SafeHtml label,
HasDirection.Direction dir)
Creates a check box with the specified text label.
|
|
CheckBox(String label)
Creates a check box with the specified text label.
|
|
CheckBox(String label,
boolean asHTML)
Creates a check box with the specified text label.
|
|
CheckBox(String label,
DirectionEstimator directionEstimator)
Creates a label with the specified text and a default direction
estimator.
|
|
CheckBox(String label,
HasDirection.Direction dir)
Creates a check box with the specified text label.
|
Modifier and Type | Method and Description |
---|---|
HandlerRegistration |
addChangeHandler(ChangeHandler handler) |
HandlerRegistration |
addValueChangeHandler(ValueChangeHandler<Boolean> handler) |
LeafValueEditor<Boolean> |
asEditor() |
protected void |
ensureDomEventHandlers() |
DirectionEstimator |
getDirectionEstimator() |
String |
getFormValue()
Returns the value property of the input element that backs this widget.
|
String |
getHTML() |
String |
getName() |
int |
getTabIndex() |
String |
getText() |
HasDirection.Direction |
getTextDirection() |
Boolean |
getValue()
Determines whether this check box is currently checked.
|
boolean |
getWordWrap() |
boolean |
isEnabled() |
protected void |
onEnsureDebugId(String baseID)
Affected Elements:
-input = checkbox.
|
protected void |
onLoad()
This method is called when a widget is attached to the browser's
document.
|
protected void |
onUnload()
This method is called when a widget is detached from the browser's
document.
|
void |
setAccessKey(char key) |
void |
setDirectionEstimator(boolean enabled) |
void |
setDirectionEstimator(DirectionEstimator directionEstimator) |
void |
setEnabled(boolean enabled) |
void |
setFocus(boolean focused) |
void |
setFormValue(String value)
Set the value property on the input element that backs this widget.
|
void |
setHTML(SafeHtml html,
HasDirection.Direction dir) |
void |
setHTML(String html) |
void |
setName(String name) |
void |
setTabIndex(int index) |
void |
setText(String text) |
void |
setText(String text,
HasDirection.Direction dir) |
void |
setValue(Boolean value)
Checks or unchecks the check box.
|
void |
setValue(Boolean value,
boolean fireEvents)
Checks or unchecks the check box, firing
ValueChangeEvent if
appropriate. |
void |
setWordWrap(boolean wrap) |
void |
sinkEvents(int eventBitsToAdd) |
getId, getPull, setHiddenOn, setId, setPull, setVisibleOn
setHTML
addBlurHandler, addClickHandler, addClickListener, addDoubleClickHandler, addDragEndHandler, addDragEnterHandler, addDragHandler, addDragLeaveHandler, addDragOverHandler, addDragStartHandler, addDropHandler, addFocusHandler, addFocusListener, addGestureChangeHandler, addGestureEndHandler, addGestureStartHandler, addKeyboardListener, addKeyDownHandler, addKeyPressHandler, addKeyUpHandler, addMouseDownHandler, addMouseListener, addMouseMoveHandler, addMouseOutHandler, addMouseOverHandler, addMouseUpHandler, addMouseWheelHandler, addMouseWheelListener, addTouchCancelHandler, addTouchEndHandler, addTouchMoveHandler, addTouchStartHandler, getFocusImpl, onAttach, removeClickListener, removeFocusListener, removeKeyboardListener, removeMouseListener, removeMouseWheelListener
addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onBrowserEvent, onDetach, removeFromParent, setLayoutData, unsinkEvents
addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, isVisible, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, toString
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
fireEvent
setHTML
protected final SpanElement labelElem
protected final InputElement inputElem
public CheckBox(SafeHtml label)
label
- the check box's labelpublic CheckBox(SafeHtml label, HasDirection.Direction dir)
label
- the check box's labeldir
- the text's direction. Note that DEFAULT
means
direction should be inherited from the widget's parent
element.public CheckBox(SafeHtml label, DirectionEstimator directionEstimator)
label
- the check box's labeldirectionEstimator
- A DirectionEstimator object used for automatic direction
adjustment. For convenience,
#DEFAULT_DIRECTION_ESTIMATOR
can be used.public CheckBox(String label)
label
- the check box's labelpublic CheckBox(String label, HasDirection.Direction dir)
label
- the check box's labeldir
- the text's direction. Note that DEFAULT
means
direction should be inherited from the widget's parent
element.public CheckBox(String label, DirectionEstimator directionEstimator)
label
- the check box's labeldirectionEstimator
- A DirectionEstimator object used for automatic direction
adjustment. For convenience,
#DEFAULT_DIRECTION_ESTIMATOR
can be used.public CheckBox(String label, boolean asHTML)
label
- the check box's labelasHTML
- true
to treat the specified label as htmlpublic CheckBox()
protected CheckBox(Element element, InputElement inputElement)
public HandlerRegistration addValueChangeHandler(ValueChangeHandler<Boolean> handler)
addValueChangeHandler
in interface HasValueChangeHandlers<Boolean>
public HandlerRegistration addChangeHandler(ChangeHandler handler)
addChangeHandler
in interface HasChangeHandlers
public LeafValueEditor<Boolean> asEditor()
asEditor
in interface IsEditor<LeafValueEditor<Boolean>>
public DirectionEstimator getDirectionEstimator()
getDirectionEstimator
in interface HasDirectionEstimator
public String getFormValue()
FormPanel
that holds it is submitted
and the box is checked.
Don't confuse this with getValue()
, which returns true or false if
the widget is checked.
getFormValue
in interface HasFormValue
public String getHTML()
getHTML
in interface HasHTML
getHTML
in class ButtonBase
public int getTabIndex()
getTabIndex
in interface Focusable
getTabIndex
in class FocusWidget
public String getText()
getText
in interface HasText
getText
in class ButtonBase
public HasDirection.Direction getTextDirection()
getTextDirection
in interface HasDirectionalText
public Boolean getValue()
Note that this does not return the value property of the
checkbox input element wrapped by this widget. For access to that
property, see getFormValue()
public boolean getWordWrap()
getWordWrap
in interface HasWordWrap
public boolean isEnabled()
isEnabled
in interface HasEnabled
isEnabled
in class ButtonBase
public void setEnabled(boolean enabled)
setEnabled
in interface HasEnabled
setEnabled
in class ButtonBase
public void setAccessKey(char key)
setAccessKey
in interface Focusable
setAccessKey
in class FocusWidget
public void setDirectionEstimator(boolean enabled)
See note at setDirectionEstimator(DirectionEstimator)
.
setDirectionEstimator
in interface HasDirectionEstimator
public void setDirectionEstimator(DirectionEstimator directionEstimator)
Note: DirectionEstimator should be set before the label has any content; it's highly recommended to set it using a constructor. Reason: if the label already has non-empty content, this will update its direction according to the new estimator's result. This may cause flicker, and thus should be avoided.
setDirectionEstimator
in interface HasDirectionEstimator
public void setFocus(boolean focused)
setFocus
in interface Focusable
setFocus
in class FocusWidget
public void setFormValue(String value)
FormPanel
that holds it is submitted
and the box is checked.
Don't confuse this with setValue(java.lang.Boolean)
, which actually checks and
unchecks the box.
setFormValue
in interface HasFormValue
value
- public void setHTML(SafeHtml html, HasDirection.Direction dir)
setHTML
in interface HasDirectionalSafeHtml
public void setHTML(String html)
setHTML
in interface HasHTML
setHTML
in class ButtonBase
public void setTabIndex(int index)
setTabIndex
in interface Focusable
setTabIndex
in class FocusWidget
public void setText(String text)
setText
in interface HasText
setText
in class ButtonBase
public void setText(String text, HasDirection.Direction dir)
setText
in interface HasDirectionalText
public void setValue(Boolean value)
Note that this does not set the value property of the checkbox
input element wrapped by this widget. For access to that property, see
setFormValue(String)
public void setValue(Boolean value, boolean fireEvents)
ValueChangeEvent
if
appropriate.
Note that this does not set the value property of the checkbox
input element wrapped by this widget. For access to that property, see
setFormValue(String)
setValue
in interface HasValue<Boolean>
value
- true to check, false to uncheck; null value implies falsefireEvents
- If true, and value has changed, fire a
ValueChangeEvent
public void setWordWrap(boolean wrap)
setWordWrap
in interface HasWordWrap
public void sinkEvents(int eventBitsToAdd)
sinkEvents
in class Widget
protected void ensureDomEventHandlers()
protected void onEnsureDebugId(String baseID)
onEnsureDebugId
in class UIObject
UIObject.onEnsureDebugId(String)
protected void onLoad()
Widget.onAttach()
to preserve the
onAttach
contract.Copyright © 2017. All rights reserved.