com.stepstone.stepper.viewmodel

Class StepViewModel.Builder

java.lang.Object

com.stepstone.stepper.viewmodel.StepViewModel.Builder

Enclosing class:

StepViewModel

public static class StepViewModel.Builder
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Builder(android.content.Context context) Creates a builder for the step info.

Method Summary

Modifier and Type	Method and Description
StepViewModel	create() Creates a StepViewModel with the arguments supplied to this builder.
StepViewModel.Builder	setBackButtonLabel(java.lang.CharSequence backButtonLabel) Set the label of the back button.
StepViewModel.Builder	setBackButtonLabel(int backButtonLabelId) Set the label of the back button using the given resource id.
StepViewModel.Builder	setBackButtonStartDrawableResId(int backButtonStartDrawableResId) Set the drawable resource ID to be used for back button's start compound drawable.
StepViewModel.Builder	setBackButtonVisible(boolean backButtonVisible) Set the flag indicating if the Back button should be shown on the bottom bar.
StepViewModel.Builder	setEndButtonLabel(java.lang.CharSequence endButtonLabel) Set the label of the Complete/Next button.
StepViewModel.Builder	setEndButtonLabel(int endButtonLabelId) Set the label of the Complete/Next button using the given resource id.
StepViewModel.Builder	setEndButtonVisible(boolean endButtonVisible) Set the flag indicating if the Next/Complete button should be shown on the bottom bar.
StepViewModel.Builder	setNextButtonEndDrawableResId(int nextButtonEndDrawableResId) Set the drawable resource ID to be used for next button's end compound drawable.
StepViewModel.Builder	setSubtitle(java.lang.CharSequence subtitle) Set the subtitle using the given characters.
StepViewModel.Builder	setSubtitle(int subtitleId) Set the subtitle using the given resource id.
StepViewModel.Builder	setTitle(java.lang.CharSequence title) Set the title using the given characters.
StepViewModel.Builder	setTitle(int titleId) Set the title using the given resource id.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(@NonNull
               android.content.Context context)

Creates a builder for the step info.

Parameters:

context - the parent context

Method Detail

setTitle

public StepViewModel.Builder setTitle(@StringRes
                                      int titleId)

Set the title using the given resource id.

Parameters:

titleId - string resource ID for the title

Returns:

This Builder object to allow for chaining of calls to set methods

setTitle

public StepViewModel.Builder setTitle(@Nullable
                                      java.lang.CharSequence title)

Set the title using the given characters.

Parameters:

title - CharSequence to be used as a title

Returns:

This Builder object to allow for chaining of calls to set methods

setSubtitle

public StepViewModel.Builder setSubtitle(@StringRes
                                         int subtitleId)

Set the subtitle using the given resource id.

Parameters:

subtitleId - string resource ID for the subtitle

Returns:

This Builder object to allow for chaining of calls to set methods

setSubtitle

public StepViewModel.Builder setSubtitle(@Nullable
                                         java.lang.CharSequence subtitle)

Set the subtitle using the given characters.

Parameters:

subtitle - CharSequence to be used as a subtitle

Returns:

This Builder object to allow for chaining of calls to set methods

setEndButtonLabel

public StepViewModel.Builder setEndButtonLabel(@Nullable
                                               java.lang.CharSequence endButtonLabel)

Set the label of the Complete/Next button.

Parameters:

endButtonLabel - CharSequence to be used as a Complete/Next button label

Returns:

This Builder object to allow for chaining of calls to set methods

setEndButtonLabel

public StepViewModel.Builder setEndButtonLabel(@StringRes
                                               int endButtonLabelId)

Set the label of the Complete/Next button using the given resource id.

Parameters:

endButtonLabelId - string resource ID for the Complete/Next button

Returns:

This Builder object to allow for chaining of calls to set methods

setBackButtonLabel

public StepViewModel.Builder setBackButtonLabel(@StringRes
                                                int backButtonLabelId)

Set the label of the back button using the given resource id.

Parameters:

backButtonLabelId - string resource ID for the Back button

Returns:

This Builder object to allow for chaining of calls to set methods

setBackButtonLabel

public StepViewModel.Builder setBackButtonLabel(@Nullable
                                                java.lang.CharSequence backButtonLabel)

Set the label of the back button.

Parameters:

backButtonLabel - CharSequence to be used as a Back button label

Returns:

This Builder object to allow for chaining of calls to set methods

setNextButtonEndDrawableResId

public StepViewModel.Builder setNextButtonEndDrawableResId(@DrawableRes
                                                           int nextButtonEndDrawableResId)

Set the drawable resource ID to be used for next button's end compound drawable.

Parameters:

nextButtonEndDrawableResId - drawable resource ID to be used for next button's end compound drawable.

Returns:

This Builder object to allow for chaining of calls to set methods

setBackButtonStartDrawableResId

public StepViewModel.Builder setBackButtonStartDrawableResId(@DrawableRes
                                                             int backButtonStartDrawableResId)

Set the drawable resource ID to be used for back button's start compound drawable.

Parameters:

backButtonStartDrawableResId - drawable resource ID to be used for back button's start compound drawable.

Returns:

This Builder object to allow for chaining of calls to set methods

setEndButtonVisible

public StepViewModel.Builder setEndButtonVisible(boolean endButtonVisible)

Set the flag indicating if the Next/Complete button should be shown on the bottom bar.

Parameters:

endButtonVisible - true if Next/Complete button should be shown, false otherwise

Returns:

This Builder object to allow for chaining of calls to set methods

setBackButtonVisible

public StepViewModel.Builder setBackButtonVisible(boolean backButtonVisible)

Set the flag indicating if the Back button should be shown on the bottom bar.

Parameters:

backButtonVisible - true if Back button should be shown, false otherwise

Returns:

This Builder object to allow for chaining of calls to set methods

create

public StepViewModel create()

Creates a StepViewModel with the arguments supplied to this builder.

Returns:

created StepViewModel