gwt.material.design.client.ui

Class MaterialSwitch

java.lang.Object

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

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

com.google.gwt.user.client.ui.Panel

com.google.gwt.user.client.ui.ComplexPanel

gwt.material.design.client.base.MaterialWidget

gwt.material.design.client.base.AbstractValueWidget<Boolean>

gwt.material.design.client.ui.MaterialSwitch

All Implemented Interfaces:

com.google.gwt.editor.client.Editor<Boolean>, com.google.gwt.editor.client.HasEditorErrors<Boolean>, com.google.gwt.editor.client.LeafValueEditor<Boolean>, 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.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.user.client.EventListener, com.google.gwt.user.client.TakesValue<Boolean>, com.google.gwt.user.client.ui.Focusable, com.google.gwt.user.client.ui.HasEnabled, com.google.gwt.user.client.ui.HasValue<Boolean>, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.HasWidgets, com.google.gwt.user.client.ui.HasWidgets.ForIsWidget, com.google.gwt.user.client.ui.IndexedPanel, com.google.gwt.user.client.ui.IndexedPanel.ForIsWidget, com.google.gwt.user.client.ui.IsWidget, HasErrorHandler, HasAllDragAndDropHandlers, HasBorder, HasCenterOn, HasCircle, HasColors, HasDataAttributes, HasDepth, HasDimension, HasDraggableHandlers, HasDroppableHandlers, HasError, HasFlexbox, HasFloat, HasFontSize, HasFontWeight, HasGrid, HasHideOn, HasHoverable, HasId, HasInitialClasses, HasInlineStyle, HasInteractionHandlers, HasOpacity, HasOrientation, HasOrientationChangeHandler, HasScrollspy, HasSeparator, HasShadow, HasShowOn, HasTextAlign, HasTooltip, HasTransform, HasVerticalAlign, HasWaves, HasValidators<Boolean>, ValidationChangedEvent.HasValidationChangedHandlers, Iterable<com.google.gwt.user.client.ui.Widget>

public class MaterialSwitch
extends AbstractValueWidget<Boolean>
implements com.google.gwt.user.client.ui.HasValue<Boolean>

Material Switch or other call it toggle - used for an alternative for checkbox

UiBinder Usage:

  <m:MaterialSwitch value="true"/>
 <m:MaterialSwitch value="true" disabled="true"/>
 
 

Author:

kevzlou7979

See Also:

Material Switch, Material Design Specification

Nested Class Summary

Nested classes/interfaces inherited from class gwt.material.design.client.base.MaterialWidget

MaterialWidget.Feature

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

Nested classes/interfaces inherited from interface com.google.gwt.editor.client.Editor

com.google.gwt.editor.client.Editor.Ignore, com.google.gwt.editor.client.Editor.Path

Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.IndexedPanel

com.google.gwt.user.client.ui.IndexedPanel.ForIsWidget

Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.HasWidgets

com.google.gwt.user.client.ui.HasWidgets.ForIsWidget

Field Summary

Fields inherited from class gwt.material.design.client.base.MaterialWidget

$this

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

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
MaterialSwitch() Creates a switch element
MaterialSwitch(boolean value) Creates a material switch with default value.
MaterialSwitch(String onLabel, String offLabel)
MaterialSwitch(String onLabel, String offLabel, Boolean value)

Method Summary

Modifier and Type	Method and Description
com.google.gwt.event.shared.HandlerRegistration	addValueChangeHandler(com.google.gwt.event.logical.shared.ValueChangeHandler<Boolean> handler)
void	clearErrorOrSuccess() Clear the error or success states.
MaterialLabel	getErrorLabel()
protected ErrorMixin<AbstractValueWidget,MaterialLabel>	getErrorMixin()
MaterialInput	getInput()
Label	getLabel()
Span	getOffLabel()
Span	getOnLabel()
Span	getSpan()
Boolean	getValue() Gets the value of switch component.
protected void	onLoad()
void	setEnabled(boolean enabled)
void	setError(String error) Errors occur when an app fails to complete what is expected, such as: - The app does not understand user input - The system or app fails - A user intends to run incompatible operations concurrently
void	setHelperText(String helperText) Apply a widgets help text.
void	setInput(MaterialInput input)
void	setLabel(Label label) Deprecated.
void	setOffLabel(String label) Set the Off State Label of the switch component
void	setOnLabel(String label) Set the On State Label of the switch component
void	setSpan(Span span)
void	setSuccess(String success) Set the success message marking a widget as success.
void	setValue(Boolean value)
void	setValue(Boolean value, boolean fireEvents) Set the value of switch component.

