StepperLayout (material-stepper 4.3.1 API)

java.lang.Object
- android.view.View
- - android.view.ViewGroup
  - - android.widget.LinearLayout
    - - com.stepstone.stepper.StepperLayout

All Implemented Interfaces:

android.graphics.drawable.Drawable.Callback, android.view.accessibility.AccessibilityEventSource, android.view.KeyEvent.Callback, android.view.ViewManager, android.view.ViewParent, TabsContainer.TabItemListener
```
public class StepperLayout
extends android.widget.LinearLayout
implements TabsContainer.TabItemListener
```
Stepper widget implemented according to the Material documentation.
It allows for setting three types of steppers:
- mobile dots stepper,
- mobile progress bar stepper,
- horizontal stepper with tabs.
Include this stepper in the layout XML file and choose a stepper type with ms_stepperType.
Check out values/attrs.xml - StepperLayout for a complete list of customisable properties.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`class`	`StepperLayout.AbstractOnButtonClickedCallback`
`class`	`StepperLayout.OnBackClickedCallback`
`class`	`StepperLayout.OnCompleteClickedCallback`
`class`	`StepperLayout.OnNextClickedCallback`
`static interface`	`StepperLayout.StepperListener` A listener for events of `StepperLayout`.

Nested classes/interfaces inherited from class android.widget.LinearLayout
android.widget.LinearLayout.LayoutParams

Nested classes/interfaces inherited from class android.view.ViewGroup
android.view.ViewGroup.MarginLayoutParams, android.view.ViewGroup.OnHierarchyChangeListener

Nested classes/interfaces inherited from class android.view.View
android.view.View.AccessibilityDelegate, android.view.View.BaseSavedState, android.view.View.DragShadowBuilder, android.view.View.MeasureSpec, android.view.View.OnApplyWindowInsetsListener, android.view.View.OnAttachStateChangeListener, android.view.View.OnClickListener, android.view.View.OnContextClickListener, android.view.View.OnCreateContextMenuListener, android.view.View.OnDragListener, android.view.View.OnFocusChangeListener, android.view.View.OnGenericMotionListener, android.view.View.OnHoverListener, android.view.View.OnKeyListener, android.view.View.OnLayoutChangeListener, android.view.View.OnLongClickListener, android.view.View.OnScrollChangeListener, android.view.View.OnSystemUiVisibilityChangeListener, android.view.View.OnTouchListener

Field Summary

Fields
Modifier and Type Field and Description

static int DEFAULT_TAB_DIVIDER_WIDTH
- Fields inherited from class android.widget.LinearLayout
  HORIZONTAL, SHOW_DIVIDER_BEGINNING, SHOW_DIVIDER_END, SHOW_DIVIDER_MIDDLE, SHOW_DIVIDER_NONE, VERTICAL
- Fields inherited from class android.view.ViewGroup
  CLIP_TO_PADDING_MASK, FOCUS_AFTER_DESCENDANTS, FOCUS_BEFORE_DESCENDANTS, FOCUS_BLOCK_DESCENDANTS, LAYOUT_MODE_CLIP_BOUNDS, LAYOUT_MODE_OPTICAL_BOUNDS, PERSISTENT_ALL_CACHES, PERSISTENT_ANIMATION_CACHE, PERSISTENT_NO_CACHE, PERSISTENT_SCROLLING_CACHE
