WizardDialogDecorator (library API)

All Known Implementing Classes:

WizardDialog, WizardDialogDecorator
```
public interface WizardDialogDecorator
```
Defines the interface a decorator, which allows to modify the view hierary of a dialog, which is designed according to Android 5's Material Design guidelines even on pre-Lollipop devices and provides a navigation for switching between multiple fragments, must implement.

Since:

3.2.0

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addFragment(java.lang.CharSequence title, java.lang.Class<? extends Fragment> fragmentClass)` Adds a new fragment to the dialog.
`void`	`addFragment(java.lang.CharSequence title, java.lang.Class<? extends Fragment> fragmentClass, android.os.Bundle arguments)` Adds a new fragment to the dialog.
`void`	`addFragment(java.lang.Class<? extends Fragment> fragmentClass)` Adds a new fragment to the dialog.
`void`	`addFragment(java.lang.Class<? extends Fragment> fragmentClass, android.os.Bundle arguments)` Adds a new fragment to the dialog.
`void`	`addFragment(int resourceId, java.lang.Class<? extends Fragment> fragmentClass)` Adds a new fragment to the dialog.
`void`	`addFragment(int resourceId, java.lang.Class<? extends Fragment> fragmentClass, android.os.Bundle arguments)` Adds a new fragment to the dialog.
`void`	`addWizardListener(WizardDialog.WizardListener listener)` Adds a new listener, which should be notified, when the user navigates within the dialog.
`void`	`clearFragments()` Removes all fragments from the dialog.
`void`	`enableSwipe(boolean enable)` Sets, whether switching fragments using swipe gestures should be enabled, or not.
`void`	`enableTabLayout(boolean enable)` Enables or disables the tabs, which indicate the currently shown fragment.
`android.widget.Button`	`getBackButton()` Returns the button, which allows to show the previous fragment of the dialog.
`java.lang.CharSequence`	`getBackButtonText()` Returns the text of the dialog's back button.
`int`	`getButtonBarDividerColor()` Returns the color of the divider, which is located above the dialog's buttons.
`int`	`getButtonTextColor()` Returns the color of the button texts of the dialog.
`android.widget.Button`	`getFinishButton()` Returns the button, which allows to close dialog when the last fragment is shown.
`java.lang.CharSequence`	`getFinishButtonText()` Returns the text of the dialog's finish button.
`int`	`getFragmentCount()` Returns the number of fragments, which are contained by the dialog.
`android.widget.Button`	`getNextButton()` Returns the button, which allows to show the next fragment of the dialog.
`java.lang.CharSequence`	`getNextButtonText()` Returns the text of the dialog's next button.
`int`	`getTabIndicatorColor()` Returns the color of the indicator, which indicates the currently shown fragment.
`int`	`getTabIndicatorHeight()` Returns the height of the indicator, which indicates the currently shown fragment.
`TabLayout`	`getTabLayout()` Returns the tab layout, which is contained by the dialog.
`WizardDialog.TabPosition`	`getTabPosition()` Returns the position of the tabs, which indicate the currently shown fragment.
`int`	`getTabSelectedTextColor()` Returns the selected text color of the tabs, which indicate the currently shown fragment.
`int`	`getTabTextColor()` Returns the text color of the tabs, which indicate the currently shown fragment.
`ViewPager`	`getViewPager()` Returns the view pager, which is contained by the dialog.
`int`	`indexOfFragment(java.lang.Class<? extends Fragment> fragmentClass)` Returns the index of a specific fragment.
`boolean`	`isButtonBarDividerShown()` Returns, whether the divider, which is located above the dialog's buttons, is shown, or not.
`boolean`	`isButtonBarShown()` Returns, whether the dialog's buttons are shown, or not.
`boolean`	`isSwipeEnabled()` Returns, whether switching fragments using swipe gestures is enabled, or not.
`boolean`	`isTabLayoutEnabled()` Returns, whether the tabs, which indicate the currently shown fragment, are enabled, or not.
`boolean`	`isTabLayoutShown()` Returns, whether the tabs, which indicate the currently shown fragment, are shown, or not.
`void`	`removeFragment(int index)` Removes the fragment at a specific index from the dialog.
`void`	`removeWizardListener(WizardDialog.WizardListener listener)` Removes a specific listener, which should not be notified, when the user navigates within the dialog.
`void`	`setBackButtonText(java.lang.CharSequence text)` Sets the text of the dialog's back button.
`void`	`setBackButtonText(int resourceId)` Sets the text of the dialog's back button.
`void`	`setButtonBarDividerColor(int color)` Sets the color of the divider, which is located above the dialog's buttons.
`void`	`setButtonTextColor(int color)` Sets the color of the button texts of the dialog.
`void`	`setFinishButtonText(java.lang.CharSequence text)` Sets the text of the dialog's finish button.
`void`	`setFinishButtonText(int resourceId)` Sets the text of the dialog's finish button.
`void`	`setNextButtonText(java.lang.CharSequence text)` Sets the text of the dialog's next button.
`void`	`setNextButtonText(int resourceId)` Sets the text of the dialog's next button.
`void`	`setTabIndicatorColor(int color)` Sets the color of the indicator, which indicates the currently shown fragment.
`void`	`setTabIndicatorHeight(int height)` Sets the height of the indicator, which indicates the currently shown fragment.
`void`	`setTabPosition(WizardDialog.TabPosition tabPosition)` Sets the position of the tabs, which indicate the currently shown fragment.
`void`	`setTabSelectedTextColor(int selectedTextColor)` Sets the selected text color of the tabs, which indicate the currently shown fragment.
`void`	`setTabTextColor(int textColor)` Sets the text color of the tabs, which indicates the currently shown fragment.
`void`	`showButtonBar(boolean show)` Sets, whether the dialog's buttons should be shown, or not.
`void`	`showButtonBarDivider(boolean show)` Sets, whether the divider, which is located above the dialog's buttons, should be shown, or not.
`void`	`showTabLayout(boolean show)` Sets, whether the tabs, which indicate the currently shown fragment, should be shown shown, or not.

- Method Detail
  - getViewPager
```
ViewPager getViewPager()
```
    Returns the view pager, which is contained by the dialog.
    
    Returns:
    
    The view pager, which is contained by the dialog, as an instance of the class ViewPager or null, if the dialog does not show any fragments or has not been shown yet
  - getTabLayout
```
TabLayout getTabLayout()
```
    Returns the tab layout, which is contained by the dialog.
    
    Returns:
    
    The tab layout, which is contained by the dialog, as an instance of the class TabLayout or null, if the dialog does not show any fragments or has not been shown yet
  - getBackButton
```
android.widget.Button getBackButton()
```
    Returns the button, which allows to show the previous fragment of the dialog.
    
    Returns:
    
    The button, which allows to show the previous fragment of the dialog, as an instance of the class Button or null, if the dialog does not show any fragments or has not been shown yet
  - getNextButton
```
android.widget.Button getNextButton()
```
    Returns the button, which allows to show the next fragment of the dialog.
    
    Returns:
    
    The button, which allows to show the next fragment of the dialog, as an instance of the class Button or null, if the dialog does not show any fragments or has not been shown yet
  - getFinishButton
```
android.widget.Button getFinishButton()
```
    Returns the button, which allows to close dialog when the last fragment is shown.
    
    Returns:
    
    The button, which allows to close dialog when the last fragment is shown, as an instance of the class Button or null, if the dialog does not show any fragments or has not been shown yet
  - addFragment
```
void addFragment(java.lang.Class<? extends Fragment> fragmentClass)
```
    Adds a new fragment to the dialog.
    
    Parameters:
    
    fragmentClass - The class of the fragment, which should be added, as an instance of the class Class. The class may not be null
  - addFragment
```
void addFragment(java.lang.Class<? extends Fragment> fragmentClass,
                 android.os.Bundle arguments)