Methods inherited from class gwt.material.design.client.base.AbstractValueWidget

addValidationChangedHandler, addValidator, createBlankValidator, getErrorHandler, getErrorHandlerMixin, getErrorHandlerType, getValidatorMixin, isAllowBlank, isValidateOnBlur, removeValidator, reset, setAllowBlank, setErrorHandler, setErrorHandlerType, setupBlurValidation, setValidateOnBlur, setValidators, setValue, showErrors, validate, validate

Methods inherited from class gwt.material.design.client.base.MaterialWidget

$this, add, add, addAttachHandler, addBlurHandler, addClickHandler, addDoubleClickHandler, addDragEndHandler, addDragEnterHandler, addDragLeaveHandler, addDragMoveHandler, addDragOverHandler, addDragStartHandler, addDropActivateHandler, addDropDeactivateHandler, addDropHandler, addFocusHandler, addGestureChangeHandler, addGestureEndHandler, addGestureStartHandler, addKeyDownHandler, addKeyPressHandler, addKeyUpHandler, addMouseDownHandler, addMouseMoveHandler, addMouseOutHandler, addMouseOverHandler, addMouseUpHandler, addMouseWheelHandler, addOrientationChangeHandler, addTouchCancelHandler, addTouchEndHandler, addTouchMoveHandler, addTouchStartHandler, body, clearActiveClass, enableFeature, getBackfaceVisibility, getBackgroundColor, getBorder, getBorderBottom, getBorderLeft, getBorderMixin, getBorderRadius, getBorderRight, getBorderTop, getCenterOn, getCenterOnMixin, getChildren, getChildrenList, getCircleMixin, getColorsMixin, getDataAttribute, getDepth, getDimensionMixin, getEnabledMixin, getFlexboxMixin, getFloat, getFloatMixin, getFocusableMixin, getFontSize, getFontSizeMixin, getFontWeight, getFontWeightMixin, getGridMixin, getHandlerRegistry, getHideOn, getHideOnMixin, getHoverableMixin, getId, getIdMixin, getInitialClasses, getLayoutPosition, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOpacity, getOrientation, getOrientationMixin, getPerspective, getPerspectiveOrigin, getScrollspy, getScrollspyMixin, getSeparatorMixin, getShadow, getShadowMixin, getShowOn, getShowOnMixin, getTabIndex, getTextAlign, getTextAlignMixin, getTextColor, getTooltip, getTooltipDelayMs, getTooltipHTML, getTooltipMixin, getTooltipPosition, getTransform, getTransformMixin, getTransformOrigin, getTransformStyle, getTruncateMixin, getVerticalAlign, getVerticalAlignMixin, getWaves, getWavesMixin, getWidth, insert, insert, isCircle, isDetectOrientation, isEnabled, isFeatureEnabled, isHoverable, isSeparator, isTruncate, onUnload, registerHandler, removeHandler, setAccessKey, setBackfaceVisibility, setBackgroundColor, setBorder, setBorderBottom, setBorderLeft, setBorderRadius, setBorderRight, setBorderTop, setBottom, setCenterOn, setCircle, setClass, setDataAttribute, setDepth, setDetectOrientation, setDisplay, setFlex, setFlexAlignContent, setFlexAlignItems, setFlexAlignSelf, setFlexBasis, setFlexDirection, setFlexGrow, setFlexJustifyContent, setFlexOrder, setFlexShrink, setFlexWrap, setFloat, setFocus, setFontSize, setFontSize, setFontWeight, setGrid, setGwtDisplay, setHideOn, setHoverable, setId, setInitialClasses, setLayoutPosition, setLeft, setLineHeight, setMargin, setMarginBottom, setMarginLeft, setMarginRight, setMarginTop, setMaxHeight, setMaxWidth, setMinHeight, setMinWidth, setOffset, setOpacity, setOrientation, setOverflow, setPadding, setPaddingBottom, setPaddingLeft, setPaddingRight, setPaddingTop, setPerspective, setPerspectiveOrigin, setRight, setScrollspy, setSeparator, setShadow, setShowOn, setStyle, setTabIndex, setTextAlign, setTextColor, setTooltip, setTooltipDelayMs, setTooltipHTML, setTooltipPosition, setTop, setTransform, setTransformOrigin, setTransformStyle, setTransition, setTruncate, setVerticalAlign, setVisibility, setWaves, stopTouchStartEvent, window

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