- Fields inherited from class android.view.View
  ACCESSIBILITY_LIVE_REGION_ASSERTIVE, ACCESSIBILITY_LIVE_REGION_NONE, ACCESSIBILITY_LIVE_REGION_POLITE, ALPHA, DRAG_FLAG_GLOBAL, DRAG_FLAG_GLOBAL_PERSISTABLE_URI_PERMISSION, DRAG_FLAG_GLOBAL_PREFIX_URI_PERMISSION, DRAG_FLAG_GLOBAL_URI_READ, DRAG_FLAG_GLOBAL_URI_WRITE, DRAG_FLAG_OPAQUE, DRAWING_CACHE_QUALITY_AUTO, DRAWING_CACHE_QUALITY_HIGH, DRAWING_CACHE_QUALITY_LOW, EMPTY_STATE_SET, ENABLED_FOCUSED_SELECTED_STATE_SET, ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET, ENABLED_FOCUSED_STATE_SET, ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET, ENABLED_SELECTED_STATE_SET, ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET, ENABLED_STATE_SET, ENABLED_WINDOW_FOCUSED_STATE_SET, FIND_VIEWS_WITH_CONTENT_DESCRIPTION, FIND_VIEWS_WITH_TEXT, FOCUS_BACKWARD, FOCUS_DOWN, FOCUS_FORWARD, FOCUS_LEFT, FOCUS_RIGHT, FOCUS_UP, FOCUSABLES_ALL, FOCUSABLES_TOUCH_MODE, FOCUSED_SELECTED_STATE_SET, FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET, FOCUSED_STATE_SET, FOCUSED_WINDOW_FOCUSED_STATE_SET, GONE, HAPTIC_FEEDBACK_ENABLED, IMPORTANT_FOR_ACCESSIBILITY_AUTO, IMPORTANT_FOR_ACCESSIBILITY_NO, IMPORTANT_FOR_ACCESSIBILITY_NO_HIDE_DESCENDANTS, IMPORTANT_FOR_ACCESSIBILITY_YES, INVISIBLE, KEEP_SCREEN_ON, LAYER_TYPE_HARDWARE, LAYER_TYPE_NONE, LAYER_TYPE_SOFTWARE, LAYOUT_DIRECTION_INHERIT, LAYOUT_DIRECTION_LOCALE, LAYOUT_DIRECTION_LTR, LAYOUT_DIRECTION_RTL, MEASURED_HEIGHT_STATE_SHIFT, MEASURED_SIZE_MASK, MEASURED_STATE_MASK, MEASURED_STATE_TOO_SMALL, NO_ID, OVER_SCROLL_ALWAYS, OVER_SCROLL_IF_CONTENT_SCROLLS, OVER_SCROLL_NEVER, PRESSED_ENABLED_FOCUSED_SELECTED_STATE_SET, PRESSED_ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET, PRESSED_ENABLED_FOCUSED_STATE_SET, PRESSED_ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET, PRESSED_ENABLED_SELECTED_STATE_SET, PRESSED_ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET, PRESSED_ENABLED_STATE_SET, PRESSED_ENABLED_WINDOW_FOCUSED_STATE_SET, PRESSED_FOCUSED_SELECTED_STATE_SET, PRESSED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET, PRESSED_FOCUSED_STATE_SET, PRESSED_FOCUSED_WINDOW_FOCUSED_STATE_SET, PRESSED_SELECTED_STATE_SET, PRESSED_SELECTED_WINDOW_FOCUSED_STATE_SET, PRESSED_STATE_SET, PRESSED_WINDOW_FOCUSED_STATE_SET, ROTATION, ROTATION_X, ROTATION_Y, SCALE_X, SCALE_Y, SCREEN_STATE_OFF, SCREEN_STATE_ON, SCROLL_AXIS_HORIZONTAL, SCROLL_AXIS_NONE, SCROLL_AXIS_VERTICAL, SCROLL_INDICATOR_BOTTOM, SCROLL_INDICATOR_END, SCROLL_INDICATOR_LEFT, SCROLL_INDICATOR_RIGHT, SCROLL_INDICATOR_START, SCROLL_INDICATOR_TOP, SCROLLBAR_POSITION_DEFAULT, SCROLLBAR_POSITION_LEFT, SCROLLBAR_POSITION_RIGHT, SCROLLBARS_INSIDE_INSET, SCROLLBARS_INSIDE_OVERLAY, SCROLLBARS_OUTSIDE_INSET, SCROLLBARS_OUTSIDE_OVERLAY, SELECTED_STATE_SET, SELECTED_WINDOW_FOCUSED_STATE_SET, SOUND_EFFECTS_ENABLED, STATUS_BAR_HIDDEN, STATUS_BAR_VISIBLE, SYSTEM_UI_FLAG_FULLSCREEN, SYSTEM_UI_FLAG_HIDE_NAVIGATION, SYSTEM_UI_FLAG_IMMERSIVE, SYSTEM_UI_FLAG_IMMERSIVE_STICKY, SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN, SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION, SYSTEM_UI_FLAG_LAYOUT_STABLE, SYSTEM_UI_FLAG_LIGHT_STATUS_BAR, SYSTEM_UI_FLAG_LOW_PROFILE, SYSTEM_UI_FLAG_VISIBLE, SYSTEM_UI_LAYOUT_FLAGS, TEXT_ALIGNMENT_CENTER, TEXT_ALIGNMENT_GRAVITY, TEXT_ALIGNMENT_INHERIT, TEXT_ALIGNMENT_TEXT_END, TEXT_ALIGNMENT_TEXT_START, TEXT_ALIGNMENT_VIEW_END, TEXT_ALIGNMENT_VIEW_START, TEXT_DIRECTION_ANY_RTL, TEXT_DIRECTION_FIRST_STRONG, TEXT_DIRECTION_FIRST_STRONG_LTR, TEXT_DIRECTION_FIRST_STRONG_RTL, TEXT_DIRECTION_INHERIT, TEXT_DIRECTION_LOCALE, TEXT_DIRECTION_LTR, TEXT_DIRECTION_RTL, TRANSLATION_X, TRANSLATION_Y, TRANSLATION_Z, VIEW_LOG_TAG, VISIBLE, WINDOW_FOCUSED_STATE_SET, X, Y, Z