```
    Adds a new fragment to the dialog.
    
    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
  - addFragment
```
void addFragment(int resourceId,
                 java.lang.Class<? extends Fragment> fragmentClass)
```
    Adds a new fragment to the dialog.
    
    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
  - addFragment
```
void addFragment(int resourceId,
                 java.lang.Class<? extends Fragment> fragmentClass,
                 android.os.Bundle arguments)
```
    Adds a new fragment to the dialog.
    
    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
  - addFragment
```
void addFragment(java.lang.CharSequence title,
                 java.lang.Class<? extends Fragment> fragmentClass)
```
    Adds a new fragment to the dialog.
    
    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
  - addFragment
```
void addFragment(java.lang.CharSequence title,
                 java.lang.Class<? extends Fragment> fragmentClass,
                 android.os.Bundle arguments)
```
    Adds a new fragment to the dialog.
    
    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
  - removeFragment
```
void removeFragment(int index)
```
    Removes the fragment at a specific index from the dialog.
    
    Parameters:
    
    index - The index of the fragment, which should be removed, as an value
  - clearFragments
```
void clearFragments()
```
    Removes all fragments from the dialog.
  - indexOfFragment
```
int indexOfFragment(java.lang.Class<? extends Fragment> fragmentClass)
```
    Returns the index of a specific fragment.
    
    Parameters:
    
    fragmentClass - The class of the fragment, whose index should be returned, as an instance of the class Class. The class may not be null
    
    Returns:
    
    The index of the given fragment as an Integer value or -1, if the adapter does not contain the given fragment
  - getFragmentCount
```
int getFragmentCount()
```
    Returns the number of fragments, which are contained by the dialog.
    
    Returns:
    
    The number of fragments, which are contained by the dialog, as an Integer value
  - getTabPosition
```
WizardDialog.TabPosition getTabPosition()
```
    Returns the position of the tabs, which indicate the currently shown fragment.
    
    Returns:
    
    The position of the tabs, which indicate the currently shown fragment, as a value of the enum WizardDialog.TabPosition
  - setTabPosition
```
void 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
  - isTabLayoutEnabled
