gwt.material.design.addins.client.stepper

Class MaterialStepper

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.addins.client.stepper.MaterialStepper

All Implemented Interfaces:

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.SelectionHandler<MaterialStep>, com.google.gwt.event.shared.EventHandler, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.Focusable, com.google.gwt.user.client.ui.HasEnabled, 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, com.google.gwt.view.client.SelectionChangeEvent.HasSelectionChangedHandlers, HasStepsHandler, gwt.material.design.client.base.HasAllDragAndDropHandlers, gwt.material.design.client.base.HasAxis, gwt.material.design.client.base.HasBorder, gwt.material.design.client.base.HasCenterOn, gwt.material.design.client.base.HasCircle, gwt.material.design.client.base.HasColors, gwt.material.design.client.base.HasDataAttributes, gwt.material.design.client.base.HasDepth, gwt.material.design.client.base.HasDimension, gwt.material.design.client.base.HasDraggableHandlers, gwt.material.design.client.base.HasDroppableHandlers, gwt.material.design.client.base.HasError, gwt.material.design.client.base.HasFlexbox, gwt.material.design.client.base.HasFloat, gwt.material.design.client.base.HasFontSize, gwt.material.design.client.base.HasFontWeight, gwt.material.design.client.base.HasGrid, gwt.material.design.client.base.HasHideOn, gwt.material.design.client.base.HasHoverable, gwt.material.design.client.base.HasId, gwt.material.design.client.base.HasInitialClasses, gwt.material.design.client.base.HasInlineStyle, gwt.material.design.client.base.HasInteractionHandlers, gwt.material.design.client.base.HasOpacity, gwt.material.design.client.base.HasOrientation, gwt.material.design.client.base.HasOrientationChangeHandler, gwt.material.design.client.base.HasScrollspy, gwt.material.design.client.base.HasSeparator, gwt.material.design.client.base.HasShadow, gwt.material.design.client.base.HasShowOn, gwt.material.design.client.base.HasTextAlign, gwt.material.design.client.base.HasTooltip, gwt.material.design.client.base.HasTransform, gwt.material.design.client.base.HasVerticalAlign, gwt.material.design.client.base.HasWaves, Iterable<com.google.gwt.user.client.ui.Widget>

public class MaterialStepper
extends gwt.material.design.client.base.MaterialWidget
implements gwt.material.design.client.base.HasAxis, gwt.material.design.client.base.HasError, com.google.gwt.event.logical.shared.SelectionHandler<MaterialStep>, com.google.gwt.view.client.SelectionChangeEvent.HasSelectionChangedHandlers, HasStepsHandler

Steppers convey progress through numbered steps. They may also be used for navigation.

XML Namespace Declaration

 
 xmlns:ma='urn:import:gwt.material.design.addins.client'
 
 

UiBinder Usage:

 
  <ma:stepper.MaterialStepper ui:field="stepper">
      <ma:stepper.MaterialStep step="1" title="Name of Step 1">
          <m:MaterialPanel width="100%" height="300px" backgroundColor="grey lighten-2"/>
          <m:MaterialButton ui:field="btnContinue1" text="Continue to Step 2" grid="l4" marginTop="12" backgroundColor="blue" textColor="white" waves="DEFAULT"/>
          <m:MaterialButton ui:field="btnPrev1" text="Cancel" grid="l4" marginTop="12" type="FLAT" waves="DEFAULT"/>
      </ma:stepper.MaterialStep>
      &lt;!-- Other Step components here -->
  </ma:stepper.MaterialStepper>
 
 

Author:

kevzlou7979

See Also:

Material Steppers, Material Design Specification

Nested Class Summary

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

gwt.material.design.client.base.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.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
MaterialStepper()

Method Summary