- Fields inherited from interface com.stepstone.stepper.internal.widget.TabsContainer.TabItemListener
  NULL

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_TAB_DIVIDER_WIDTH`

Constructor Summary

Constructors
Constructor and Description
`StepperLayout(android.content.Context context)`
`StepperLayout(android.content.Context context, android.util.AttributeSet attrs)`
`StepperLayout(android.content.Context context, android.util.AttributeSet attrs, int defStyleAttr)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`StepAdapter`	`getAdapter()` Getter for mStepAdapter
`float`	`getContentFadeAlpha()`
`int`	`getContentOverlayBackground()`
`int`	`getCurrentStepPosition()` Returns the position of the currently selected step.
`int`	`getErrorColor()`
`int`	`getSelectedColor()`
`int`	`getTabStepDividerWidth()`
`int`	`getUnselectedColor()`
`void`	`hideProgress()` Hides the progress indicator if visible.
`boolean`	`isInProgress()` Checks if there's an ongoing operation i.e.
`boolean`	`isShowErrorMessageEnabled()`
`boolean`	`isShowErrorStateEnabled()`
`boolean`	`isShowErrorStateOnBackEnabled()`
`boolean`	`isTabNavigationEnabled()`
`void`	`onBackClicked()` To be called when the user wants to go to the previous step.
`void`	`onTabClicked(int position)` Called when a tab gets clicked
`void`	`proceed()` This is an equivalent of clicking the Next/Complete button from the bottom navigation.
`void`	`setAdapter(StepAdapter stepAdapter)` Sets the new step adapter and updates the stepper layout based on the new adapter.
`void`	`setAdapter(StepAdapter stepAdapter, int currentStepPosition)` Sets the new step adapter and updates the stepper layout based on the new adapter.
`void`	`setBackButtonColor(android.content.res.ColorStateList newButtonColor)` Changes the text and compound drawable color of the Back bottom navigation button.
`void`	`setBackButtonColor(int newButtonColor)` Changes the text and compound drawable color of the Back bottom navigation button.
`void`	`setBackButtonEnabled(boolean enabled)` Sets whether the Back button in the bottom navigation bar should be enabled (clickable).
`void`	`setCompleteButtonColor(android.content.res.ColorStateList newButtonColor)` Changes the text and compound drawable color of the Complete bottom navigation button.
`void`	`setCompleteButtonColor(int newButtonColor)` Changes the text and compound drawable color of the Complete bottom navigation button.
`void`	`setCompleteButtonEnabled(boolean enabled)` Sets whether the Complete button in the bottom navigation bar should be enabled (clickable).
`void`	`setCompleteButtonVerificationFailed(boolean verificationFailed)` Sets whether the Complete button in the bottom navigation bar should be in the 'verification failed' state i.e.
`void`	`setCurrentStepPosition(int currentStepPosition)` Sets the current step to the one at the provided index.
`void`	`setFeedbackType(int feedbackTypeMask)` Sets the mask for the stepper feedback type.
`void`	`setListener(StepperLayout.StepperListener listener)`
`void`	`setNextButtonColor(android.content.res.ColorStateList newButtonColor)` Changes the text and compound drawable color of the Next bottom navigation button.
`void`	`setNextButtonColor(int newButtonColor)` Changes the text and compound drawable color of the Next bottom navigation button.
`void`	`setNextButtonEnabled(boolean enabled)` Sets whether the Next button in the bottom navigation bar should be enabled (clickable).
`void`	`setNextButtonVerificationFailed(boolean verificationFailed)` Sets whether the Next button in the bottom navigation bar should be in the 'verification failed' state i.e.
`void`	`setOffscreenPageLimit(int limit)` Set the number of steps that should be retained to either side of the current step in the view hierarchy in an idle state.
`void`	`setOrientation(int orientation)`
`void`	`setPageTransformer(android.support.v4.view.ViewPager.PageTransformer pageTransformer)` Overrides the default page transformer used in the underlying `StepViewPager`.
`void`	`setShowBottomNavigation(boolean showBottomNavigation)` Set whether the bottom navigation bar (with Back/Next/Complete buttons) should be visible.
`void`	`setShowErrorMessageEnabled(boolean showErrorMessageEnabled)` Set whether an error message below step title should appear when an error occurs
`void`	`setShowErrorState(boolean showErrorState)` Deprecated. see `setShowErrorStateEnabled(boolean)`
`void`	`setShowErrorStateEnabled(boolean showErrorStateEnabled)` Set whether the errors should be displayed when they occur or not.
`void`	`setShowErrorStateOnBack(boolean showErrorStateOnBack)` Deprecated. see `setShowErrorStateOnBackEnabled(boolean)`
`void`	`setShowErrorStateOnBackEnabled(boolean showErrorStateOnBackEnabled)` Set whether when going backwards should clear the error state from the Tab.
`void`	`setTabNavigationEnabled(boolean tabNavigationEnabled)` Sets whether step navigation is possible by clicking on the tabs directly.
`void`	`showProgress(java.lang.String progressMessage)` Shows a progress indicator if not already shown.
`void`	`updateErrorState(VerificationError error)` Updates the error state in the UI.

Methods inherited from class android.widget.LinearLayout
checkLayoutParams, generateDefaultLayoutParams, generateLayoutParams, generateLayoutParams, getAccessibilityClassName, getBaseline, getBaselineAlignedChildIndex, getDividerDrawable, getDividerPadding, getGravity, getOrientation, getShowDividers, getWeightSum, isBaselineAligned, isMeasureWithLargestChildEnabled, onDraw, onLayout, onMeasure, onRtlPropertiesChanged, setBaselineAligned, setBaselineAlignedChildIndex, setDividerDrawable, setDividerPadding, setGravity, setHorizontalGravity, setMeasureWithLargestChildEnabled, setShowDividers, setVerticalGravity, setWeightSum, shouldDelayChildPressedState

