de.mrapp.android.dialog

Class WizardDialog.Builder

java.lang.Object

de.mrapp.android.dialog.builder.AbstractMaterialDialogBuilder<DialogType,BuilderType>

de.mrapp.android.dialog.builder.AbstractHeaderDialogBuilder<WizardDialog,WizardDialog.Builder>

de.mrapp.android.dialog.WizardDialog.Builder

Enclosing class:

WizardDialog

public static class WizardDialog.Builder
extends AbstractHeaderDialogBuilder<WizardDialog,WizardDialog.Builder>

A builder, which allows to create and show dialogs, which are designed according to Android 5's Material Design guidelines even on pre-Lollipop devices and provide a navigation for switching between multiple fragments.

Constructor Summary

Constructors

Constructor and Description
Builder(android.content.Context context) Creates a new builder, which allows to create dialogs, which are designed according to Android 5's Material Design guidelines even on pre-Lollipop devices and provide a navigation for switching between multiple fragments.
Builder(android.content.Context context, int themeResourceId) Creates a new builder, which allows to create dialogs, which are designed according to Android 5's Material Design guidelines even on pre-Lollipop devices and provide a navigation for switching between multiple fragments.

Method Summary

Modifier and Type	Method and Description
WizardDialog.Builder	addFragment(java.lang.CharSequence title, java.lang.Class<? extends Fragment> fragmentClass) Adds a new fragment to the dialog, which is created by the builder.
WizardDialog.Builder	addFragment(java.lang.CharSequence title, java.lang.Class<? extends Fragment> fragmentClass, android.os.Bundle arguments) Adds a new fragment to the dialog, which is created by the builder.
WizardDialog.Builder	addFragment(java.lang.Class<? extends Fragment> fragmentClass) Adds a new fragment to the dialog, which is created by the builder.
WizardDialog.Builder	addFragment(java.lang.Class<? extends Fragment> fragmentClass, android.os.Bundle arguments) Adds a new fragment to the dialog, which is created by the builder.
WizardDialog.Builder	addFragment(int resourceId, java.lang.Class<? extends Fragment> fragmentClass) Adds a new fragment to the dialog, which is created by the builder.
WizardDialog.Builder	addFragment(int resourceId, java.lang.Class<? extends Fragment> fragmentClass, android.os.Bundle arguments) Adds a new fragment to the dialog, which is created by the builder.
WizardDialog.Builder	addWizardListener(WizardDialog.WizardListener listener) Adds a new listener, which should be notified, when the user navigates within the dialog, which is created by the builder.
WizardDialog.Builder	enableSwipe(boolean enable) Sets, whether switching fragments using swipe gestures should be enabled, or not.
WizardDialog.Builder	enableTabLayout(boolean enable) Enables or disables the tabs, which indicate the currently shown fragment.
protected void	obtainStyledAttributes(int themeResourceId) Obtains all relevant attributes from the current theme.
protected WizardDialog	onCreateDialog(android.content.Context context, int themeResourceId) The method, which is invoked on subclasses in order to create the dialog, which is configured by the builder.
WizardDialog.Builder	setBackButtonText(java.lang.CharSequence text) Sets the text of the dialog's back button.
WizardDialog.Builder	setBackButtonText(int resourceId) Sets the text of the dialog's back button.
WizardDialog.Builder	setButtonBarDividerColor(int color) Sets the color of the divider, which is located above the dialog's buttons.
WizardDialog.Builder	setButtonTextColor(int color) Sets the color of the button texts of the dialog.
WizardDialog.Builder	setFinishButtonText(java.lang.CharSequence text) Sets the text of the dialog's finish button.
WizardDialog.Builder	setFinishButtonText(int resourceId) Sets the text of the dialog's finish button.
WizardDialog.Builder	setNextButtonText(java.lang.CharSequence text) Sets the text of the dialog's next button.
WizardDialog.Builder	setNextButtonText(int resourceId) Sets the text of the dialog's next button.
WizardDialog.Builder	setTabIndicatorColor(int color) Sets the color of the indicator, which indicates the currently shown fragment.
WizardDialog.Builder	setTabIndicatorHeight(int height) Sets the height of the indicator, which indicates the currently shown fragment.
WizardDialog.Builder	setTabPosition(WizardDialog.TabPosition tabPosition) Sets the position of the tabs, which indicate the currently shown fragment.
WizardDialog.Builder	setTabSelectedTextColor(int selectedTextColor) Sets the selected text color of the tabs, which indicate the currently shown fragment.
WizardDialog.Builder	setTabTextColor(int textColor) Sets the text color of the tabs, which indicates the currently shown fragment.
WizardDialog	show(FragmentManager fragmentManager, java.lang.String tag) Creates a dialog with the arguments, which have been supplied to the builder and immediately displays it.
WizardDialog	show(FragmentTransaction fragmentTransaction, java.lang.String tag) Creates a dialog with the arguments, which have been supplied to the builder and immediately displays it.
WizardDialog.Builder	showButtonBar(boolean show) Sets, whether the dialog's buttons should be shown, or not.
WizardDialog.Builder	showButtonBarDivider(boolean show) Sets, whether the divider, which is located above the dialog's buttons, should be shown, or not.
WizardDialog.Builder	showTabLayout(boolean show) Sets, whether the tabs, which indicate the currently shown fragment, should be shown shown, or not.