Modifier and Type	Method and Description
void	add(MaterialStep step) Specific method to add MaterialSteps to the stepper.
com.google.gwt.event.shared.HandlerRegistration	addCompleteHandler(CompleteEvent.CompleteHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addNextHandler(NextEvent.NextHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addPreviousHandler(PreviousEvent.PreviousHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addSelectionChangeHandler(com.google.gwt.view.client.SelectionChangeEvent.Handler handler)
com.google.gwt.event.shared.HandlerRegistration	addStartHandler(StartEvent.StartHandler handler)
void	clearErrorOrSuccess()
protected void	detectAndApplyOrientation()
gwt.material.design.client.constants.Axis	getAxis()
protected gwt.material.design.client.base.mixin.CssNameMixin<MaterialStepper,gwt.material.design.client.constants.Axis>	getAxisMixin()
MaterialStep	getCurrentStep() Gets the current step component.
int	getCurrentStepIndex()
String	getFeedback() Get feedback message.
gwt.material.design.client.ui.html.Span	getFeedbackSpan()
void	goToStep(int step) Go to specific step manually by setting which step index you want to go.
void	goToStep(MaterialStep step) Go to the specfic MaterialStep.
void	goToStepId(int id) Go to the step with the specified step id.
void	hideFeedback() Hide feedback message and circular loader on body container.
boolean	isDetectOrientation()
boolean	isStepSkippingAllowed() Returns whether the user is allowed to skip steps by clicking on the step title.
void	nextStep() Go to next step, used by linear stepper.
protected void	onLoad()
void	onSelection(com.google.gwt.event.logical.shared.SelectionEvent<MaterialStep> event) Called when a step title is clicked.
void	prevStep() Go to previous step , used by linear stepper.
void	reset() Reset the Stepper to initial step (first step).
void	setAxis(gwt.material.design.client.constants.Axis axis)
protected void	setCurrentStepIndex(int currentStepIndex) Called internally when the index is changed.
void	setDetectOrientation(boolean detectOrientation)
void	setError(String error)
void	setHelperText(String helperText)
void	setStepSkippingAllowed(boolean stepSkippingAllowed) Sets whether the user is allowed to skip steps by clicking on the step title.
void	setSuccess(String success)
void	showFeedback(String feedbackText) Show feedback message and circular loader on body container

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, isEnabled, isFeatureEnabled, isHoverable, isSeparator, isTruncate, onUnload, registerHandler, removeHandler, setAccessKey, setBackfaceVisibility, setBackgroundColor, setBorder, setBorderBottom, setBorderLeft, setBorderRadius, setBorderRight, setBorderTop, setBottom, setCenterOn, setCircle, setClass, setDataAttribute, setDepth, setDisplay, setEnabled, 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, validate, 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

MaterialStepper

public MaterialStepper()

Method Detail

onLoad

protected void onLoad()

Overrides:

onLoad in class gwt.material.design.client.base.MaterialWidget

setDetectOrientation

public void setDetectOrientation(boolean detectOrientation)

Specified by:

setDetectOrientation in interface gwt.material.design.client.base.HasOrientation

Overrides:

setDetectOrientation in class gwt.material.design.client.base.MaterialWidget

detectAndApplyOrientation

protected void detectAndApplyOrientation()

isDetectOrientation

public boolean isDetectOrientation()

Specified by:

isDetectOrientation in interface gwt.material.design.client.base.HasOrientation

Overrides:

isDetectOrientation in class gwt.material.design.client.base.MaterialWidget

add

public void add(MaterialStep step)

Specific method to add MaterialSteps to the stepper.

nextStep

public void nextStep()

Go to next step, used by linear stepper.

prevStep

public void prevStep()

Go to previous step , used by linear stepper.

goToStep

public void goToStep(int step)

Go to specific step manually by setting which step index you want to go.

goToStep

public void goToStep(MaterialStep step)

Go to the specfic MaterialStep.

goToStepId

public void goToStepId(int id)

Go to the step with the specified step id.

See Also:

MaterialStep.getStep()

reset

public void reset()

Reset the Stepper to initial step (first step).

setCurrentStepIndex

protected void setCurrentStepIndex(int currentStepIndex)

Called internally when the index is changed. Fires a SelectionChangeEvent when the current index changes.

getCurrentStepIndex

public int getCurrentStepIndex()

setAxis

public void setAxis(gwt.material.design.client.constants.Axis axis)

Specified by:

setAxis in interface gwt.material.design.client.base.HasAxis

getAxis

public gwt.material.design.client.constants.Axis getAxis()

Specified by:

getAxis in interface gwt.material.design.client.base.HasAxis

getCurrentStep

public MaterialStep getCurrentStep()

Gets the current step component.

setError

public void setError(String error)

Specified by:

setError in interface gwt.material.design.client.base.HasError

setSuccess

public void setSuccess(String success)

Specified by:

setSuccess in interface gwt.material.design.client.base.HasError

setHelperText

public void setHelperText(String helperText)

Specified by:

setHelperText in interface gwt.material.design.client.base.HasError

clearErrorOrSuccess

public void clearErrorOrSuccess()

Specified by:

clearErrorOrSuccess in interface gwt.material.design.client.base.HasError

getFeedback

public String getFeedback()

Get feedback message.

showFeedback

public void showFeedback(String feedbackText)

Show feedback message and circular loader on body container

hideFeedback

public void hideFeedback()

Hide feedback message and circular loader on body container.

setStepSkippingAllowed

public void setStepSkippingAllowed(boolean stepSkippingAllowed)

Sets whether the user is allowed to skip steps by clicking on the step title. The default is true.

isStepSkippingAllowed

public boolean isStepSkippingAllowed()

Returns whether the user is allowed to skip steps by clicking on the step title. The default is true.

getFeedbackSpan

public gwt.material.design.client.ui.html.Span getFeedbackSpan()

onSelection

public void onSelection(com.google.gwt.event.logical.shared.SelectionEvent<MaterialStep> event)

Called when a step title is clicked.

Specified by:

onSelection in interface com.google.gwt.event.logical.shared.SelectionHandler<MaterialStep>

addSelectionChangeHandler

public com.google.gwt.event.shared.HandlerRegistration addSelectionChangeHandler(com.google.gwt.view.client.SelectionChangeEvent.Handler handler)

Specified by:

addSelectionChangeHandler in interface com.google.gwt.view.client.SelectionChangeEvent.HasSelectionChangedHandlers

addStartHandler

public com.google.gwt.event.shared.HandlerRegistration addStartHandler(StartEvent.StartHandler handler)

Specified by:

addStartHandler in interface HasStepsHandler

addCompleteHandler

public com.google.gwt.event.shared.HandlerRegistration addCompleteHandler(CompleteEvent.CompleteHandler handler)

Specified by:

addCompleteHandler in interface HasStepsHandler

addNextHandler

public com.google.gwt.event.shared.HandlerRegistration addNextHandler(NextEvent.NextHandler handler)

Specified by:

addNextHandler in interface HasStepsHandler

addPreviousHandler

public com.google.gwt.event.shared.HandlerRegistration addPreviousHandler(PreviousEvent.PreviousHandler handler)

Specified by:

addPreviousHandler in interface HasStepsHandler

getAxisMixin

protected gwt.material.design.client.base.mixin.CssNameMixin<MaterialStepper,gwt.material.design.client.constants.Axis> getAxisMixin()