com.github.ilyes4j.gwt.mdl.components.toggles

Class CheckboxBase<T extends Enum<T>>

java.lang.Object

com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.Widget

com.google.gwt.user.client.ui.FocusWidget

com.google.gwt.user.client.ui.ButtonBase

com.github.ilyes4j.gwt.mdl.components.toggles.CheckboxBase<T>

Type Parameters:

T - the flavor to be applied

All Implemented Interfaces:

IUpgrade, HasRipple, com.google.gwt.editor.client.IsEditor<com.google.gwt.editor.client.LeafValueEditor<Boolean>>, com.google.gwt.event.dom.client.HasAllDragAndDropHandlers, com.google.gwt.event.dom.client.HasAllFocusHandlers, com.google.gwt.event.dom.client.HasAllGestureHandlers, com.google.gwt.event.dom.client.HasAllKeyHandlers, com.google.gwt.event.dom.client.HasAllMouseHandlers, com.google.gwt.event.dom.client.HasAllTouchHandlers, com.google.gwt.event.dom.client.HasBlurHandlers, com.google.gwt.event.dom.client.HasClickHandlers, com.google.gwt.event.dom.client.HasDoubleClickHandlers, com.google.gwt.event.dom.client.HasDragEndHandlers, com.google.gwt.event.dom.client.HasDragEnterHandlers, com.google.gwt.event.dom.client.HasDragHandlers, com.google.gwt.event.dom.client.HasDragLeaveHandlers, com.google.gwt.event.dom.client.HasDragOverHandlers, com.google.gwt.event.dom.client.HasDragStartHandlers, com.google.gwt.event.dom.client.HasDropHandlers, com.google.gwt.event.dom.client.HasFocusHandlers, com.google.gwt.event.dom.client.HasGestureChangeHandlers, com.google.gwt.event.dom.client.HasGestureEndHandlers, com.google.gwt.event.dom.client.HasGestureStartHandlers, com.google.gwt.event.dom.client.HasKeyDownHandlers, com.google.gwt.event.dom.client.HasKeyPressHandlers, com.google.gwt.event.dom.client.HasKeyUpHandlers, com.google.gwt.event.dom.client.HasMouseDownHandlers, com.google.gwt.event.dom.client.HasMouseMoveHandlers, com.google.gwt.event.dom.client.HasMouseOutHandlers, com.google.gwt.event.dom.client.HasMouseOverHandlers, com.google.gwt.event.dom.client.HasMouseUpHandlers, com.google.gwt.event.dom.client.HasMouseWheelHandlers, com.google.gwt.event.dom.client.HasTouchCancelHandlers, com.google.gwt.event.dom.client.HasTouchEndHandlers, com.google.gwt.event.dom.client.HasTouchMoveHandlers, com.google.gwt.event.dom.client.HasTouchStartHandlers, com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.logical.shared.HasValueChangeHandlers<Boolean>, com.google.gwt.event.shared.HasHandlers, com.google.gwt.i18n.shared.HasDirectionEstimator, com.google.gwt.safehtml.client.HasSafeHtml, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.TakesValue<Boolean>, com.google.gwt.user.client.ui.Focusable, com.google.gwt.user.client.ui.HasDirectionalSafeHtml, com.google.gwt.user.client.ui.HasDirectionalText, com.google.gwt.user.client.ui.HasEnabled, com.google.gwt.user.client.ui.HasFocus, com.google.gwt.user.client.ui.HasHTML, com.google.gwt.user.client.ui.HasName, com.google.gwt.user.client.ui.HasText, com.google.gwt.user.client.ui.HasValue<Boolean>, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.HasWordWrap, com.google.gwt.user.client.ui.IsWidget, com.google.gwt.user.client.ui.SourcesClickEvents, com.google.gwt.user.client.ui.SourcesFocusEvents, com.google.gwt.user.client.ui.SourcesKeyboardEvents, com.google.gwt.user.client.ui.SourcesMouseEvents

Direct Known Subclasses:

Checkbox, Flip, RadioButton

