com.stepstone.stepper.internal.type

Class AbstractStepperType

java.lang.Object

com.stepstone.stepper.internal.type.AbstractStepperType

Direct Known Subclasses:

DotsStepperType, NoneStepperType, ProgressBarStepperType, TabsStepperType

public abstract class AbstractStepperType
extends java.lang.Object

A base stepper type all stepper types must extend.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DOTS Mobile step dots
static int	NONE No indicator
static int	PROGRESS_BAR Mobile step progress bar
static int	TABS Horizontal stepper with tabs

Constructor Summary

Constructors

Constructor and Description
AbstractStepperType(StepperLayout stepperLayout)

Method Summary

Modifier and Type	Method and Description
VerificationError	getErrorAtPosition(int stepPosition) Checks if there's an error for the step.
protected int	getSelectedColor()
protected int	getUnselectedColor()
void	onNewAdapter(StepAdapter stepAdapter) Called when StepperLayout's adapter gets changed
abstract void	onStepSelected(int newStepPosition, boolean userTriggeredChange) Called when a step gets selected as the new current step.
void	setError(int stepPosition, VerificationError error) Called to set whether the stepPosition has an error or not, changing it's appearance.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DOTS

public static final int DOTS

Mobile step dots

See Also:

Constant Field Values

PROGRESS_BAR

public static final int PROGRESS_BAR

Mobile step progress bar

See Also:

Constant Field Values

TABS

public static final int TABS

Horizontal stepper with tabs

See Also:

Constant Field Values

NONE

public static final int NONE

No indicator

See Also:

Constant Field Values

Constructor Detail

AbstractStepperType

public AbstractStepperType(StepperLayout stepperLayout)

Method Detail

onStepSelected

public abstract void onStepSelected(int newStepPosition,
                                    boolean userTriggeredChange)

Called when a step gets selected as the new current step.

Parameters:

newStepPosition - new current step position

userTriggeredChange - true if current step position changed as a direct result of user interaction

setError

public void setError(int stepPosition,
                     @Nullable
                     VerificationError error)

Called to set whether the stepPosition has an error or not, changing it's appearance.

Parameters:

stepPosition - the step to set the error

error - error instance or null if no error

getErrorAtPosition

@Nullable
public VerificationError getErrorAtPosition(int stepPosition)

Checks if there's an error for the step.

Parameters:

stepPosition - the step to check for error

Returns:

an error for this step or null if no error

onNewAdapter

@CallSuper
public void onNewAdapter(@NonNull
                                    StepAdapter stepAdapter)

Called when StepperLayout's adapter gets changed

Parameters:

stepAdapter - new stepper adapter

getSelectedColor

protected int getSelectedColor()

getUnselectedColor

protected int getUnselectedColor()