Methods inherited from class android.view.ViewGroup
addChildrenForAccessibility, addFocusables, addStatesFromChildren, addTouchables, addView, addView, addView, addView, addView, addViewInLayout, addViewInLayout, attachLayoutAnimationParameters, attachViewToParent, bringChildToFront, canAnimate, childDrawableStateChanged, childHasTransientStateChanged, cleanupLayoutState, clearChildFocus, clearDisappearingChildren, clearFocus, debug, detachAllViewsFromParent, detachViewFromParent, detachViewFromParent, detachViewsFromParent, dispatchApplyWindowInsets, dispatchConfigurationChanged, dispatchDisplayHint, dispatchDragEvent, dispatchDraw, dispatchDrawableHotspotChanged, dispatchFreezeSelfOnly, dispatchGenericFocusedEvent, dispatchGenericPointerEvent, dispatchHoverEvent, dispatchKeyEvent, dispatchKeyEventPreIme, dispatchKeyShortcutEvent, dispatchProvideStructure, dispatchRestoreInstanceState, dispatchSaveInstanceState, dispatchSetActivated, dispatchSetPressed, dispatchSetSelected, dispatchSystemUiVisibilityChanged, dispatchThawSelfOnly, dispatchTouchEvent, dispatchTrackballEvent, dispatchUnhandledMove, dispatchVisibilityChanged, dispatchWindowFocusChanged, dispatchWindowSystemUiVisiblityChanged, dispatchWindowVisibilityChanged, drawableStateChanged, drawChild, endViewTransition, findFocus, findViewsWithText, focusableViewAvailable, focusSearch, gatherTransparentRegion, getChildAt, getChildCount, getChildDrawingOrder, getChildMeasureSpec, getChildStaticTransformation, getChildVisibleRect, getClipChildren, getClipToPadding, getDescendantFocusability, getFocusedChild, getLayoutAnimation, getLayoutAnimationListener, getLayoutMode, getLayoutTransition, getNestedScrollAxes, getOverlay, getPersistentDrawingCache, getTouchscreenBlocksFocus, hasFocus, hasFocusable, hasTransientState, indexOfChild, invalidateChild, invalidateChildInParent, isAlwaysDrawnWithCacheEnabled, isAnimationCacheEnabled, isChildrenDrawingOrderEnabled, isChildrenDrawnWithCacheEnabled, isMotionEventSplittingEnabled, isTransitionGroup, jumpDrawablesToCurrentState, layout, measureChild, measureChildren, measureChildWithMargins, notifySubtreeAccessibilityStateChanged, offsetDescendantRectToMyCoords, offsetRectIntoDescendantCoords, onAttachedToWindow, onCreateDrawableState, onDetachedFromWindow, onInterceptHoverEvent, onInterceptTouchEvent, onNestedFling, onNestedPreFling, onNestedPrePerformAccessibilityAction, onNestedPreScroll, onNestedScroll, onNestedScrollAccepted, onRequestFocusInDescendants, onRequestSendAccessibilityEvent, onResolvePointerIcon, onStartNestedScroll, onStopNestedScroll, onViewAdded, onViewRemoved, recomputeViewAttributes, removeAllViews, removeAllViewsInLayout, removeDetachedView, removeView, removeViewAt, removeViewInLayout, removeViews, removeViewsInLayout, requestChildFocus, requestChildRectangleOnScreen, requestDisallowInterceptTouchEvent, requestFocus, requestSendAccessibilityEvent, requestTransparentRegion, scheduleLayoutAnimation, setAddStatesFromChildren, setAlwaysDrawnWithCacheEnabled, setAnimationCacheEnabled, setChildrenDrawingCacheEnabled, setChildrenDrawingOrderEnabled, setChildrenDrawnWithCacheEnabled, setClipChildren, setClipToPadding, setDescendantFocusability, setLayoutAnimation, setLayoutAnimationListener, setLayoutMode, setLayoutTransition, setMotionEventSplittingEnabled, setOnHierarchyChangeListener, setPersistentDrawingCache, setStaticTransformationsEnabled, setTouchscreenBlocksFocus, setTransitionGroup, showContextMenuForChild, showContextMenuForChild, startActionModeForChild, startActionModeForChild, startLayoutAnimation, startViewTransition, updateViewLayout