```
boolean isTabLayoutEnabled()
```
    Returns, whether the tabs, which indicate the currently shown fragment, are enabled, or not.
    
    Returns:
    
    True, if the tabs, which indicate the currently shown fragment, are enabled, false otherwise
  - enableTabLayout
```
void 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
  - isTabLayoutShown
```
boolean isTabLayoutShown()
```
    Returns, whether the tabs, which indicate the currently shown fragment, are shown, or not.
    
    Returns:
    
    True, if the tabs, which indicate the currently shown fragment, are shown, false otherwise
  - showTabLayout
```
void 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
  - getTabIndicatorHeight
```
int getTabIndicatorHeight()
```
    Returns the height of the indicator, which indicates the currently shown fragment.
    
    Returns:
    
    The height of the indicator, which indicates the currently shown fragment, in pixels as an Integer value
  - setTabIndicatorHeight
```
void 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
  - getTabIndicatorColor
```
int getTabIndicatorColor()
```
    Returns the color of the indicator, which indicates the currently shown fragment.
    
    Returns:
    
    The color of the indicator, which indicates the currently shown fragment, as an Integer value
  - setTabIndicatorColor
```
void 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
  - getTabTextColor
```
int getTabTextColor()
```
    Returns the text color of the tabs, which indicate the currently shown fragment.
    
    Returns:
    
    The text color of the tabs, which indicate the currently shown fragment, as an Integer value
  - setTabTextColor
```
void 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
  - getTabSelectedTextColor
```
int getTabSelectedTextColor()
```
    Returns the selected text color of the tabs, which indicate the currently shown fragment.
    
    Returns:
    
    The selected text color of the tabs, which indicate the currently shown fragment, as an Integer value
  - setTabSelectedTextColor
```
void 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
  - isSwipeEnabled