Methods inherited from class de.mrapp.android.dialog.builder.AbstractHeaderDialogBuilder

setHeaderBackground, setHeaderBackground, setHeaderBackgroundColor, setHeaderDividerColor, setHeaderHeight, setHeaderIcon, setHeaderIcon, showHeader, showHeaderDivider

Methods inherited from class de.mrapp.android.dialog.builder.AbstractMaterialDialogBuilder

create, getContext, getDialog, self, setBackground, setBackground, setBackgroundColor, setCancelable, setCustomMessage, setCustomMessage, setCustomTitle, setCustomTitle, setIcon, setIcon, setIconAttribute, setMessage, setMessage, setMessageColor, setOnCancelListener, setOnDismissListener, setOnShowListener, setTitle, setTitle, setTitleColor, setView, setView

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(android.content.Context context)

Creates a new builder, which allows to create dialogs, which are designed according to Android 5's Material Design guidelines even on pre-Lollipop devices and provide a navigation for switching between multiple fragments.

Parameters:

context - The context, which should be used by the builder, as an instance of the class Context. The context may not be null

Builder

public Builder(android.content.Context context,
               int themeResourceId)

Creates a new builder, which allows to create dialogs, which are designed according to Android 5's Material Design guidelines even on pre-Lollipop devices and provide a navigation for switching between multiple fragments.

Parameters:

context - The context, which should be used by the builder, as an instance of the class Context. The context may not be null

themeResourceId - The resource id of the theme, which should be used by the dialog, as an Integer value. The resource id must correspond to a valid theme

Method Detail

addFragment

public final WizardDialog.Builder addFragment(java.lang.Class<? extends Fragment> fragmentClass)

Adds a new fragment to the dialog, which is created by the builder.

Parameters:

fragmentClass - The class of the fragment, which should be added, as an instance of the class Class. The class may not be null

Returns:

The builder, the method has been called upon, as an instance of the class WizardDialog.Builder

addFragment

public final WizardDialog.Builder addFragment(java.lang.Class<? extends Fragment> fragmentClass,
                                              android.os.Bundle arguments)

Adds a new fragment to the dialog, which is created by the builder.

Parameters:

fragmentClass - The class of the fragment, which should be added, as an instance of the class Class. The class may not be null

arguments - A bundle, which should be passed to the fragment, when it is shown, as an instance of the class Bundle or null, if no arguments should be passed to the fragment

Returns:

The builder, the method has been called upon, as an instance of the class WizardDialog.Builder

addFragment

public final WizardDialog.Builder addFragment(int resourceId,
                                              java.lang.Class<? extends Fragment> fragmentClass)

Adds a new fragment to the dialog, which is created by the builder.

Parameters:

resourceId - The resource id of the title of the fragment, which should be added, as an Integer value. The resource id must correspond to a valid string resource

fragmentClass - The class of the fragment, which should be added, as an instance of the class Class. The class may not be null

Returns:

The builder, the method has been called upon, as an instance of the class WizardDialog.Builder

addFragment

public final WizardDialog.Builder addFragment(int resourceId,
                                              java.lang.Class<? extends Fragment> fragmentClass,
                                              android.os.Bundle arguments)

Adds a new fragment to the dialog, which is created by the builder.

Parameters:

resourceId - The resource id of the title of the fragment, which should be added, as an Integer value. The resource id must correspond to a valid string resource

fragmentClass - The class of the fragment, which should be added, as an instance of the class Class. The class may not be null

arguments - A bundle, which should be passed to the fragment, when it is shown, as an instance of the class Bundle or null, if no arguments should be passed to the fragment

Returns:

The builder, the method has been called upon, as an instance of the class WizardDialog.Builder

addFragment

public final WizardDialog.Builder addFragment(java.lang.CharSequence title,
                                              java.lang.Class<? extends Fragment> fragmentClass)

Adds a new fragment to the dialog, which is created by the builder.

Parameters:

title - The title of the fragment, which should be added, as an instance of the type CharSequence or null, if no title should be set

fragmentClass - The class of the fragment, which should be added, as an instance of the class Class. The class may not be null

Returns:

The builder, the method has been called upon, as an instance of the class WizardDialog.Builder

addFragment

public final WizardDialog.Builder addFragment(java.lang.CharSequence title,
                                              java.lang.Class<? extends Fragment> fragmentClass,
                                              android.os.Bundle arguments)

Adds a new fragment to the dialog, which is created by the builder.

Parameters:

title - The title of the fragment, which should be added, as an instance of the type CharSequence or null, if no title should be set

fragmentClass - The class of the fragment, which should be added, as an instance of the class Class. The class may not be null

arguments - A bundle, which should be passed to the fragment, when it is shown, as an instance of the class Bundle or null, if no arguments should be passed to the fragment

Returns:

The builder, the method has been called upon, as an instance of the class WizardDialog.Builder

setTabPosition

public final WizardDialog.Builder setTabPosition(WizardDialog.TabPosition tabPosition)

Sets the position of the tabs, which indicate the currently shown fragment.

Parameters:

tabPosition - The position, which should be set, as a value of the enum WizardDialog.TabPosition. The position may either be USE_HEADER, PREFER_HEADER or NO_HEADER

Returns:

The builder, the method has been called upon, as an instance of the class WizardDialog.Builder

enableTabLayout

public final WizardDialog.Builder enableTabLayout(boolean enable)

Enables or disables the tabs, which indicate the currently shown fragment. When the tabs are enabled, it is possible to switch between the fragments by clicking the tabs.

Parameters:

enable - True, if the tabs should be enabled, false otherwise

Returns:

The builder, the method has been called upon, as an instance of the class WizardDialog.Builder

showTabLayout

public final WizardDialog.Builder showTabLayout(boolean show)

Sets, whether the tabs, which indicate the currently shown fragment, should be shown shown, or not.

Parameters:

show - True, if the tabs, which indicate the currently shown fragment, should be shown, false otherwise

Returns:

The builder, the method has been called upon, as an instance of the class WizardDialog.Builder

setTabIndicatorHeight

public final WizardDialog.Builder setTabIndicatorHeight(int height)

Sets the height of the indicator, which indicates the currently shown fragment.

Parameters:

height - The height, which should be set, in pixels as an Integer value. The height must be at least 1

Returns:

The builder, the method has been called upon, as an instance of the class WizardDialog.Builder

setTabIndicatorColor

public final WizardDialog.Builder setTabIndicatorColor(int color)

Sets the color of the indicator, which indicates the currently shown fragment.

Parameters:

color - The color, which should be set, as an Integer value

Returns:

The builder, the method has been called upon, as an instance of the class WizardDialog.Builder

setTabTextColor

public final WizardDialog.Builder setTabTextColor(int textColor)

Sets the text color of the tabs, which indicates the currently shown fragment.

Parameters:

textColor - The text color, which should be set, as an Integer value

Returns:

The builder, the method has been called upon, as an instance of the class WizardDialog.Builder

setTabSelectedTextColor

public final WizardDialog.Builder setTabSelectedTextColor(int selectedTextColor)

Sets the selected text color of the tabs, which indicate the currently shown fragment.

Parameters:

selectedTextColor - The selected text color, which should be set, as an Integer value

Returns:

The builder, the method has been called upon, as an instance of the class WizardDialog.Builder

enableSwipe

public final WizardDialog.Builder enableSwipe(boolean enable)

Sets, whether switching fragments using swipe gestures should be enabled, or not.

Parameters:

enable - True, if switching fragments using swipe gestures should be enabled, false otherwise

Returns:

The builder, the method has been called upon, as an instance of the class WizardDialog.Builder

showButtonBar

public final WizardDialog.Builder showButtonBar(boolean show)

Sets, whether the dialog's buttons should be shown, or not.

Parameters:

show - True, if the dialog's buttons should be shown, false otherwise

Returns:

The builder, the method has been called upon, as an instance of the class WizardDialog.Builder

setButtonTextColor

public final WizardDialog.Builder setButtonTextColor(int color)

Sets the color of the button texts of the dialog.

Parameters:

color - The color, which should be set, as an Integer value

Returns:

The builder, the method has been called upon, as an instance of the class WizardDialog.Builder

showButtonBarDivider

public final WizardDialog.Builder showButtonBarDivider(boolean show)

Sets, whether the divider, which is located above the dialog's buttons, should be shown, or not.

Parameters:

show - True, if the divider, which is located above the dialog's buttons, should be show, false otherwise

Returns:

The builder, the method has been called upon, as an instance of the class WizardDialog.Builder

setButtonBarDividerColor

public final WizardDialog.Builder setButtonBarDividerColor(int color)

Sets the color of the divider, which is located above the dialog's buttons.

Parameters:

color - The color, which should be set, as an Integer value

Returns:

The builder, the method has been called upon, as an instance of the class WizardDialog.Builder

setBackButtonText

public final WizardDialog.Builder setBackButtonText(int resourceId)

Sets the text of the dialog's back button.

Parameters:

resourceId - The resource id of the text, which should be set, as an Integer value. The resource id must correspond to a valid string resource

Returns:

The builder, the method has been called upon, as an instance of the class WizardDialog.Builder

setBackButtonText

public final WizardDialog.Builder setBackButtonText(java.lang.CharSequence text)

Sets the text of the dialog's back button.

Parameters:

text - The text, which should be set, as an instance of the class CharSequence. The text may neither be null, nor empty

Returns:

The builder, the method has been called upon, as an instance of the class WizardDialog.Builder

setNextButtonText

public final WizardDialog.Builder setNextButtonText(int resourceId)

Sets the text of the dialog's next button.

Parameters:

resourceId - The resource id of the text, which should be set, as an Integer value. The resource id must correspond to a valid string resource

Returns:

The builder, the method has been called upon, as an instance of the class WizardDialog.Builder

setNextButtonText

public final WizardDialog.Builder setNextButtonText(java.lang.CharSequence text)

Sets the text of the dialog's next button.

Parameters:

text - The text, which should be set, as an instance of the class CharSequence. The text may neither be null, nor empty

Returns:

The builder, the method has been called upon, as an instance of the class WizardDialog.Builder

setFinishButtonText

public final WizardDialog.Builder setFinishButtonText(int resourceId)

Sets the text of the dialog's finish button.

Parameters:

resourceId - The resource id of the text, which should be set, as an Integer value. The resource id must correspond to a valid string resource

Returns:

The builder, the method has been called upon, as an instance of the class WizardDialog.Builder

setFinishButtonText

public final WizardDialog.Builder setFinishButtonText(java.lang.CharSequence text)

Sets the text of the dialog's finish button.

Parameters:

text - The text, which should be set, as an instance of the class CharSequence. The text may neither be null, nor empty

Returns:

The builder, the method has been called upon, as an instance of the class WizardDialog.Builder

addWizardListener

public final WizardDialog.Builder addWizardListener(WizardDialog.WizardListener listener)

Adds a new listener, which should be notified, when the user navigates within the dialog, which is created by the builder. Note, that the attached listeners are not stored using a dialog's onSaveInstanceState-method, because it is not serializable. Therefore this method must be called again after configuration changes, e.g when the orientation of the device has changed, in order to re-register the listeners.

Parameters:

listener - The listener, which should be added, as an instance of the type WizardDialog.WizardListener. The listener may not be null

Returns:

The builder, the method has been called upon, as an instance of the class WizardDialog.Builder

show

public final WizardDialog show(FragmentManager fragmentManager,
                               java.lang.String tag)

Creates a dialog with the arguments, which have been supplied to the builder and immediately displays it.

Parameters:

fragmentManager - The fragment manager, which should be used by the dialog, as an instance of the class FragmentManager. The fragment manager may not be null

tag - The tag, which should be used to show the dialog, as a String or null, if no tag should be used

Returns:

The dialog, which has been shown, as an instance of the class WizardDialog

show

public final WizardDialog show(FragmentTransaction fragmentTransaction,
                               java.lang.String tag)

Creates a dialog with the arguments, which have been supplied to the builder and immediately displays it.

Parameters:

fragmentTransaction - The fragment transaction, which should be used to show the dialog, as an instance of the class FragmentTransaction. The fragment transaction may not be null

tag - The tag, which should be used to show the dialog, as a String or null, if no tag should be used

Returns:

The dialog, which has been shown, as an instance of the class WizardDialog

onCreateDialog

protected final WizardDialog onCreateDialog(android.content.Context context,
                                            int themeResourceId)

Description copied from class: AbstractMaterialDialogBuilder

The method, which is invoked on subclasses in order to create the dialog, which is configured by the builder.

Specified by:

onCreateDialog in class AbstractMaterialDialogBuilder<WizardDialog,WizardDialog.Builder>

Parameters:

context - The context, which should be used by the dialog, as an instance of the class Context. The context may not be null

themeResourceId - The resource id of the theme, which should be used by the dialog, as an Integer value

Returns:

The dialog, which has been created, as an instance of the generic type DialogType

obtainStyledAttributes

protected final void obtainStyledAttributes(int themeResourceId)

Description copied from class: AbstractMaterialDialogBuilder

Obtains all relevant attributes from the current theme.

Overrides:

obtainStyledAttributes in class AbstractHeaderDialogBuilder<WizardDialog,WizardDialog.Builder>

Parameters:

themeResourceId - The resource id of the theme, which should be used by the dialog, as an Integer value. The resource id must correspond to a valid style resource