Methods inherited from class android.view.View
addFocusables, addOnAttachStateChangeListener, addOnLayoutChangeListener, animate, announceForAccessibility, awakenScrollBars, awakenScrollBars, awakenScrollBars, bringToFront, buildDrawingCache, buildDrawingCache, buildLayer, callOnClick, cancelDragAndDrop, cancelLongPress, cancelPendingInputEvents, canResolveLayoutDirection, canResolveTextAlignment, canResolveTextDirection, canScrollHorizontally, canScrollVertically, checkInputConnectionProxy, clearAnimation, combineMeasuredStates, computeHorizontalScrollExtent, computeHorizontalScrollOffset, computeHorizontalScrollRange, computeScroll, computeSystemWindowInsets, computeVerticalScrollExtent, computeVerticalScrollOffset, computeVerticalScrollRange, createAccessibilityNodeInfo, createContextMenu, destroyDrawingCache, dispatchFinishTemporaryDetach, dispatchGenericMotionEvent, dispatchNestedFling, dispatchNestedPreFling, dispatchNestedPrePerformAccessibilityAction, dispatchNestedPreScroll, dispatchNestedScroll, dispatchPopulateAccessibilityEvent, dispatchStartTemporaryDetach, draw, drawableHotspotChanged, findViewById, findViewWithTag, fitSystemWindows, focusSearch, forceHasOverlappingRendering, forceLayout, generateViewId, getAccessibilityLiveRegion, getAccessibilityNodeProvider, getAccessibilityTraversalAfter, getAccessibilityTraversalBefore, getAlpha, getAnimation, getApplicationWindowToken, getBackground, getBackgroundTintList, getBackgroundTintMode, getBottom, getBottomFadingEdgeStrength, getBottomPaddingOffset, getCameraDistance, getClipBounds, getClipBounds, getClipToOutline, getContentDescription, getContext, getContextMenuInfo, getDefaultSize, getDisplay, getDrawableState, getDrawingCache, getDrawingCache, getDrawingCacheBackgroundColor, getDrawingCacheQuality, getDrawingRect, getDrawingTime, getElevation, getFilterTouchesWhenObscured, getFitsSystemWindows, getFocusables, getFocusedRect, getForeground, getForegroundGravity, getForegroundTintList, getForegroundTintMode, getGlobalVisibleRect, getGlobalVisibleRect, getHandler, getHasOverlappingRendering, getHeight, getHitRect, getHorizontalFadingEdgeLength, getHorizontalScrollbarHeight, getId, getImportantForAccessibility, getKeepScreenOn, getKeyDispatcherState, getLabelFor, getLayerType, getLayoutDirection, getLayoutParams, getLeft, getLeftFadingEdgeStrength, getLeftPaddingOffset, getLocalVisibleRect, getLocationInWindow, getLocationOnScreen, getMatrix, getMeasuredHeight, getMeasuredHeightAndState, getMeasuredState, getMeasuredWidth, getMeasuredWidthAndState, getMinimumHeight, getMinimumWidth, getNextFocusDownId, getNextFocusForwardId, getNextFocusLeftId, getNextFocusRightId, getNextFocusUpId, getOnFocusChangeListener, getOutlineProvider, getOverScrollMode, getPaddingBottom, getPaddingEnd, getPaddingLeft, getPaddingRight, getPaddingStart, getPaddingTop, getParent, getParentForAccessibility, getPivotX, getPivotY, getPointerIcon, getResources, getRevealOnFocusHint, getRight, getRightFadingEdgeStrength, getRightPaddingOffset, getRootView, getRootWindowInsets, getRotation, getRotationX, getRotationY, getScaleX, getScaleY, getScrollBarDefaultDelayBeforeFade, getScrollBarFadeDuration, getScrollBarSize, getScrollBarStyle, getScrollIndicators, getScrollX, getScrollY, getSolidColor, getStateListAnimator, getSuggestedMinimumHeight, getSuggestedMinimumWidth, getSystemUiVisibility, getTag, getTag, getTextAlignment, getTextDirection, getTop, getTopFadingEdgeStrength, getTopPaddingOffset, getTouchables, getTouchDelegate, getTransitionName, getTranslationX, getTranslationY, getTranslationZ, getVerticalFadingEdgeLength, getVerticalScrollbarPosition, getVerticalScrollbarWidth, getViewTreeObserver, getVisibility, getWidth, getWindowAttachCount, getWindowId, getWindowSystemUiVisibility, getWindowToken, getWindowVisibility, getWindowVisibleDisplayFrame, getX, getY, getZ, hasNestedScrollingParent, hasOnClickListeners, hasOverlappingRendering, hasWindowFocus, inflate, invalidate, invalidate, invalidate, invalidateDrawable, invalidateOutline, isAccessibilityFocused, isActivated, isAttachedToWindow, isClickable, isContextClickable, isDirty, isDrawingCacheEnabled, isDuplicateParentStateEnabled, isEnabled, isFocusable, isFocusableInTouchMode, isFocused, isHapticFeedbackEnabled, isHardwareAccelerated, isHorizontalFadingEdgeEnabled, isHorizontalScrollBarEnabled, isHovered, isImportantForAccessibility, isInEditMode, isInLayout, isInTouchMode, isLaidOut, isLayoutDirectionResolved, isLayoutRequested, isLongClickable, isNestedScrollingEnabled, isOpaque, isPaddingOffsetRequired, isPaddingRelative, isPressed, isSaveEnabled, isSaveFromParentEnabled, isScrollbarFadingEnabled, isScrollContainer, isSelected, isShown, isSoundEffectsEnabled, isTemporarilyDetached, isTextAlignmentResolved, isTextDirectionResolved, isVerticalFadingEdgeEnabled, isVerticalScrollBarEnabled, measure, mergeDrawableStates, offsetLeftAndRight, offsetTopAndBottom, onAnimationEnd, onAnimationStart, onApplyWindowInsets, onCancelPendingInputEvents, onCheckIsTextEditor, onConfigurationChanged, onCreateContextMenu, onCreateInputConnection, onDisplayHint, onDragEvent, onDrawForeground, onDrawScrollBars, onFilterTouchEventForSecurity, onFinishInflate, onFinishTemporaryDetach, onFocusChanged, onGenericMotionEvent, onHoverChanged, onHoverEvent, onInitializeAccessibilityEvent, onInitializeAccessibilityNodeInfo, onKeyDown, onKeyLongPress, onKeyMultiple, onKeyPreIme, onKeyShortcut, onKeyUp, onOverScrolled, onPopulateAccessibilityEvent, onProvideStructure, onProvideVirtualStructure, onRestoreInstanceState, onSaveInstanceState, onScreenStateChanged, onScrollChanged, onSetAlpha, onSizeChanged, onStartTemporaryDetach, onTouchEvent, onTrackballEvent, onVisibilityAggregated, onVisibilityChanged, onWindowFocusChanged, onWindowSystemUiVisibilityChanged, onWindowVisibilityChanged, overScrollBy, performAccessibilityAction, performClick, performContextClick, performContextClick, performHapticFeedback, performHapticFeedback, performLongClick, performLongClick, playSoundEffect, post, postDelayed, postInvalidate, postInvalidate, postInvalidateDelayed, postInvalidateDelayed, postInvalidateOnAnimation, postInvalidateOnAnimation, postOnAnimation, postOnAnimationDelayed, refreshDrawableState, removeCallbacks, removeOnAttachStateChangeListener, removeOnLayoutChangeListener, requestApplyInsets, requestFitSystemWindows, requestFocus, requestFocus, requestFocusFromTouch, requestLayout, requestRectangleOnScreen, requestRectangleOnScreen, requestUnbufferedDispatch, resolveSize, resolveSizeAndState, restoreHierarchyState, saveHierarchyState, scheduleDrawable, scrollBy, scrollTo, sendAccessibilityEvent, sendAccessibilityEventUnchecked, setAccessibilityDelegate, setAccessibilityLiveRegion, setAccessibilityTraversalAfter, setAccessibilityTraversalBefore, setActivated, setAlpha, setAnimation, setBackground, setBackgroundColor, setBackgroundDrawable, setBackgroundResource, setBackgroundTintList, setBackgroundTintMode, setBottom, setCameraDistance, setClickable, setClipBounds, setClipToOutline, setContentDescription, setContextClickable, setDrawingCacheBackgroundColor, setDrawingCacheEnabled, setDrawingCacheQuality, setDuplicateParentStateEnabled, setElevation, setEnabled, setFadingEdgeLength, setFilterTouchesWhenObscured, setFitsSystemWindows, setFocusable, setFocusableInTouchMode, setForeground, setForegroundGravity, setForegroundTintList, setForegroundTintMode, setHapticFeedbackEnabled, setHasTransientState, setHorizontalFadingEdgeEnabled, setHorizontalScrollBarEnabled, setHovered, setId, setImportantForAccessibility, setKeepScreenOn, setLabelFor, setLayerPaint, setLayerType, setLayoutDirection, setLayoutParams, setLeft, setLongClickable, setMeasuredDimension, setMinimumHeight, setMinimumWidth, setNestedScrollingEnabled, setNextFocusDownId, setNextFocusForwardId, setNextFocusLeftId, setNextFocusRightId, setNextFocusUpId, setOnApplyWindowInsetsListener, setOnClickListener, setOnContextClickListener, setOnCreateContextMenuListener, setOnDragListener, setOnFocusChangeListener, setOnGenericMotionListener, setOnHoverListener, setOnKeyListener, setOnLongClickListener, setOnScrollChangeListener, setOnSystemUiVisibilityChangeListener, setOnTouchListener, setOutlineProvider, setOverScrollMode, setPadding, setPaddingRelative, setPivotX, setPivotY, setPointerIcon, setPressed, setRevealOnFocusHint, setRight, setRotation, setRotationX, setRotationY, setSaveEnabled, setSaveFromParentEnabled, setScaleX, setScaleY, setScrollBarDefaultDelayBeforeFade, setScrollBarFadeDuration, setScrollbarFadingEnabled, setScrollBarSize, setScrollBarStyle, setScrollContainer, setScrollIndicators, setScrollIndicators, setScrollX, setScrollY, setSelected, setSoundEffectsEnabled, setStateListAnimator, setSystemUiVisibility, setTag, setTag, setTextAlignment, setTextDirection, setTop, setTouchDelegate, setTransitionName, setTranslationX, setTranslationY, setTranslationZ, setVerticalFadingEdgeEnabled, setVerticalScrollBarEnabled, setVerticalScrollbarPosition, setVisibility, setWillNotCacheDrawing, setWillNotDraw, setX, setY, setZ, showContextMenu, showContextMenu, startActionMode, startActionMode, startAnimation, startDrag, startDragAndDrop, startNestedScroll, stopNestedScroll, toString, unscheduleDrawable, unscheduleDrawable, updateDragShadow, verifyDrawable, willNotCacheDrawing, willNotDraw

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface android.view.ViewParent
canResolveLayoutDirection, canResolveTextAlignment, canResolveTextDirection, createContextMenu, getLayoutDirection, getParent, getParentForAccessibility, getTextAlignment, getTextDirection, isLayoutDirectionResolved, isLayoutRequested, isTextAlignmentResolved, isTextDirectionResolved, requestFitSystemWindows, requestLayout