public class CheckboxBase<T extends Enum<T>>
extends com.google.gwt.user.client.ui.ButtonBase
implements HasRipple, com.google.gwt.user.client.ui.HasName, com.google.gwt.user.client.ui.HasValue<Boolean>, com.google.gwt.user.client.ui.HasWordWrap, com.google.gwt.user.client.ui.HasDirectionalSafeHtml, com.google.gwt.i18n.shared.HasDirectionEstimator, com.google.gwt.editor.client.IsEditor<com.google.gwt.editor.client.LeafValueEditor<Boolean>>, IUpgrade

This class is the base structure for the material toggle-based components.

The material toggle is the material design alternative for check boxes and radio buttons. The material toggle is as capable as the GWT CheckBox. It is important that the material toggle offers at least all the available feature in the standard GWT Widget. To avoid re-inventing the wheel the material toggle should ideally inherit or embed the original Widget. Unfortunately, due to severe divergence in the DOM structure between the material toggle and the GWT check box, this is not technically possible. As a result, this class is a copy of the original CheckBox Widget with additional material related features.

CheckboxBase re-implements the DOM structure needed to fit the mdl structure and adds the material layer on top of it.

Nested Class Summary

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

Constructors

Modifier	Constructor and Description
protected	CheckboxBase(com.google.gwt.dom.client.Element elem, ToggleStyleOperator<T> paramToggle)
	CheckboxBase(com.google.gwt.safehtml.shared.SafeHtml label, com.google.gwt.i18n.shared.DirectionEstimator directionEstimator, ToggleStyleOperator<T> paramToggle) Creates a check box with the specified text label.
	CheckboxBase(com.google.gwt.safehtml.shared.SafeHtml label, com.google.gwt.i18n.client.HasDirection.Direction dir, ToggleStyleOperator<T> paramToggle) Creates a check box with the specified text label.
	CheckboxBase(com.google.gwt.safehtml.shared.SafeHtml label, ToggleStyleOperator<T> paramToggle) Creates a check box with the specified text label.
	CheckboxBase(String label, boolean asHTML, ToggleStyleOperator<T> paramToggle) Creates a check box with the specified text label.
	CheckboxBase(String label, com.google.gwt.i18n.shared.DirectionEstimator directionEstimator, ToggleStyleOperator<T> paramToggle) Creates a label with the specified text and a default direction estimator.
	CheckboxBase(String label, com.google.gwt.i18n.client.HasDirection.Direction dir, ToggleStyleOperator<T> paramToggle) Creates a check box with the specified text label.
	CheckboxBase(String label, ToggleStyleOperator<T> paramToggle) Creates a check box with the specified text label.
	CheckboxBase(ToggleStyleOperator<T> paramToggle) Creates a check box with no label.

Method Summary

Methods

