com.stepstone.stepper.internal.feedback

Interface StepperFeedbackType

All Known Implementing Classes:

ContentFadeStepperFeedbackType, ContentOverlayStepperFeedbackType, ContentProgressStepperFeedbackType, DisabledBottomNavigationStepperFeedbackType, DisabledContentInteractionStepperFeedbackType, StepperFeedbackTypeComposite, TabsStepperFeedbackType

public interface StepperFeedbackType

An interface to be implemented by all support stepper feedback types. It contains methods which allow to show feedback for the duration of some executed operation.

Field Summary

Fields

Modifier and Type	Field and Description
static int	CONTENT_FADE Partially fades the content out during operation.
static int	CONTENT_OVERLAY Shows a dimmed overlay over the content during operation.
static int	CONTENT_PROGRESS Shows a progress bar on top of the steps' content.
static int	DISABLED_BOTTOM_NAVIGATION Disables the buttons in the bottom navigation during operation.
static int	DISABLED_CONTENT_INTERACTION Disables content interaction during operation i.e.
static int	NONE No changes during operation.
static int	PROGRESS_ANIMATION_DURATION
static int	TABS Show a progress message instead of the tabs during operation.

Method Summary

Modifier and Type	Method and Description
void	hideProgress() Hides the progress indicator.
void	showProgress(java.lang.String progressMessage) Shows a progress indicator.

Field Detail

NONE

static final int NONE

No changes during operation.

See Also:

Constant Field Values

TABS

static final int TABS

Show a progress message instead of the tabs during operation.

See Also:

TabsStepperFeedbackType, Constant Field Values

CONTENT_PROGRESS

static final int CONTENT_PROGRESS

Shows a progress bar on top of the steps' content.

See Also:

ContentProgressStepperFeedbackType, Constant Field Values

DISABLED_BOTTOM_NAVIGATION

static final int DISABLED_BOTTOM_NAVIGATION

Disables the buttons in the bottom navigation during operation.

See Also:

DisabledBottomNavigationStepperFeedbackType, Constant Field Values

DISABLED_CONTENT_INTERACTION

static final int DISABLED_CONTENT_INTERACTION

Disables content interaction during operation i.e. stops step views from receiving touch events.

See Also:

DisabledContentInteractionStepperFeedbackType, Constant Field Values

CONTENT_FADE

static final int CONTENT_FADE

Partially fades the content out during operation.

See Also:

ContentFadeStepperFeedbackType, Constant Field Values

CONTENT_OVERLAY

static final int CONTENT_OVERLAY

Shows a dimmed overlay over the content during operation.

See Also:

ContentOverlayStepperFeedbackType, Constant Field Values

PROGRESS_ANIMATION_DURATION

static final int PROGRESS_ANIMATION_DURATION

See Also:

Constant Field Values

Method Detail

showProgress

void showProgress(@NonNull
                  java.lang.String progressMessage)

Shows a progress indicator. 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

void hideProgress()

Hides the progress indicator.