- Field Detail
  - DEFAULT_TAB_DIVIDER_WIDTH
```
public static final int DEFAULT_TAB_DIVIDER_WIDTH
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - StepperLayout
```
public StepperLayout(android.content.Context context)
```
  - StepperLayout
```
public StepperLayout(android.content.Context context,
                     android.util.AttributeSet attrs)
```
  - StepperLayout
```
public StepperLayout(android.content.Context context,
                     android.util.AttributeSet attrs,
                     int defStyleAttr)
```
- Method Detail
  - setOrientation
```
public final void setOrientation(int orientation)
```
    Overrides:
    
    setOrientation in class android.widget.LinearLayout
  - setListener
```
public void setListener(@NonNull
                        StepperLayout.StepperListener listener)
```
  - getAdapter
```
public StepAdapter getAdapter()
```
    Getter for mStepAdapter
    
    Returns:
    
    mStepAdapter
  - setAdapter
```
public void setAdapter(@NonNull
                       StepAdapter stepAdapter)
```
    Sets the new step adapter and updates the stepper layout based on the new adapter.
    
    Parameters:
    
    stepAdapter - step adapter
  - setAdapter
```
public void setAdapter(@NonNull
                       StepAdapter stepAdapter,
                       int currentStepPosition)
```
    Sets the new step adapter and updates the stepper layout based on the new adapter.
    
    Parameters:
    
    stepAdapter - step adapter
    
    currentStepPosition - the initial step position, must be in the range of the adapter item count
  - setPageTransformer
```
public void setPageTransformer(@Nullable
                               android.support.v4.view.ViewPager.PageTransformer pageTransformer)
