public class CheckBox extends ButtonBase implements HasName, HasValue<java.lang.Boolean>, HasWordWrap, HasDirectionalSafeHtml, HasDirectionEstimator, IsEditor<LeafValueEditor<java.lang.Boolean>>
RadioButton.
setDirectionEstimator(boolean) or
passing a DirectionEstimator parameter to the constructor, and is off by
default.
public class CheckBoxExample implements EntryPoint {
@Override
public void onModuleLoad() {
// Make a new check box, and select it by default.
CheckBox cb = new CheckBox("Foo");
cb.setValue(true);
// Hook up a handler to find out when it's clicked.
cb.addClickHandler(new ClickHandler() {
@Override
public void onClick(ClickEvent event) {
boolean checked = ((CheckBox) event.getSource()).getValue();
Window.alert("It is " + (checked ? "" : "not ") + "checked");
}
});
// Add it to the root panel.
RootPanel.get().add(cb);
}
}
UIObject.DebugIdImpl, UIObject.DebugIdImplEnabled| Modifier and Type | Field and Description |
|---|---|
static DirectionEstimator |
DEFAULT_DIRECTION_ESTIMATOR |
(package private) DirectionalTextHelper |
directionalTextHelper |
(package private) InputElement |
inputElem |
(package private) LabelElement |
labelElem |
eventsToSinkDEBUG_ID_PREFIX, MISSING_ELEMENT_ERROR, SETELEMENT_TWICE_ERROR| Modifier | Constructor and Description |
|---|---|
|
CheckBox()
Creates a check box with no label.
|
protected |
CheckBox(Element elem) |
|
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(java.lang.String label)
Creates a check box with the specified text label.
|
|
CheckBox(java.lang.String label,
boolean asHTML)
Creates a check box with the specified text label.
|
|
CheckBox(java.lang.String label,
DirectionEstimator directionEstimator)
Creates a label with the specified text and a default direction estimator.
|
|
CheckBox(java.lang.String label,
HasDirection.Direction dir)
Creates a check box with the specified text label.
|
| Modifier and Type | Method and Description |
|---|---|
HandlerRegistration |
addValueChangeHandler(ValueChangeHandler<java.lang.Boolean> handler)
Adds a
ValueChangeEvent handler. |
LeafValueEditor<java.lang.Boolean> |
asEditor()
Returns the Editor encapsulated by the view object.
|
protected void |
ensureDomEventHandlers() |
DirectionEstimator |
getDirectionEstimator()
Returns the
DirectionEstimator object. |
java.lang.String |
getFormValue()
Returns the value property of the input element that backs this widget.
|
java.lang.String |
getHTML()
Gets this object's contents as HTML.
|
java.lang.String |
getName()
Gets the widget's name.
|
int |
getTabIndex()
Gets the tab index.
|
java.lang.String |
getText()
Gets this object's text.
|
HasDirection.Direction |
getTextDirection()
Gets the direction of this object's text.
|
java.lang.Boolean |
getValue()
Determines whether this check box is currently checked.
|
boolean |
getWordWrap()
Gets whether word-wrapping is enabled.
|
boolean |
isChecked()
Deprecated.
Use
getValue() instead |
boolean |
isEnabled()
Gets whether this widget is enabled.
|
protected void |
onEnsureDebugId(java.lang.String baseID)
Affected Elements:
-label = label next to 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.
|
protected void |
replaceInputElement(Element elem)
Replace the current input element with a new one.
|
protected void |
replaceInputElement(Element elem)
Deprecated.
Call and use
replaceInputElement(Element) instead. |
void |
setAccessKey(char key)
Sets the widget's 'access key'.
|
void |
setChecked(boolean checked)
Deprecated.
Use
setValue(Boolean) instead |
void |
setDirectionEstimator(boolean enabled)
Toggles on / off direction estimation.
|
void |
setDirectionEstimator(DirectionEstimator directionEstimator)
Sets the
DirectionEstimator object. |
void |
setEnabled(boolean enabled)
Sets whether this widget is enabled.
|
void |
setFocus(boolean focused)
Explicitly focus/unfocus this widget.
|
void |
setFormValue(java.lang.String value)
Set the value property on the input element that backs this widget.
|
void |
setHTML(SafeHtml html,
HasDirection.Direction dir)
Sets this object's html, also declaring its direction.
|
void |
setHTML(java.lang.String html)
Sets this object's contents via HTML.
|
void |
setName(java.lang.String name)
Sets the widget's name.
|
void |
setTabIndex(int index)
Sets the widget's position in the tab index.
|
void |
setText(java.lang.String text)
Sets this object's text.
|
void |
setText(java.lang.String text,
HasDirection.Direction dir)
Sets this object's text, also declaring its direction.
|
void |
setValue(java.lang.Boolean value)
Checks or unchecks the check box.
|
void |
setValue(java.lang.Boolean value,
boolean fireEvents)
Checks or unchecks the check box, firing
ValueChangeEvent if
appropriate. |
void |
setWordWrap(boolean wrap)
Sets whether word-wrapping is enabled.
|
void |
sinkEvents(int eventBitsToAdd)
Overridden to defer the call to super.sinkEvents until the first time this
widget is attached to the dom, as a performance enhancement.
|
setHTMLaddBlurHandler, 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, removeMouseWheelListeneraddAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, ensureHandlers, fireEvent, getHandlerCount, getHandlerManager, getLayoutData, getParent, isAttached, isOrWasAttached, onBrowserEvent, onDetach, removeFromParent, replaceElement, setLayoutData, setParent, unsinkEventsaddStyleDependentName, 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, toStringclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitfireEventsetHTMLpublic static final DirectionEstimator DEFAULT_DIRECTION_ESTIMATOR
final DirectionalTextHelper directionalTextHelper
InputElement inputElem
LabelElement labelElem
public CheckBox()
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(java.lang.String label)
label - the check box's labelpublic CheckBox(java.lang.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(java.lang.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(java.lang.String label,
boolean asHTML)
label - the check box's labelasHTML - true to treat the specified label as htmlprotected CheckBox(Element elem)
public HandlerRegistration addValueChangeHandler(ValueChangeHandler<java.lang.Boolean> handler)
HasValueChangeHandlersValueChangeEvent handler.addValueChangeHandler in interface HasValueChangeHandlers<java.lang.Boolean>handler - the handlerpublic LeafValueEditor<java.lang.Boolean> asEditor()
IsEditorasEditor in interface IsEditor<LeafValueEditor<java.lang.Boolean>>Editor of type Epublic DirectionEstimator getDirectionEstimator()
HasDirectionEstimatorDirectionEstimator object.getDirectionEstimator in interface HasDirectionEstimatorpublic java.lang.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.
public java.lang.String getHTML()
HasHTMLgetHTML in interface HasHTMLgetHTML in class ButtonBasepublic java.lang.String getName()
HasNamepublic int getTabIndex()
FocusWidgetgetTabIndex in interface FocusablegetTabIndex in class FocusWidgetpublic java.lang.String getText()
HasTextgetText in interface HasTextgetText in class ButtonBasepublic HasDirection.Direction getTextDirection()
HasDirectionalTextgetTextDirection in interface HasDirectionalTextpublic java.lang.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()
getValue in interface TakesValue<java.lang.Boolean>getValue in interface HasValue<java.lang.Boolean>true if the check box is checked, false otherwise.
Will not return nullTakesValue.setValue(V)public boolean getWordWrap()
HasWordWrapgetWordWrap in interface HasWordWraptrue if word-wrapping is enabled.@Deprecated public boolean isChecked()
getValue() insteadtrue if the check box is checkedpublic boolean isEnabled()
FocusWidgetisEnabled in interface HasEnabledisEnabled in class FocusWidgettrue if the widget is enabledpublic void setAccessKey(char key)
FocusablesetAccessKey in interface FocusablesetAccessKey in class FocusWidgetkey - the widget's access key@Deprecated public void setChecked(boolean checked)
setValue(Boolean) insteadValueChangeEvent.
(If you want the event to fire, use setValue(Boolean, boolean))checked - true to check the check box.public void setDirectionEstimator(boolean enabled)
See note at setDirectionEstimator(DirectionEstimator).
setDirectionEstimator in interface HasDirectionEstimatorenabled - Whether to enable direction estimation. If true,
sets the DirectionEstimator object to a default
DirectionEstimator.public void setDirectionEstimator(DirectionEstimator directionEstimator)
DirectionEstimator object.
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 HasDirectionEstimatordirectionEstimator - The DirectionEstimator to be set. null means turning off direction estimation.public void setEnabled(boolean enabled)
FocusWidgetsetEnabled in interface HasEnabledsetEnabled in class FocusWidgetenabled - true to enable the widget, false
to disable itpublic void setFocus(boolean focused)
FocusableGWTTestCase#delayTestFinish for more information on how to do this.setFocus in interface FocusablesetFocus in class FocusWidgetfocused - whether this widget should take focus or release itpublic void setFormValue(java.lang.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.
value - public void setHTML(SafeHtml html, HasDirection.Direction dir)
HasDirectionalSafeHtmlsetHTML in interface HasDirectionalSafeHtmlhtml - the object's new htmldir - the html's directionpublic void setHTML(java.lang.String html)
HasHTMLHasText.setText(String) whenever possible.setHTML in interface HasHTMLsetHTML in class ButtonBasehtml - the object's new HTMLpublic void setName(java.lang.String name)
HasNamepublic void setTabIndex(int index)
Focusable-1 will cause this widget to
be removed from the tab order.setTabIndex in interface FocusablesetTabIndex in class FocusWidgetindex - the widget's tab indexpublic void setText(java.lang.String text)
HasTextsetText in interface HasTextsetText in class ButtonBasetext - the object's new textpublic void setText(java.lang.String text,
HasDirection.Direction dir)
HasDirectionalTextsetText in interface HasDirectionalTexttext - the object's new textdir - the text's directionpublic void setValue(java.lang.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)
setValue in interface TakesValue<java.lang.Boolean>setValue in interface HasValue<java.lang.Boolean>value - true to check, false to uncheck; null value implies falseTakesValue.getValue()public void setValue(java.lang.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<java.lang.Boolean>value - true to check, false to uncheck; null value implies falsefireEvents - If true, and value has changed, fire a
ValueChangeEventpublic void setWordWrap(boolean wrap)
HasWordWrapsetWordWrap in interface HasWordWrapwrap - true to enable word-wrapping.public void sinkEvents(int eventBitsToAdd)
WidgetisOrWasAttached():
@Override
public void sinkEvents(int eventBitsToAdd) {
if (isOrWasAttached()) {
/ * customized sink code goes here */
} else {
super.sinkEvents(eventBitsToAdd);
}
} sinkEvents in class WidgeteventBitsToAdd - a bitfield representing the set of events to be added
to this element's event setEventprotected void ensureDomEventHandlers()
protected void onEnsureDebugId(java.lang.String baseID)
onEnsureDebugId in class UIObjectbaseID - the base ID used by the main elementUIObject.onEnsureDebugId(String)protected void onLoad()
Widget.onAttach() to preserve the onAttach contract.protected void onUnload()
inputElem.protected void replaceInputElement(Element elem)
RadioButton.setName(java.lang.String).)elem - the new input element@Deprecated protected void replaceInputElement(Element elem)
replaceInputElement(Element) instead.