add, adjustIndex, checkIndexBoundsForAccess, checkIndexBoundsForInsertion, getWidget, getWidgetCount, getWidgetIndex, getWidgetIndex, insert, iterator, remove, remove

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

add, adopt, clear, doAttachChildren, doDetachChildren, orphan, remove

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

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, 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, onEnsureDebugId, 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 gwt.material.design.client.base.HasFlexbox

setVisible

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

MaterialSwitch

public MaterialSwitch()

Creates a switch element

MaterialSwitch

public MaterialSwitch(String onLabel,
                      String offLabel)

MaterialSwitch

public MaterialSwitch(String onLabel,
                      String offLabel,
                      Boolean value)

MaterialSwitch

public MaterialSwitch(boolean value)

Creates a material switch with default value.

Method Detail

onLoad

protected void onLoad()

Overrides:

onLoad in class MaterialWidget

setEnabled

public void setEnabled(boolean enabled)

Specified by:

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

Overrides:

setEnabled in class MaterialWidget

setValue

public void setValue(Boolean value,
                     boolean fireEvents)

Set the value of switch component.

Specified by:

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

Overrides:

setValue in class AbstractValueWidget<Boolean>

setValue

public void setValue(Boolean value)

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>

Overrides:

setValue in class AbstractValueWidget<Boolean>

getValue

public Boolean getValue()

Gets the value of switch component.

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>

getInput

public MaterialInput getInput()

Returns:

the input

setInput

public void setInput(MaterialInput input)

Parameters:

input - the input to set

getSpan

public Span getSpan()

Returns:

the span

setSpan

public void setSpan(Span span)

Parameters:

span - the span to set

getLabel

public Label getLabel()

Returns:

the label

setLabel

@Deprecated
public void setLabel(Label label)

Deprecated.

Parameters:

label - the label to set

setError

public void setError(String error)

Description copied from interface: HasError

Errors occur when an app fails to complete what is expected, such as: - The app does not understand user input - The system or app fails - A user intends to run incompatible operations concurrently

Specified by:

setError in interface HasError

Overrides:

setError in class AbstractValueWidget<Boolean>

setSuccess

public void setSuccess(String success)

Description copied from interface: HasError

Set the success message marking a widget as success.

Specified by:

setSuccess in interface HasError

Overrides:

setSuccess in class AbstractValueWidget<Boolean>

setHelperText

public void setHelperText(String helperText)

Description copied from interface: HasError

Apply a widgets help text.

Specified by:

setHelperText in interface HasError

Overrides:

setHelperText in class AbstractValueWidget<Boolean>

clearErrorOrSuccess

public void clearErrorOrSuccess()

Description copied from interface: HasError

Clear the error or success states.

Specified by:

clearErrorOrSuccess in interface HasError

Overrides:

clearErrorOrSuccess in class AbstractValueWidget<Boolean>

setOnLabel

public void setOnLabel(String label)

Set the On State Label of the switch component

setOffLabel

public void setOffLabel(String label)

Set the Off State Label of the switch component

getErrorLabel

public MaterialLabel getErrorLabel()

getOnLabel

public Span getOnLabel()

getOffLabel

public Span getOffLabel()

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>

Overrides:

addValueChangeHandler in class AbstractValueWidget<Boolean>

getErrorMixin

protected ErrorMixin<AbstractValueWidget,MaterialLabel> getErrorMixin()

Overrides:

getErrorMixin in class AbstractValueWidget<Boolean>