```
    Overrides the default page transformer used in the underlying StepViewPager. If you're supporting RTL make sure your ViewPager.PageTransformer accounts for it.
    
    Parameters:
    
    pageTransformer - new page transformer
    
    See Also:
    
    StepViewPager, StepPageTransformerFactory
  - getSelectedColor
```
public int getSelectedColor()
```
  - getUnselectedColor
```
public int getUnselectedColor()
```
  - getErrorColor
```
public int getErrorColor()
```
  - getTabStepDividerWidth
```
public int getTabStepDividerWidth()
```
  - onTabClicked
```
@UiThread
public void onTabClicked(int position)
```
    Description copied from interface: TabsContainer.TabItemListener
    
    Called when a tab gets clicked
    
    Specified by:
    
    onTabClicked in interface TabsContainer.TabItemListener
    
    Parameters:
    
    position - position of the tab/step
  - proceed
```
public void proceed()
```
    This is an equivalent of clicking the Next/Complete button from the bottom navigation. Unlike setCurrentStepPosition(int) this actually verifies the step.
  - onBackClicked
```
public void onBackClicked()
```
    To be called when the user wants to go to the previous step.
  - setCurrentStepPosition
```
public void setCurrentStepPosition(int currentStepPosition)
```
    Sets the current step to the one at the provided index. This does not verify the current step.
    
    Parameters:
    
    currentStepPosition - new current step position
  - getCurrentStepPosition
```
public int getCurrentStepPosition()
```
    Returns the position of the currently selected step.
    
    Returns:
    
    position of the currently selected step
  - setNextButtonVerificationFailed
```
public void setNextButtonVerificationFailed(boolean verificationFailed)
```
    Sets whether the Next button in the bottom navigation bar should be in the 'verification failed' state i.e. still clickable but with an option to display it differently to indicate to the user that he cannot go to the next step yet.
    
    Parameters:
    
    verificationFailed - false if verification failed, true otherwise
  - setCompleteButtonVerificationFailed
```
public void setCompleteButtonVerificationFailed(boolean verificationFailed)
```
    Sets whether the Complete button in the bottom navigation bar should be in the 'verification failed' state i.e. still clickable but with an option to display it differently to indicate to the user that he cannot finish the process yet.
    
    Parameters:
    
    verificationFailed - false if verification failed, true otherwise
  - setNextButtonEnabled
```
public void setNextButtonEnabled(boolean enabled)
```
    Sets whether the Next button in the bottom navigation bar should be enabled (clickable). setting this to false will make it unclickable.
    
    Parameters:
    
    enabled - true if the button should be clickable, false otherwise
  - setCompleteButtonEnabled
```
public void setCompleteButtonEnabled(boolean enabled)
```
    Sets whether the Complete button in the bottom navigation bar should be enabled (clickable). setting this to false will make it unclickable.
    
    Parameters:
    
    enabled - true if the button should be clickable, false otherwise
  - setBackButtonEnabled
```
public void setBackButtonEnabled(boolean enabled)
```
    Sets whether the Back button in the bottom navigation bar should be enabled (clickable). setting this to false will make it unclickable.
    
    Parameters:
    
    enabled - true if the button should be clickable, false otherwise
  - setShowBottomNavigation
```
public void setShowBottomNavigation(boolean showBottomNavigation)
```
    Set whether the bottom navigation bar (with Back/Next/Complete buttons) should be visible. true by default.
    
    Parameters:
    
    showBottomNavigation - true if bottom navigation should be visible, false otherwise
  - setShowErrorStateOnBack
```
@Deprecated
public void setShowErrorStateOnBack(boolean showErrorStateOnBack)
```
    Deprecated. see setShowErrorStateOnBackEnabled(boolean)
    
    Set whether when going backwards should clear the error state from the Tab. Default is false.
    
    Parameters:
    
    showErrorStateOnBack - true if navigating backwards should keep the error state, false otherwise
  - setShowErrorStateOnBackEnabled
```
public void setShowErrorStateOnBackEnabled(boolean showErrorStateOnBackEnabled)
```
    Set whether when going backwards should clear the error state from the Tab. Default is false.
    
    Parameters:
    
    showErrorStateOnBackEnabled - true if navigating backwards should keep the error state, false otherwise
  - setShowErrorState
```
@Deprecated
public void setShowErrorState(boolean showErrorState)
```
    Deprecated. see setShowErrorStateEnabled(boolean)
    
    Set whether the errors should be displayed when they occur or not. Default is false.
    
    Parameters:
    
    showErrorState - true if the errors should be displayed when they occur, false otherwise
  - setShowErrorStateEnabled
```
public void setShowErrorStateEnabled(boolean showErrorStateEnabled)
```
    Set whether the errors should be displayed when they occur or not. Default is false.
    
    Parameters:
    
    showErrorStateEnabled - true if the errors should be displayed when they occur, false otherwise
  - isShowErrorStateEnabled
```
public boolean isShowErrorStateEnabled()
```
    Returns:
    
    true if errors should be displayed when they occur
  - isShowErrorStateOnBackEnabled
```
public boolean isShowErrorStateOnBackEnabled()
```
    Returns:
    
    true if when going backwards the error state from the Tab should be cleared
  - setShowErrorMessageEnabled
```
public void setShowErrorMessageEnabled(boolean showErrorMessageEnabled)
```
    Set whether an error message below step title should appear when an error occurs
    
    Parameters:
    
    showErrorMessageEnabled - true if an error message below step title should appear when an error occurs
  - isShowErrorMessageEnabled
```
public boolean isShowErrorMessageEnabled()
```
    Returns:
    
    true if an error message below step title should appear when an error occurs
  - isTabNavigationEnabled
```
public boolean isTabNavigationEnabled()
```
    Returns:
    
    true if step navigation is possible by clicking on the tabs directly, false otherwise
  - setTabNavigationEnabled
```
public void setTabNavigationEnabled(boolean tabNavigationEnabled)
```
    Sets whether step navigation is possible by clicking on the tabs directly. Only applicable for 'tabs' type.
    
    Parameters:
    
    tabNavigationEnabled - true if step navigation is possible by clicking on the tabs directly, false otherwise
  - setNextButtonColor
```
public void setNextButtonColor(@NonNull
                               android.content.res.ColorStateList newButtonColor)
