Package org.opencms.gwt.client.ui.input
Class CmsTriStateCheckBox
java.lang.Object
com.google.gwt.user.client.ui.UIObject
com.google.gwt.user.client.ui.Widget
com.google.gwt.user.client.ui.Composite
org.opencms.gwt.client.ui.input.CmsTriStateCheckBox
- All Implemented Interfaces:
com.google.gwt.event.logical.shared.HasAttachHandlers
,com.google.gwt.event.logical.shared.HasValueChangeHandlers<CmsTriStateCheckBox.State>
,com.google.gwt.event.shared.HasHandlers
,com.google.gwt.user.client.EventListener
,com.google.gwt.user.client.ui.HasVisibility
,com.google.gwt.user.client.ui.IsRenderable
,com.google.gwt.user.client.ui.IsWidget
public class CmsTriStateCheckBox
extends com.google.gwt.user.client.ui.Composite
implements com.google.gwt.event.logical.shared.HasValueChangeHandlers<CmsTriStateCheckBox.State>
Tri-state checkbox.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enum
The possible check box states.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
FieldsModifier and TypeFieldDescriptionprotected static final I_CmsInputCss
The CSS bundle for this class.Fields inherited from class com.google.gwt.user.client.ui.UIObject
DEBUG_ID_PREFIX
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncom.google.gwt.event.shared.HandlerRegistration
addValueChangeHandler
(com.google.gwt.event.logical.shared.ValueChangeHandler<CmsTriStateCheckBox.State> handler) protected void
onClick()
Handles clicks on the check box.void
Sets the state which the check box should transition to if the user clicks on it while it is neither on nor off.void
setState
(CmsTriStateCheckBox.State state, boolean fireEvent) Sets the state of the check box and optionally fires an event.void
Sets the check box label text.Methods inherited from class com.google.gwt.user.client.ui.Composite
claimElement, getWidget, initializeClaimedElement, initWidget, isAttached, onAttach, onBrowserEvent, onDetach, render, render, resolvePotentialElement, setWidget
Methods inherited from class com.google.gwt.user.client.ui.Widget
addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getHandlerCount, getLayoutData, getParent, isOrWasAttached, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEvents
Methods inherited from class com.google.gwt.user.client.ui.UIObject
addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
-
Field Details
-
CSS
The CSS bundle for this class.
-
-
Constructor Details
-
CmsTriStateCheckBox
Creates a new instance.- Parameters:
labelText
- the label text
-
-
Method Details
-
setNextStateAfterIntermediateState
Sets the state which the check box should transition to if the user clicks on it while it is neither on nor off.- Parameters:
state
- the target state
-
setState
Sets the state of the check box and optionally fires an event.- Parameters:
state
- the new statefireEvent
- true if a ValueChangeEvent should be fired
-
setText
Sets the check box label text.- Parameters:
text
- the new label text
-
onClick
Handles clicks on the check box.