```
boolean isSwipeEnabled()
```
    Returns, whether switching fragments using swipe gestures is enabled, or not.
    
    Returns:
    
    True, if switching fragments using swipe gestures is enabled, false otherwise
  - enableSwipe
```
void 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
  - isButtonBarShown
```
boolean isButtonBarShown()
```
    Returns, whether the dialog's buttons are shown, or not.
    
    Returns:
    
    True, if the dialog's buttons are shown, false otherwise
  - showButtonBar
```
void 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
  - getButtonTextColor
```
int getButtonTextColor()
```
    Returns the color of the button texts of the dialog.
    
    Returns:
    
    The color of the button texts of the dialog as an Integer value or -1, if no custom color has been set
  - setButtonTextColor
```
void 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
  - isButtonBarDividerShown
```
boolean isButtonBarDividerShown()
```
    Returns, whether the divider, which is located above the dialog's buttons, is shown, or not.
    
    Returns:
    
    True, if the divider, which is located above the dialog's buttons, is shown, false otherwise
  - showButtonBarDivider
```
void 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
  - getButtonBarDividerColor
```
int getButtonBarDividerColor()
```
    Returns the color of the divider, which is located above the dialog's buttons.
    
    Returns:
    
    The color of the divider, which is located above the dialog's buttons, as an Integer value
  - setButtonBarDividerColor
```
void 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
  - getBackButtonText
```
java.lang.CharSequence getBackButtonText()
```
    Returns the text of the dialog's back button.
    
    Returns:
    
    The text of the dialog's back button as an instance of the type CharSequence
  - setBackButtonText
```
void 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
  - setBackButtonText
```
void 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
  - getNextButtonText
```
java.lang.CharSequence getNextButtonText()
```
    Returns the text of the dialog's next button.
    
    Returns:
    
    The text of the dialog's next button as an instance of the type CharSequence
  - setNextButtonText
```
void 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
  - setNextButtonText
```
void 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
  - getFinishButtonText
```
java.lang.CharSequence getFinishButtonText()
```
    Returns the text of the dialog's finish button.
    
    Returns:
    
    The text of the dialog's finish button as an instance of the type CharSequence
  - setFinishButtonText
```
void 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
  - setFinishButtonText
```
void 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
  - addWizardListener
```
void addWizardListener(WizardDialog.WizardListener listener)
```
    Adds a new listener, which should be notified, when the user navigates within the dialog. 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
  - removeWizardListener
```
void removeWizardListener(WizardDialog.WizardListener listener)
```
    Removes a specific listener, which should not be notified, when the user navigates within the dialog.
    
    Parameters:
    
    listener - The listener, which should be removed, as an instance of the type WizardDialog.WizardListener. The listener may not be null

Interface WizardDialogDecorator

Method Summary

Method Detail

getViewPager

getTabLayout

getBackButton

getNextButton

getFinishButton

addFragment

addFragment

addFragment

addFragment

addFragment

addFragment

removeFragment

clearFragments

indexOfFragment

getFragmentCount

getTabPosition

setTabPosition

isTabLayoutEnabled

enableTabLayout

isTabLayoutShown

showTabLayout

getTabIndicatorHeight

setTabIndicatorHeight

getTabIndicatorColor

setTabIndicatorColor

getTabTextColor

setTabTextColor

getTabSelectedTextColor

setTabSelectedTextColor

isSwipeEnabled

enableSwipe

isButtonBarShown

showButtonBar

getButtonTextColor

setButtonTextColor

isButtonBarDividerShown

showButtonBarDivider

getButtonBarDividerColor

setButtonBarDividerColor

getBackButtonText

setBackButtonText

setBackButtonText

getNextButtonText

setNextButtonText

setNextButtonText

getFinishButtonText

setFinishButtonText

setFinishButtonText

addWizardListener

removeWizardListener