```
    Changes the text and compound drawable color of the Next bottom navigation button.
    
    Parameters:
    
    newButtonColor - new color state list
  - setCompleteButtonColor
```
public void setCompleteButtonColor(@NonNull
                                   android.content.res.ColorStateList newButtonColor)
```
    Changes the text and compound drawable color of the Complete bottom navigation button.
    
    Parameters:
    
    newButtonColor - new color state list
  - setBackButtonColor
```
public void setBackButtonColor(@NonNull
                               android.content.res.ColorStateList newButtonColor)
```
    Changes the text and compound drawable color of the Back bottom navigation button.
    
    Parameters:
    
    newButtonColor - new color state list
  - setNextButtonColor
```
public void setNextButtonColor(int newButtonColor)
```
    Changes the text and compound drawable color of the Next bottom navigation button.
    
    Parameters:
    
    newButtonColor - new color int
  - setCompleteButtonColor
```
public void setCompleteButtonColor(int newButtonColor)
```
    Changes the text and compound drawable color of the Complete bottom navigation button.
    
    Parameters:
    
    newButtonColor - new color int
  - setBackButtonColor
```
public void setBackButtonColor(int newButtonColor)
```
    Changes the text and compound drawable color of the Back bottom navigation button.
    
    Parameters:
    
    newButtonColor - new color int
  - updateErrorState
```
public void updateErrorState(@Nullable
                             VerificationError error)
```
    Updates the error state in the UI. It does nothing if showing error state is disabled. This is used internally to show the error on tabs.
    
    Parameters:
    
    error - not null if error should be shown, null otherwise
    
    See Also:
    
    setShowErrorStateEnabled(boolean)
  - setOffscreenPageLimit
```
public void setOffscreenPageLimit(int limit)
```
    Set the number of steps that should be retained to either side of the current step in the view hierarchy in an idle state. Steps beyond this limit will be recreated from the adapter when needed.
    
    Parameters:
    
    limit - How many steps will be kept offscreen in an idle state.
    
    See Also:
    
    ViewPager.setOffscreenPageLimit(int)
  - showProgress
```
public void showProgress(@NonNull
                         java.lang.String progressMessage)
```
    Shows a progress indicator if not already shown. This does not have to be a progress bar and it depends on chosen stepper feedback types.
    
    Parameters:
    
    progressMessage - optional progress message if supported by the selected types
  - hideProgress
```
public void hideProgress()
```
    Hides the progress indicator if visible.
  - isInProgress
```
public boolean isInProgress()
```
    Checks if there's an ongoing operation i.e. if showProgress(String) was called and not followed by hideProgress() yet.
    
    Returns:
    
    true if in progress, false otherwise
  - setFeedbackType
```
public void setFeedbackType(int feedbackTypeMask)
```
    Sets the mask for the stepper feedback type.
    
    Parameters:
    
    feedbackTypeMask - step feedback type mask, should contain one or more flags from StepperFeedbackType
  - getContentFadeAlpha
```
public float getContentFadeAlpha()
```
    Returns:
    
    An alpha value from 0 to 1.0f to be used for the faded out view if 'content_fade' stepper feedback is set. 0.5f by default.
  - getContentOverlayBackground
```
@DrawableRes
public int getContentOverlayBackground()
```
    Returns:
    
    Background res ID to be used for the overlay on top of the content if 'content_overlay' stepper feedback type is set. 0 if default background should be used.

Class StepperLayout

Nested Class Summary

Nested classes/interfaces inherited from class android.widget.LinearLayout

Nested classes/interfaces inherited from class android.view.ViewGroup

Nested classes/interfaces inherited from class android.view.View

Field Summary

Fields inherited from class android.widget.LinearLayout

Fields inherited from class android.view.ViewGroup

Fields inherited from class android.view.View

Fields inherited from interface com.stepstone.stepper.internal.widget.TabsContainer.TabItemListener

Constructor Summary

Method Summary

Methods inherited from class android.widget.LinearLayout

Methods inherited from class android.view.ViewGroup

Methods inherited from class android.view.View

Methods inherited from class java.lang.Object

Methods inherited from interface android.view.ViewParent

Field Detail

DEFAULT_TAB_DIVIDER_WIDTH

Constructor Detail

StepperLayout

StepperLayout

StepperLayout

Method Detail

setOrientation

setListener

getAdapter

setAdapter

setAdapter

setPageTransformer

getSelectedColor

getUnselectedColor

getErrorColor

getTabStepDividerWidth

onTabClicked

proceed

onBackClicked

setCurrentStepPosition

getCurrentStepPosition

setNextButtonVerificationFailed

setCompleteButtonVerificationFailed

setNextButtonEnabled

setCompleteButtonEnabled

setBackButtonEnabled

setShowBottomNavigation

setShowErrorStateOnBack

setShowErrorStateOnBackEnabled

setShowErrorState

setShowErrorStateEnabled

isShowErrorStateEnabled

isShowErrorStateOnBackEnabled

setShowErrorMessageEnabled

isShowErrorMessageEnabled

isTabNavigationEnabled

setTabNavigationEnabled

setNextButtonColor

setCompleteButtonColor

setBackButtonColor

setNextButtonColor

setCompleteButtonColor

setBackButtonColor

updateErrorState

setOffscreenPageLimit

showProgress

hideProgress

isInProgress

setFeedbackType

getContentFadeAlpha

getContentOverlayBackground