Modifier and Type	Method and Description
com.google.gwt.event.shared.HandlerRegistration	addValueChangeHandler(com.google.gwt.event.logical.shared.ValueChangeHandler<Boolean> handler)
com.google.gwt.editor.client.LeafValueEditor<Boolean>	asEditor()
protected void	ensureDomEventHandlers()
protected com.google.gwt.dom.client.LabelElement	getContainer()
com.google.gwt.i18n.shared.DirectionEstimator	getDirectionEstimator()
String	getFormValue() Returns the value property of the input element that backs this widget.
String	getHTML()
protected com.google.gwt.dom.client.InputElement	getInput()
protected com.google.gwt.dom.client.SpanElement	getLabel()
String	getName()
Ripple	getRipple() Returns whether this component have a ripple.
int	getTabIndex()
String	getText()
com.google.gwt.i18n.client.HasDirection.Direction	getTextDirection()
protected ToggleStyleOperator<T>	getToggle()
Boolean	getValue() Determines whether this check box is currently checked.
boolean	getWordWrap()
boolean	isChecked() Deprecated. Use getValue() instead
boolean	isEnabled()
boolean	isUpgraded()
protected void	onEnsureDebugId(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(com.google.gwt.dom.client.Element elem) Replace the current input element with a new one.
protected void	replaceInputElement(com.google.gwt.user.client.Element elem) Deprecated. Call and use replaceInputElement(Element) instead.
void	setAccessKey(char key)
void	setChecked(boolean checked) Deprecated. Use setValue(Boolean) instead
void	setDirectionEstimator(boolean enabled)
void	setDirectionEstimator(com.google.gwt.i18n.shared.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(com.google.gwt.safehtml.shared.SafeHtml html, com.google.gwt.i18n.client.HasDirection.Direction dir)
void	setHTML(String html)
void	setName(String name)
void	setRipple(Ripple inputRipple) indicate whether this component should have a ripple.
void	setTabIndex(int index)
void	setText(String text)
void	setText(String text, com.google.gwt.i18n.client.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	upgrade() Causes the component to be upgraded.

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

setHTML

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

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

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, isAttached, isOrWasAttached, onBrowserEvent, onDetach, 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, removeStyleDependentName, removeStyleName, resolvePotentialElement, 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

Methods inherited from interface com.google.gwt.safehtml.client.HasSafeHtml

setHTML

Constructor Detail

CheckboxBase

public CheckboxBase(ToggleStyleOperator<T> paramToggle)

Creates a check box with no label.

Parameters:

paramToggle - the material design selector

CheckboxBase

public CheckboxBase(com.google.gwt.safehtml.shared.SafeHtml label,
            ToggleStyleOperator<T> paramToggle)

Creates a check box with the specified text label.

Parameters:

label - the check box's label

paramToggle - the material design selector

CheckboxBase

public CheckboxBase(com.google.gwt.safehtml.shared.SafeHtml label,
            com.google.gwt.i18n.client.HasDirection.Direction dir,
            ToggleStyleOperator<T> paramToggle)

Creates a check box with the specified text label.

Parameters:

label - the check box's label

dir - the text's direction. Note that DEFAULT means direction should be inherited from the widget's parent element.

paramToggle - the material design selector

CheckboxBase

public CheckboxBase(com.google.gwt.safehtml.shared.SafeHtml label,
            com.google.gwt.i18n.shared.DirectionEstimator directionEstimator,
            ToggleStyleOperator<T> paramToggle)

Creates a check box with the specified text label.

Parameters:

label - the check box's label

directionEstimator - A DirectionEstimator object used for automatic direction adjustment.

paramToggle - the design flavor selector

CheckboxBase

public CheckboxBase(String label,
            ToggleStyleOperator<T> paramToggle)

Creates a check box with the specified text label.

Parameters:

label - the check box's label

paramToggle - the design flavor selector

CheckboxBase

public CheckboxBase(String label,
            com.google.gwt.i18n.client.HasDirection.Direction dir,
            ToggleStyleOperator<T> paramToggle)

Creates a check box with the specified text label.

Parameters:

label - the check box's label

dir - the text's direction. Note that DEFAULT means direction should be inherited from the widget's parent element.

paramToggle - the material design selector

CheckboxBase

public CheckboxBase(String label,
            com.google.gwt.i18n.shared.DirectionEstimator directionEstimator,
            ToggleStyleOperator<T> paramToggle)

Creates a label with the specified text and a default direction estimator.

Parameters:

label - the check box's label

directionEstimator - A DirectionEstimator object used for automatic direction adjustment.

paramToggle - the material design selector

CheckboxBase

public CheckboxBase(String label,
            boolean asHTML,
            ToggleStyleOperator<T> paramToggle)

Creates a check box with the specified text label.

Parameters:

label - the check box's label

asHTML - true to treat the specified label as html

paramToggle - the material design selector

CheckboxBase

protected CheckboxBase(com.google.gwt.dom.client.Element elem,
            ToggleStyleOperator<T> paramToggle)

Parameters:

elem - the input element

paramToggle - the material design selector

Method Detail

setRipple

public final void setRipple(Ripple inputRipple)

Description copied from interface: HasRipple

indicate whether this component should have a ripple.

Specified by:

setRipple in interface HasRipple

Parameters:

inputRipple - the ripple option to be applied to the component

getRipple

public final Ripple getRipple()

Description copied from interface: HasRipple

Returns whether this component have a ripple.

Specified by:

getRipple in interface HasRipple

Returns:

the ripple option applied to the component

addValueChangeHandler

public com.google.gwt.event.shared.HandlerRegistration addValueChangeHandler(com.google.gwt.event.logical.shared.ValueChangeHandler<Boolean> handler)

Specified by:

addValueChangeHandler in interface com.google.gwt.event.logical.shared.HasValueChangeHandlers<Boolean>

asEditor

public com.google.gwt.editor.client.LeafValueEditor<Boolean> asEditor()

Specified by:

asEditor in interface com.google.gwt.editor.client.IsEditor<com.google.gwt.editor.client.LeafValueEditor<Boolean>>

getDirectionEstimator

public com.google.gwt.i18n.shared.DirectionEstimator getDirectionEstimator()

Specified by:

getDirectionEstimator in interface com.google.gwt.i18n.shared.HasDirectionEstimator

getFormValue

public String getFormValue()

Returns the value property of the input element that backs this widget. This is the value that will be associated with the CheckBox name and submitted to the server if a 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.

Returns:

the value sent to the server

getHTML

public String getHTML()

Specified by:

getHTML in interface com.google.gwt.user.client.ui.HasHTML

Overrides:

getHTML in class com.google.gwt.user.client.ui.ButtonBase

getName

public String getName()

Specified by:

getName in interface com.google.gwt.user.client.ui.HasName

getTabIndex

public int getTabIndex()

Specified by:

getTabIndex in interface com.google.gwt.user.client.ui.Focusable

Overrides:

getTabIndex in class com.google.gwt.user.client.ui.FocusWidget

getText

public String getText()

Specified by:

getText in interface com.google.gwt.user.client.ui.HasText

Overrides:

getText in class com.google.gwt.user.client.ui.ButtonBase

getTextDirection

public com.google.gwt.i18n.client.HasDirection.Direction getTextDirection()

Specified by:

getTextDirection in interface com.google.gwt.user.client.ui.HasDirectionalText

getValue

public Boolean getValue()

Determines whether this check box is currently checked.

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()

Specified by:

getValue in interface com.google.gwt.user.client.TakesValue<Boolean>

Specified by:

getValue in interface com.google.gwt.user.client.ui.HasValue<Boolean>

Returns:

true if the check box is checked, false otherwise. Will not return null

getWordWrap

public boolean getWordWrap()

Specified by:

getWordWrap in interface com.google.gwt.user.client.ui.HasWordWrap

isChecked

@Deprecated
public boolean isChecked()

Deprecated. Use getValue() instead

Determines whether this check box is currently checked.

Returns:

true if the check box is checked

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface com.google.gwt.user.client.ui.HasEnabled

Overrides:

isEnabled in class com.google.gwt.user.client.ui.FocusWidget

setAccessKey

public void setAccessKey(char key)

Specified by:

setAccessKey in interface com.google.gwt.user.client.ui.Focusable

Overrides:

setAccessKey in class com.google.gwt.user.client.ui.FocusWidget

setChecked

@Deprecated
public void setChecked(boolean checked)

Deprecated. Use setValue(Boolean) instead

Checks or unchecks this check box. Does not fire ValueChangeEvent. (If you want the event to fire, use setValue(Boolean, boolean))

Parameters:

checked - true to check the check box.

setDirectionEstimator

public void setDirectionEstimator(boolean enabled)

See note at setDirectionEstimator(DirectionEstimator).

Specified by:

setDirectionEstimator in interface com.google.gwt.i18n.shared.HasDirectionEstimator

setDirectionEstimator

public void setDirectionEstimator(com.google.gwt.i18n.shared.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.

Specified by:

setDirectionEstimator in interface com.google.gwt.i18n.shared.HasDirectionEstimator

setEnabled

public void setEnabled(boolean enabled)

Specified by:

setEnabled in interface com.google.gwt.user.client.ui.HasEnabled

Overrides:

setEnabled in class com.google.gwt.user.client.ui.FocusWidget

setFocus

public void setFocus(boolean focused)

Specified by:

setFocus in interface com.google.gwt.user.client.ui.Focusable

Overrides:

setFocus in class com.google.gwt.user.client.ui.FocusWidget

setFormValue

public void setFormValue(String value)

Set the value property on the input element that backs this widget. This is the value that will be associated with the CheckBox's name and submitted to the server if a 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.

Parameters:

value - the value transmitted to the server

setHTML

public void setHTML(com.google.gwt.safehtml.shared.SafeHtml html,
           com.google.gwt.i18n.client.HasDirection.Direction dir)

Specified by:

setHTML in interface com.google.gwt.user.client.ui.HasDirectionalSafeHtml

setHTML

public void setHTML(String html)

Specified by:

setHTML in interface com.google.gwt.user.client.ui.HasHTML

Overrides:

setHTML in class com.google.gwt.user.client.ui.ButtonBase

setName

public void setName(String name)

Specified by:

setName in interface com.google.gwt.user.client.ui.HasName

setTabIndex

public void setTabIndex(int index)

Specified by:

setTabIndex in interface com.google.gwt.user.client.ui.Focusable

Overrides:

setTabIndex in class com.google.gwt.user.client.ui.FocusWidget

setText

public void setText(String text)

Specified by:

setText in interface com.google.gwt.user.client.ui.HasText

Overrides:

setText in class com.google.gwt.user.client.ui.ButtonBase

setText

public void setText(String text,
           com.google.gwt.i18n.client.HasDirection.Direction dir)

Specified by:

setText in interface com.google.gwt.user.client.ui.HasDirectionalText

setValue

public void setValue(Boolean value)

Checks or unchecks the check box.

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)

Specified by:

setValue in interface com.google.gwt.user.client.TakesValue<Boolean>

Specified by:

setValue in interface com.google.gwt.user.client.ui.HasValue<Boolean>

Parameters:

value - true to check, false to uncheck; null value implies false

setValue

public void setValue(Boolean value,
            boolean fireEvents)

Checks or unchecks the check box, firing 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)

Specified by:

setValue in interface com.google.gwt.user.client.ui.HasValue<Boolean>

Parameters:

value - true to check, false to uncheck; null value implies false

fireEvents - If true, and value has changed, fire a ValueChangeEvent

setWordWrap

public void setWordWrap(boolean wrap)

Specified by:

setWordWrap in interface com.google.gwt.user.client.ui.HasWordWrap

upgrade

public void upgrade()

Description copied from interface: IUpgrade

Causes the component to be upgraded.

Specified by:

upgrade in interface IUpgrade

isUpgraded

public boolean isUpgraded()

Specified by:

isUpgraded in interface IUpgrade

Returns:

the upgrade state of the component

ensureDomEventHandlers

protected void ensureDomEventHandlers()

onEnsureDebugId

protected void onEnsureDebugId(String baseID)

Affected Elements:

• -label = label next to checkbox.

Overrides:

onEnsureDebugId in class com.google.gwt.user.client.ui.UIObject

See Also:

UIObject.onEnsureDebugId(String)

onLoad

protected void onLoad()

This method is called when a widget is attached to the browser's document. onAttach needs special handling for the CheckBox case. Must still call Widget.onAttach() to preserve the onAttach contract.

Overrides:

onLoad in class com.google.gwt.user.client.ui.Widget

onUnload

protected void onUnload()

This method is called when a widget is detached from the browser's document. Overridden because of IE bug that throws away checked state and in order to clear the event listener off of the inputElem.

Overrides:

onUnload in class com.google.gwt.user.client.ui.Widget

replaceInputElement

protected void replaceInputElement(com.google.gwt.dom.client.Element elem)

Replace the current input element with a new one. Preserves all state except for the name property, for nasty reasons related to radio button grouping. (See implementation of RadioButton.setName(java.lang.String).)

Parameters:

elem - the new input element

replaceInputElement

@Deprecated
protected void replaceInputElement(com.google.gwt.user.client.Element elem)

Deprecated. Call and use replaceInputElement(Element) instead.

Parameters:

elem - the new element that will replace the current element

getToggle

protected ToggleStyleOperator<T> getToggle()

Returns:

retrieve the flavor switch manager

getContainer

protected com.google.gwt.dom.client.LabelElement getContainer()

Returns:

the top level container element

getInput

protected com.google.gwt.dom.client.InputElement getInput()

Returns:

the toggle input element

getLabel

protected com.google.gwt.dom.client.SpanElement getLabel()

Returns:

the label element