PreferenceActivity (library API)

java.lang.Object
- AppCompatActivity
- - de.mrapp.android.preference.activity.PreferenceActivity

All Implemented Interfaces:

NavigationPreferenceAdapter.Callback, NavigationFragment.Callback
```
public abstract class PreferenceActivity
extends AppCompatActivity
implements NavigationFragment.Callback, NavigationPreferenceAdapter.Callback
```
An activity, which provides a navigation for accessing preferences, which are grouped as different sections. Each group of preferences is accessible by clicking a NavigationPreference. On devices with small screens, e.g. on smartphones, the navigation is designed to use the whole available space and selecting an item causes the corresponding preferences to be shown full screen as well. On devices with large screens, e.g. on tablets, the navigation and the preferences of the currently selected item are shown using a split screen layout. However, the full screen layout can optionally be used on tablets as well.

Since:

1.0.0

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`EXTRA_BACK_BUTTON_TEXT` When starting this activity and using `EXTRA_SHOW_BUTTON_BAR`, this extra can also be specified to supply a custom text for the back button.
`static java.lang.String`	`EXTRA_FINISH_BUTTON_TEXT` When starting this activity and using `EXTRA_SHOW_BUTTON_BAR`, this extra can also be specified to supply a custom text for the back button when the last navigation preference is selected.
`static java.lang.String`	`EXTRA_HIDE_NAVIGATION` When starting this activity, the invoking intent can contain this extra boolean to specify that the navigation should not be displayed.
`static java.lang.String`	`EXTRA_NEXT_BUTTON_TEXT` When starting this activity and using `EXTRA_SHOW_BUTTON_BAR`, this extra can also be specified to supply a custom text for the next button.
`static java.lang.String`	`EXTRA_NO_BREAD_CRUMBS` When starting this activity, the invoking intent can contain this extra boolean that the toolbar, which is used to show the title of the currently selected navigation preference, should not be displayed.
`static java.lang.String`	`EXTRA_PROGRESS_FORMAT` When starting this activity using `EXTRA_SHOW_BUTTON_BAR` and `EXTRA_SHOW_PROGRESS`, this string extra can also be specified to supply a custom format for showing the progress.
`static java.lang.String`	`EXTRA_SHOW_BUTTON_BAR` When starting this activity, the invoking intent can contain this extra boolean to display back and next buttons in order to use the activity as a wizard.
`static java.lang.String`	`EXTRA_SHOW_FRAGMENT` When starting this activity, the invoking intent can contain this extra string to specify which fragment should be initially displayed.
`static java.lang.String`	`EXTRA_SHOW_FRAGMENT_ARGUMENTS` When starting this activity and using `EXTRA_SHOW_FRAGMENT`, this extra can also be specified to supply a bundle of arguments to pass to that fragment when it is instantiated during the initial creation of the activity.
`static java.lang.String`	`EXTRA_SHOW_FRAGMENT_TITLE` When starting this activity and using `EXTRA_SHOW_FRAGMENT`, this extra can also be specified to supply the title to be shown for that fragment.
`static java.lang.String`	`EXTRA_SHOW_PROGRESS` When starting this activity using `EXTRA_SHOW_BUTTON_BAR`, this boolean extra can also used to specify, whether the number of the currently shown wizard step and the number of total steps should be shown as the bread crumb title.

Constructor Summary

Constructors
Constructor and Description

PreferenceActivity()

Constructors
Constructor and Description
`PreferenceActivity()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addNavigationListener(NavigationListener listener)` Adds a new listener, which should be notified, when a navigation preference has been added or removed to/from the activity.
`void`	`addPreferenceFragmentListener(PreferenceFragmentListener listener)` Adds a new listener, which should be notified, when the currently shown preference fragment has been changed, to the activity.
`void`	`addWizardListener(WizardListener listener)` Adds a new listener, which should be notified, when the user navigates within the activity, if it is used as a wizard.
`java.util.List<NavigationPreference>`	`getAllNavigationPreferences()` Returns a list, which contains all navigation preferences, which are contained by the activity.
`android.widget.Button`	`getBackButton()` Returns the back button, which is shown when the activity is used as a wizard and the first navigation preference is not selected.
`java.lang.CharSequence`	`getBackButtonText()` Returns the text of the back button, which is shown, when the activity is used as a wizard.
`int`	`getBreadCrumbBackgroundColor()` Returns the background color of the toolbar, which is used to show the bread crumb of the currently selected navigation preference, when using the split screen layout.
`int`	`getBreadCrumbElevation()` Returns the elevation of the toolbar, which is used to show the bread crumb of the currently selected navigation preference, when using the split screen layout.
`Toolbar`	`getBreadCrumbToolbar()` Returns the toolbar, which is used to show the bread crumb of the currently selected navigation preference, when using the split screen layout.
`android.view.ViewGroup`	`getButtonBar()` Returns the button bar, which is shown when the activity is used as a wizard.
`android.graphics.drawable.Drawable`	`getButtonBarBackground()` Returns the background of the button bar, which is shown, when the activity is used as a wizard.
`int`	`getButtonBarElevation()` Returns the elevation of the button bar, which is shown when using the activity as a wizard.
`CardView`	`getCardView()` Returns the card view, which contains the currently shown preference fragment, when using the split screen layout.
`int`	`getCardViewBackgroundColor()` Returns the background color of the card view, which contains the currently shown preference fragment, when using the split screen layout.
`int`	`getCardViewElevation()` Returns the elevation of the card view, which contains the currently shown preference fragment, when using the split screen layout.
`android.widget.Button`	`getFinishButton()` Returns the finish button, which is shown when the activity is used as a wizard and the last navigation preference is selected.
`java.lang.CharSequence`	`getFinishButtonText()` Returns the text of the finish button, which is shown, when the activity is used as a wizard and the last navigation preference is currently selected.
`android.widget.FrameLayout`	`getFrameLayout()` Returns the frame layout, which contains the activity's views.
`android.graphics.drawable.Drawable`	`getNavigationBackground()` Returns the background of the navigation.
`int`	`getNavigationDividerColor()` Returns the color of the dividers, which are contained by the navigation.
`PreferenceFragmentCompat`	`getNavigationFragment()` Returns the preference fragment, which contains the activity's navigation.
`int`	`getNavigationPreferenceCount()` Returns the number of navigation preferences, which are contained by the activity.
`int`	`getNavigationSelectionColor()` Returns the background color of the currently selected navigation preference.
`Toolbar`	`getNavigationToolbar()` Returns the toolbar, which is used to show the activity's title, when using the split screen layout.
`int`	`getNavigationWidth()` Returns the width of the navigation, when using the split screen layout.
`android.widget.Button`	`getNextButton()` Returns the next button, which is shown when the activity is used as a wizard and the last navigation preference is not selected.
`java.lang.CharSequence`	`getNextButtonText()` Returns the text of the next button, which is shown, when the activity is used as a wizard.
`Fragment`	`getPreferenceFragment()` Returns the currently shown preference fragment.
`java.lang.String`	`getProgressFormat()` Returns the string, which is used to format the progress, which is shown, when the activity is used as a wizard.
`NavigationPreference`	`getSelectedNavigationPreference()` Returns the currently selected navigation preference.
`int`	`getToolbarElevation()` Returns the elevation of the activity's toolbar.
`void`	`hideBreadCrumb(boolean hide)` Sets, whether the toolbar, which is used to show the bread crumb of the currently selected navigation preference, should be hidden, or not.
`void`	`hideNavigation(boolean hideNavigation)` Hides or shows the navigation.
`boolean`	`isBreadCrumbHidden()` Returns, whether the toolbar, which is used to show the bread crumb of the currently selected navigation preference, is hidden, or not.
`boolean`	`isButtonBarShown()` Returns, whether the activity is used as a wizard, or not.
`boolean`	`isNavigationHidden()` Returns, whether the navigation is currently hidden, or not.
`boolean`	`isNavigationIconOverridden()` Returns, whether the behavior of the navigation icon of the activity's toolbar is overridden in order to return to the navigation when a preference fragment is currently shown and the split screen layout is used.
`boolean`	`isNavigationPreferenceSelected()` Returns, whether a navigation preference is currently selected, or not.
`boolean`	`isPreferenceFragmentShown()` Returns, whether a preference fragment is currently shown, or not.
`boolean`	`isProgressShown()` Returns, whether the progress is shown, if the activity is used as a wizard.
`boolean`	`isSplitScreen()` Returns, whether the split screen layout is used, or not.
`void`	`onBackPressed()`
`protected void`	`onCreate(android.os.Bundle savedInstanceState)`
`protected void`	`onCreateNavigation(PreferenceFragmentCompat fragment)` The method, which is invoked on implementing subclasses, when the navigation is created.
`void`	`onNavigationAdapterCreated()` The method, which is invoked, when the adapter, which contains the navigation items, has been created.
`void`	`onNavigationFragmentCreated(PreferenceFragmentCompat fragment)` The method, which is invoked, when the navigation fragment has been attached to its activity.
`void`	`onNavigationPreferenceAdded(NavigationPreference navigationPreference)` The method, which is invoked, when a navigation preference has been added.
`void`	`onNavigationPreferenceRemoved(NavigationPreference navigationPreference)` The method, which is invoked, when a navigation preference has been removed.
`void`	`onNavigationPreferenceSelected(NavigationPreference navigationPreference, android.os.Bundle arguments)` The method, which is invoked, when a navigation preference has been selected.
`void`	`onNavigationPreferenceUnselected()` The method, which is invoked, when a navigation preference has been unselected.
`boolean`	`onOptionsItemSelected(android.view.MenuItem item)`
`protected void`	`onRestoreInstanceState(android.os.Bundle savedInstanceState)`
`protected void`	`onSaveInstanceState(android.os.Bundle outState)`
`boolean`	`onSelectNavigationPreference(NavigationPreference navigationPreference)` The method, which is invoked, when a navigation preference is about to be selected.
`void`	`overrideNavigationIcon(boolean overrideNavigationIcon)` Sets, whether the behavior of the navigation icon of the activity's toolbar should be overridden in order to return to the navigation when a preference screen is currently shown and the split screen layout is used, or not.
`void`	`removeNavigationListener(NavigationListener listener)` Removes a specific listener, which should not be notified, when a navigation preference has been added or removed to/from the activity, anymore.
`void`	`removePreferenceFragmentListener(PreferenceFragmentListener listener)` Removes a specific listener, which should not be notified, when the currently shown preference fragment has been changed, anymore.
`void`	`removeWizardListener(WizardListener listener)` Removes a specific listener, which should not be notified, when the user navigates within the activity, if it is used as a wizard.
`void`	`selectNavigationPreference(NavigationPreference navigationPreference)` Selects a specific navigation preference.
`void`	`selectNavigationPreference(NavigationPreference navigationPreference, android.os.Bundle arguments)` Selects a specific navigation preference.
`void`	`setBackButtonText(java.lang.CharSequence text)` Sets the text of the back button, which is shown, when the activity is used as a wizard.
`void`	`setBackButtonText(int resourceId)` Sets the text of the back button, which is shown, when the activity is used as a wizard.
`void`	`setBreadCrumbBackgroundColor(int color)` Sets the background color of the toolbar, which is used to show the bread crumb of the currently selected navigation preference, when using the split screen layout.
`void`	`setBreadCrumbElevation(int elevation)` Sets the elevation of the toolbar, which is used to show the bread crumb of the currently selected navigation preference, when using the split screen layout.
`void`	`setButtonBarBackground(android.graphics.drawable.Drawable background)` Sets the background of the button bar, which is shown, when the activity is used as a wizard.
`void`	`setButtonBarBackground(int resourceId)` Sets the background of the button bar, which is shown, when the activity is used as a wizard.
`void`	`setButtonBarBackgroundColor(int color)` Sets the background of the button bar, which is shown, when the activity is used as a wizard.
`void`	`setButtonBarElevation(int elevation)` Sets the elevation of the button bar, which is shown when using the activity as a wizard.
`void`	`setCardViewBackgroundColor(int color)` Sets the background color of the card view, which contains the currently shown preference fragment, when using the split screen layout.
`void`	`setCardViewElevation(int elevation)` Sets the elevation of the card view, which contains the currently shown prefernce fragment, when using the split screen layout.
`void`	`setFinishButtonText(java.lang.CharSequence text)` Sets the text of the next button, which is shown, when the activity is used as a wizard and the last navigation preference is currently selected.
`void`	`setFinishButtonText(int resourceId)` Sets the text of the next button, which is shown, when the activity is used as a wizard and the last navigation preference is currently selected.
`void`	`setNavigationBackground(android.graphics.drawable.Drawable background)` Sets the background of the navigation.
`void`	`setNavigationBackground(int resourceId)` Sets the background of the navigation.
`void`	`setNavigationBackgroundColor(int color)` Sets the background color of the navigation.
`void`	`setNavigationDividerColor(int color)` Sets the color of the dividers, which are contained by the navigation.
`void`	`setNavigationSelectionColor(int color)` Sets the background color of the currently selected navigation preference.
`void`	`setNavigationWidth(int width)` Sets the width of the navigation, when using the split screen layout.
`void`	`setNextButtonText(java.lang.CharSequence text)` Sets the text of the next button, which is shown, when the activity is used as a wizard.
`void`	`setNextButtonText(int resourceId)` Sets the text of the next button, which is shown, when the activity is used as a wizard.
`void`	`setProgressFormat(int resourceId)` Sets the string, which should be used to format the progress, which is shown, when the activity is used as a wizard.
`void`	`setProgressFormat(java.lang.String progressFormat)` Sets the string, which should be used to format the progress, which is shown, when the activity is used as a wizard.
`void`	`setTitle(java.lang.CharSequence title)`
`void`	`setTitle(int resourceId)`
`void`	`setToolbarElevation(int elevation)` Sets the elevation of the activity's toolbar.
`void`	`showButtonBar(boolean show)` Shows or hides the view group, which contains the buttons, which are shown when the activity is used as a wizard.
`void`	`showProgress(boolean showProgress)` Sets, whether the progress should be shown, when the activity is used as a wizard.
`void`	`unselectNavigationPreference()` Unselects the currently selected navigation preference and hides the associated fragment, if the split screen layout is not used and the navigation is not hidden.
`void`	`useSplitScreen(boolean useSplitScreen)` Sets, whether the split screen layout should be used on tablets, or not.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - EXTRA_SHOW_FRAGMENT
```
public static final java.lang.String EXTRA_SHOW_FRAGMENT
```
    When starting this activity, the invoking intent can contain this extra string to specify which fragment should be initially displayed.
    
    See Also:
    
    Constant Field Values
  - EXTRA_SHOW_FRAGMENT_ARGUMENTS
```
public static final java.lang.String EXTRA_SHOW_FRAGMENT_ARGUMENTS
```
    When starting this activity and using EXTRA_SHOW_FRAGMENT, this extra can also be specified to supply a bundle of arguments to pass to that fragment when it is instantiated during the initial creation of the activity.
    
    See Also:
    
    Constant Field Values
  - EXTRA_SHOW_FRAGMENT_TITLE
```
public static final java.lang.String EXTRA_SHOW_FRAGMENT_TITLE
```
    When starting this activity and using EXTRA_SHOW_FRAGMENT, this extra can also be specified to supply the title to be shown for that fragment.
    
    See Also:
    
    Constant Field Values
  - EXTRA_HIDE_NAVIGATION
```
public static final java.lang.String EXTRA_HIDE_NAVIGATION
```
    When starting this activity, the invoking intent can contain this extra boolean to specify that the navigation should not be displayed. This is most often used in conjunction with EXTRA_SHOW_FRAGMENT to launch the activity to display a specific fragment that the user has navigated to.
    
    See Also:
    
    Constant Field Values
  - EXTRA_SHOW_BUTTON_BAR
```
public static final java.lang.String EXTRA_SHOW_BUTTON_BAR
```
    When starting this activity, the invoking intent can contain this extra boolean to display back and next buttons in order to use the activity as a wizard.
    
    See Also:
    
    Constant Field Values
  - EXTRA_NEXT_BUTTON_TEXT
```
public static final java.lang.String EXTRA_NEXT_BUTTON_TEXT
```
    When starting this activity and using EXTRA_SHOW_BUTTON_BAR, this extra can also be specified to supply a custom text for the next button.
    
    See Also:
    
    Constant Field Values
  - EXTRA_BACK_BUTTON_TEXT
```
public static final java.lang.String EXTRA_BACK_BUTTON_TEXT
```
    When starting this activity and using EXTRA_SHOW_BUTTON_BAR, this extra can also be specified to supply a custom text for the back button.
    
    See Also:
    
    Constant Field Values
  - EXTRA_FINISH_BUTTON_TEXT
```
public static final java.lang.String EXTRA_FINISH_BUTTON_TEXT
```
    When starting this activity and using EXTRA_SHOW_BUTTON_BAR, this extra can also be specified to supply a custom text for the back button when the last navigation preference is selected.
    
    See Also:
    
    Constant Field Values
  - EXTRA_SHOW_PROGRESS
```
public static final java.lang.String EXTRA_SHOW_PROGRESS
```
    When starting this activity using EXTRA_SHOW_BUTTON_BAR, this boolean extra can also used to specify, whether the number of the currently shown wizard step and the number of total steps should be shown as the bread crumb title.
    
    See Also:
    
    Constant Field Values
  - EXTRA_NO_BREAD_CRUMBS
```
public static final java.lang.String EXTRA_NO_BREAD_CRUMBS
```
    When starting this activity, the invoking intent can contain this extra boolean that the toolbar, which is used to show the title of the currently selected navigation preference, should not be displayed.
    
    See Also:
    
    Constant Field Values
  - EXTRA_PROGRESS_FORMAT
```
public static final java.lang.String EXTRA_PROGRESS_FORMAT
```
    When starting this activity using EXTRA_SHOW_BUTTON_BAR and EXTRA_SHOW_PROGRESS, this string extra can also be specified to supply a custom format for showing the progress. The string must be formatted according to the following syntax: "*%d*%d*%s*"
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - PreferenceActivity
```
public PreferenceActivity()
```
- Method Detail
  - addPreferenceFragmentListener
```
public final void addPreferenceFragmentListener(PreferenceFragmentListener listener)
```
    Adds a new listener, which should be notified, when the currently shown preference fragment has been changed, to the activity.
    
    Parameters:
    
    listener - The listener, which should be added, as an instance of the type PreferenceFragmentListener. The listener may not be null
  - removePreferenceFragmentListener
```
public final void removePreferenceFragmentListener(PreferenceFragmentListener listener)
```
    Removes a specific listener, which should not be notified, when the currently shown preference fragment has been changed, anymore.
    
    Parameters:
    
    listener - The listener, which should be removed, as an instance of the type PreferenceFragmentListener. The listener may not be null
  - addWizardListener
```
public final void addWizardListener(WizardListener listener)
```
    Adds a new listener, which should be notified, when the user navigates within the activity, if it is used as a wizard.
    
    Parameters:
    
    listener - The listener, which should be added, as an instance of the type WizardListener. The listener may not be null
  - removeWizardListener
```
public final void removeWizardListener(WizardListener listener)
```
    Removes a specific listener, which should not be notified, when the user navigates within the activity, if it is used as a wizard.
    
    Parameters:
    
    listener - The listener, which should be removed, as an instance of the type WizardListener. The listener may not be null
  - addNavigationListener
```
public final void addNavigationListener(NavigationListener listener)
```
    Adds a new listener, which should be notified, when a navigation preference has been added or removed to/from the activity.
    
    Parameters:
    
    listener - The listener, which should be added, as an instance of the type NavigationListener. The listener may not be null
  - removeNavigationListener
```
public final void removeNavigationListener(NavigationListener listener)
```
    Removes a specific listener, which should not be notified, when a navigation preference has been added or removed to/from the activity, anymore.
    
    Parameters:
    
    listener - The listener, which should be removed, as an instance of the type NavigationListener. The listener may not be null
  - isSplitScreen
```
public final boolean isSplitScreen()
```
    Returns, whether the split screen layout is used, or not.
    
    Returns:
    
    True, if the split screen layout is used, false otherwise
  - getNavigationFragment
```
public final PreferenceFragmentCompat getNavigationFragment()
```
    Returns the preference fragment, which contains the activity's navigation.
    
    Returns:
    
    The preference fragment, which contains the activity's navigation, as an instance of the class PreferenceFragmentCompat or null, if the navigation has not been created yet
  - getPreferenceFragment
```
public final Fragment getPreferenceFragment()
```
    Returns the currently shown preference fragment.
    
    Returns:
    
    The currently shown preference fragment as an instance of the class Fragment or null, if no preference fragment is currently shown
  - getFrameLayout
```
public final android.widget.FrameLayout getFrameLayout()
```
    Returns the frame layout, which contains the activity's views. It is the activity's root view.
    
    Returns:
    
    The frame layout, which contains the activity's views, as an instance of the class FrameLayout or null, if the activity has not been created yet
  - getCardView
```
public final CardView getCardView()
```
    Returns the card view, which contains the currently shown preference fragment, when using the split screen layout.
    
    Returns:
    
    The card view, which contains the currently shown preference fragment, when using the split screen layout, as an instance of the class CardView or null, if the activity has not been created yet or if the split screen layout is not used
  - getNavigationToolbar
```
public final Toolbar getNavigationToolbar()
```
    Returns the toolbar, which is used to show the activity's title, when using the split screen layout.
    
    Returns:
    
    The toolbar, which is used to show the activity's title, when using the split screen layout, as an instance of the class Toolbar or null, if the activity has not been created yet or if the split screen layout is not used
  - getBreadCrumbToolbar
```
public final Toolbar getBreadCrumbToolbar()
```
    Returns the toolbar, which is used to show the bread crumb of the currently selected navigation preference, when using the split screen layout.
    
    Returns:
    
    The toolbar, which is used to show the bread crumb of the currently selected navigation preference, when using the split screen layout, as an instance of the class Toolbar or null, if the activity has not been created yet or if the split screen layout is not used
  - getButtonBar
```
public final android.view.ViewGroup getButtonBar()
```
    Returns the button bar, which is shown when the activity is used as a wizard.
    
    Returns:
    
    The button bar as an instance of the class ViewGroup or null, if the activity has not been created yet
  - getNextButton
```
public final android.widget.Button getNextButton()
```
    Returns the next button, which is shown when the activity is used as a wizard and the last navigation preference is not selected.
    
    Returns:
    
    The next button as an instance of the class Button or null, if the activity has not been created yet
  - getBackButton
```
public final android.widget.Button getBackButton()
```
    Returns the back button, which is shown when the activity is used as a wizard and the first navigation preference is not selected.
    
    Returns:
    
    The back button as an instance of the class Button or null, if the activity has not been created yet
  - getFinishButton
```
public final android.widget.Button getFinishButton()
```
    Returns the finish button, which is shown when the activity is used as a wizard and the last navigation preference is selected.
    
    Returns:
    
    The finish button as an instance of the class Button or null, if the activity has not been created yet
  - useSplitScreen
```
public final void useSplitScreen(boolean useSplitScreen)
```
    Sets, whether the split screen layout should be used on tablets, or not.
    
    Parameters:
    
    useSplitScreen - True, if the split screen layout should be used on tablets, false otherwise
  - getNavigationWidth
```
public final int getNavigationWidth()
```
    Returns the width of the navigation, when using the split screen layout.
    
    Returns:
    
    The width of the navigation, when using the split screen layout, in pixels as an Integer value
  - setNavigationWidth
```
public final void setNavigationWidth(int width)
```
    Sets the width of the navigation, when using the split screen layout.
    
    Parameters:
    
    width - The width, which should be set, in pixels as an Integer value. The width must be greater than 0
  - isNavigationHidden
```
public final boolean isNavigationHidden()
```
    Returns, whether the navigation is currently hidden, or not.
    
    Returns:
    
    True, if the navigation is currently hidden, false otherwise
  - hideNavigation
```
public final void hideNavigation(boolean hideNavigation)
```
    Hides or shows the navigation. When the activity is used as a wizard on devices with a small screen, the navigation is always hidden.
    
    Parameters:
    
    hideNavigation - True, if the navigation should be hidden, false otherwise
  - isNavigationIconOverridden
```
public final boolean isNavigationIconOverridden()
```
    Returns, whether the behavior of the navigation icon of the activity's toolbar is overridden in order to return to the navigation when a preference fragment is currently shown and the split screen layout is used.
    
    Returns:
    
    True, if the behavior of the navigation icon is overridden, false otherwise
  - overrideNavigationIcon
```
public final void overrideNavigationIcon(boolean overrideNavigationIcon)
```
    Sets, whether the behavior of the navigation icon of the activity's toolbar should be overridden in order to return to the navigation when a preference screen is currently shown and the split screen layout is used, or not.
    
    Parameters:
    
    overrideNavigationIcon - True, if the behavior of the navigation icon should be overridden, false otherwise
  - isButtonBarShown
```
public final boolean isButtonBarShown()
```
    Returns, whether the activity is used as a wizard, or not.
    
    Returns:
    
    True, if the activity is used as a wizard, false otherwise
  - showButtonBar
```
public final void showButtonBar(boolean show)
```
    Shows or hides the view group, which contains the buttons, which are shown when the activity is used as a wizard.
    
    Parameters:
    
    show - True, if the button bar should be shown, false otherwise
  - getNextButtonText
```
public final java.lang.CharSequence getNextButtonText()
```
    Returns the text of the next button, which is shown, when the activity is used as a wizard.
    
    Returns:
    
    The text of the next button as an instance of the class CharSequence. The text may neither be null, nor empty
  - setNextButtonText
```
public final void setNextButtonText(int resourceId)
```
    Sets the text of the next button, which is shown, when the activity is used as a wizard.
    
    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
```
public final void setNextButtonText(java.lang.CharSequence text)
```
    Sets the text of the next button, which is shown, when the activity is used as a wizard.
    
    Parameters:
    
    text - The text, which should be set, as an instance of the class CharSequence. The text may neither be null, nor empty
  - getBackButtonText
```
public final java.lang.CharSequence getBackButtonText()
```
    Returns the text of the back button, which is shown, when the activity is used as a wizard.
    
    Returns:
    
    The text of the back button as an instance of the class CharSequence. The text may neither null, nor empty
  - setBackButtonText
```
public final void setBackButtonText(int resourceId)
```
    Sets the text of the back button, which is shown, when the activity is used as a wizard.
    
    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
```
public final void setBackButtonText(java.lang.CharSequence text)
```
    Sets the text of the back button, which is shown, when the activity is used as a wizard.
    
    Parameters:
    
    text - The text, which should be set, as an instance of the class CharSequence. The text may neither null, nor empty
  - getFinishButtonText
```
public final java.lang.CharSequence getFinishButtonText()
```
    Returns the text of the finish button, which is shown, when the activity is used as a wizard and the last navigation preference is currently selected.
    
    Returns:
    
    The text of the finish button as an instance of the class CharSequence. The text may neither be null, nor empty
  - setFinishButtonText
```
public final void setFinishButtonText(int resourceId)
```
    Sets the text of the next button, which is shown, when the activity is used as a wizard and the last navigation preference is currently selected.
    
    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
```
public final void setFinishButtonText(java.lang.CharSequence text)
```
    Sets the text of the next button, which is shown, when the activity is used as a wizard and the last navigation preference is currently selected.
    
    Parameters:
    
    text - The text, which should be set, as an instance of the class CharSequence. The text may neither be null, nor empty
  - isProgressShown
```
public final boolean isProgressShown()
```
    Returns, whether the progress is shown, if the activity is used as a wizard.
    
    Returns:
    
    True, if the progress is shown, false otherwise or if the activity is not used as a wizard
  - showProgress
```
public final void showProgress(boolean showProgress)
```
    Sets, whether the progress should be shown, when the activity is used as a wizard.
    
    Parameters:
    
    showProgress - True, if the progress should be shown, when the activity is used as a wizard, false otherwise
  - getProgressFormat
```
public final java.lang.String getProgressFormat()
```
    Returns the string, which is used to format the progress, which is shown, when the activity is used as a wizard.
    
    Returns:
    
    The string, which is used to format the progress, as a String. The string may neither be null, nor empty
  - setProgressFormat
```
public final void setProgressFormat(int resourceId)
```
    Sets the string, which should be used to format the progress, which is shown, when the activity is used as a wizard.
    
    Parameters:
    
    resourceId - The resource id of the string, which should be set, as an Integer value. The resource id must correspond to a valid string resource. It must be formatted according to the following syntax: "*%d*%d*%s*"
  - setProgressFormat
```
public final void setProgressFormat(java.lang.String progressFormat)
```
    Sets the string, which should be used to format the progress, which is shown, when the activity is used as a wizard.
    
    Parameters:
    
    progressFormat - The string, which should be set, as a String. The string may neither be null, nor empty. It must be formatted according to the following syntax: "*%d*%d*%s*"
  - isBreadCrumbHidden
```
public final boolean isBreadCrumbHidden()
```
    Returns, whether the toolbar, which is used to show the bread crumb of the currently selected navigation preference, is hidden, or not.
    
    Returns:
    
    True, if the toolbar, which is used to show the bread crumb of the currently selected navigation preference, is hidden, false otherwise
  - hideBreadCrumb
```
public final void hideBreadCrumb(boolean hide)
```
    Sets, whether the toolbar, which is used to show the bread crumb of the currently selected navigation preference, should be hidden, or not.
    
    Parameters:
    
    hide - True, if the toolbar, which is used to show the bread crumb of the currently selected navigation preference, should be hidden, false otherwise
  - getToolbarElevation
```
public final int getToolbarElevation()
```
    Returns the elevation of the activity's toolbar.
    
    Returns:
    
    The elevation of the activity's toolbar in dp as an Integer value
  - setToolbarElevation
```
public final void setToolbarElevation(int elevation)
```
    Sets the elevation of the activity's toolbar.
    
    Parameters:
    
    elevation - The elevation, which should be set, in dp as an Integer value. The elevation must be at least 0 and at maximum 16
  - getBreadCrumbElevation
```
public final int getBreadCrumbElevation()
```
    Returns the elevation of the toolbar, which is used to show the bread crumb of the currently selected navigation preference, when using the split screen layout.
    
    Returns:
    
    The elevation of the toolbar, which is used to show the bread crumb of the currently selected navigation preference, when using the split screen layout, in dp as an Integer value
  - setBreadCrumbElevation
```
public final void setBreadCrumbElevation(int elevation)
```
    Sets the elevation of the toolbar, which is used to show the bread crumb of the currently selected navigation preference, when using the split screen layout.
    
    Parameters:
    
    elevation - The elevation, which should be set, in dp as an Integer value. The elevation must be at least 0 and at maximum 16
  - getCardViewElevation
```
public final int getCardViewElevation()
```
    Returns the elevation of the card view, which contains the currently shown preference fragment, when using the split screen layout.
    
    Returns:
    
    The elevation of the card view, which contains the currently shown preference fragment, when using the split screen layout, in dp as an Integer value
  - setCardViewElevation
```
public final void setCardViewElevation(int elevation)
```
    Sets the elevation of the card view, which contains the currently shown prefernce fragment, when using the split screen layout.
    
    Parameters:
    
    elevation - The elevation, which should be set, in dp as an Integer value. The elevation must be at least 0 and at maximum 16
  - getButtonBarElevation
```
public final int getButtonBarElevation()
```
    Returns the elevation of the button bar, which is shown when using the activity as a wizard.
    
    Returns:
    
    The elevation of the button bar, which is shown when using the activity as a wizard, in dp as an Integer value
  - setButtonBarElevation
```
public final void setButtonBarElevation(int elevation)
```
    Sets the elevation of the button bar, which is shown when using the activity as a wizard.
    
    Parameters:
    
    elevation - The elevation, which should be set, in dp as an Integer value. The elevation must be at least 0 and at maximum 16
  - getCardViewBackgroundColor
```
public final int getCardViewBackgroundColor()
```
    Returns the background color of the card view, which contains the currently shown preference fragment, when using the split screen layout.
    
    Returns:
    
    The background color of the card view, which contains the currently shown preference fragment, when using the split screen layout, as an Integer value
  - setCardViewBackgroundColor
```
public final void setCardViewBackgroundColor(int color)
```
    Sets the background color of the card view, which contains the currently shown preference fragment, when using the split screen layout.
    
    Parameters:
    
    color - The background color, which should be set, as an Integer value
  - getBreadCrumbBackgroundColor
```
public final int getBreadCrumbBackgroundColor()
```
    Returns the background color of the toolbar, which is used to show the bread crumb of the currently selected navigation preference, when using the split screen layout.
    
    Returns:
    
    The background color of the toolbar, which is used to show the bread crumb of the currently selected navigation preference, when using the split screen klayout, as an Integer value
  - setBreadCrumbBackgroundColor
```
public final void setBreadCrumbBackgroundColor(int color)
```
    Sets the background color of the toolbar, which is used to show the bread crumb of the currently selected navigation preference, when using the split screen layout.
    
    Parameters:
    
    color - The background color, which should be set, as an Integer value
  - getButtonBarBackground
```
public final android.graphics.drawable.Drawable getButtonBarBackground()
```
    Returns the background of the button bar, which is shown, when the activity is used as a wizard.
    
    Returns:
    
    The background of the button bar, which is shown, when the activity is used as a wizard, as an instance of the class Drawable or null, if no background is set
  - setButtonBarBackgroundColor
```
public final void setButtonBarBackgroundColor(int color)
```
    Sets the background of the button bar, which is shown, when the activity is used as a wizard.
    
    Parameters:
    
    color - The background color, which should be set, as an Integer value
  - setButtonBarBackground
```
public final void setButtonBarBackground(int resourceId)
```
    Sets the background of the button bar, which is shown, when the activity is used as a wizard.
    
    Parameters:
    
    resourceId - The resource id of the background, which should be set, as an Integer value. The resource id must correspond to a valid drawable resource
  - setButtonBarBackground
```
public final void setButtonBarBackground(android.graphics.drawable.Drawable background)
```
    Sets the background of the button bar, which is shown, when the activity is used as a wizard.
    
    Parameters:
    
    background - The background, which should be set, as an instance of the class Drawable or null, if no background should be set
  - getNavigationBackground
```
public final android.graphics.drawable.Drawable getNavigationBackground()
```
    Returns the background of the navigation.
    
    Returns:
    
    The background of the navigation as an instance of the class Drawable or null, if no background is set
  - setNavigationBackgroundColor
```
public final void setNavigationBackgroundColor(int color)
```
    Sets the background color of the navigation.
    
    Parameters:
    
    color - The background color, which should be set, as an Integer value
  - setNavigationBackground
```
public final void setNavigationBackground(int resourceId)
```
    Sets the background of the navigation.
    
    Parameters:
    
    resourceId - The resource id of the background, which should be set, as an Integer value. The resource id must correspond to a valid drawable resource
  - setNavigationBackground
```
public final void setNavigationBackground(android.graphics.drawable.Drawable background)
```
    Sets the background of the navigation.
    
    Parameters:
    
    background - The background, which should be set, as an instance of the class Drawable or null, if no background should be set
  - getNavigationSelectionColor
```
public final int getNavigationSelectionColor()
```
    Returns the background color of the currently selected navigation preference.
    
    Returns:
    
    The background color of the currently selected navigation preference as an Integer
  - setNavigationSelectionColor
```
public final void setNavigationSelectionColor(int color)
```
    Sets the background color of the currently selected navigation preference.
    
    Parameters:
    
    color - The color, which should be set, as an Integer value
  - getNavigationDividerColor
```
public final int getNavigationDividerColor()
```
    Returns the color of the dividers, which are contained by the navigation.
    
    Returns:
    
    The color of the dividers, which are contained by the navigation, as an Integer value
  - setNavigationDividerColor
```
public final void setNavigationDividerColor(int color)
```
    Sets the color of the dividers, which are contained by the navigation.
    
    Parameters:
    
    color - The color, which should be set, as an Integer value
  - isPreferenceFragmentShown
```
public final boolean isPreferenceFragmentShown()
```
    Returns, whether a preference fragment is currently shown, or not.
    
    Returns:
    
    True, if a preference fragment is currently shown, false otherwise
  - getNavigationPreferenceCount
```
public final int getNavigationPreferenceCount()
```
    Returns the number of navigation preferences, which are contained by the activity.
    
    Returns:
    
    The number of navigation preferences, which are contained by the activity, as an Integer value
  - getAllNavigationPreferences
```
public final java.util.List<NavigationPreference> getAllNavigationPreferences()
```
    Returns a list, which contains all navigation preferences, which are contained by the activity.
    
    Returns:
    
    A list, which contains all navigation preferences, which are contained by the activity, as an instance of the type List or an empty collection, if no navigation preferences are contained by the activity
  - isNavigationPreferenceSelected
```
public final boolean isNavigationPreferenceSelected()
```
    Returns, whether a navigation preference is currently selected, or not.
    
    Returns:
    
    True, if a navigation preference is currently selected, false otherwise
  - getSelectedNavigationPreference
```
public final NavigationPreference getSelectedNavigationPreference()
```
    Returns the currently selected navigation preference.
    
    Returns:
    
    The currently selected navigation preference as an instance of the class NavigationPreference or null, if no navigation preference is currently selected
  - selectNavigationPreference
```
public final void selectNavigationPreference(NavigationPreference navigationPreference)
```
    Selects a specific navigation preference.
    
    Parameters:
    
    navigationPreference - The navigation preference, which should be selected, as an instance of the class NavigationPreference. The navigation preference may not be null
  - selectNavigationPreference
```
public final void selectNavigationPreference(NavigationPreference navigationPreference,
                                             android.os.Bundle arguments)
```
    Selects a specific navigation preference.
    
    Parameters:
    
    navigationPreference - The navigation preference, which should be selected, as an instance of the class NavigationPreference. The navigation preference may not be null
    
    arguments - The arguments, which should be passed to the fragment, which is associated with the navigation preference, as an instance of the class Bundle or null, if no arguments should be passed to the fragment
  - unselectNavigationPreference
```
public final void unselectNavigationPreference()
```
    Unselects the currently selected navigation preference and hides the associated fragment, if the split screen layout is not used and the navigation is not hidden.
  - onCreateNavigation
```
protected void onCreateNavigation(PreferenceFragmentCompat fragment)
```
    The method, which is invoked on implementing subclasses, when the navigation is created. It may be overridden in order to add preferences to the preference fragment, which contains the navigation's preferences.
    
    Parameters:
    
    fragment - The preference fragment, which contains the navigation's preferences, as an instance of the class PreferenceFragmentCompat. The preference fragment may not be null
  - setTitle
```
public final void setTitle(int resourceId)
```
  - setTitle
```
public final void setTitle(java.lang.CharSequence title)
```
  - onNavigationFragmentCreated
```
public final void onNavigationFragmentCreated(PreferenceFragmentCompat fragment)
```
    Description copied from interface: NavigationFragment.Callback
    
    The method, which is invoked, when the navigation fragment has been attached to its activity.
    
    Specified by:
    
    onNavigationFragmentCreated in interface NavigationFragment.Callback
    
    Parameters:
    
    fragment - The navigation fragment as an instance of the class PreferenceFragmentCompat. The fragment may not be null
  - onNavigationAdapterCreated
```
public final void onNavigationAdapterCreated()
```
    Description copied from interface: NavigationFragment.Callback
    
    The method, which is invoked, when the adapter, which contains the navigation items, has been created.
    
    Specified by:
    
    onNavigationAdapterCreated in interface NavigationFragment.Callback
  - onSelectNavigationPreference
```
public final boolean onSelectNavigationPreference(NavigationPreference navigationPreference)
```
    Description copied from interface: NavigationPreferenceAdapter.Callback
    
    The method, which is invoked, when a navigation preference is about to be selected.
    
    Specified by:
    
    onSelectNavigationPreference in interface NavigationPreferenceAdapter.Callback
    
    Parameters:
    
    navigationPreference - The navigation preference, which is about to be selected, as an instance of the class NavigationPreference. The navigation preference may not be null
    
    Returns:
    
    True, if the navigation preference should be selected, false otherwise
  - onNavigationPreferenceSelected
```
public final void onNavigationPreferenceSelected(NavigationPreference navigationPreference,
                                                 android.os.Bundle arguments)
```
    Description copied from interface: NavigationPreferenceAdapter.Callback
    
    The method, which is invoked, when a navigation preference has been selected.
    
    Specified by:
    
    onNavigationPreferenceSelected in interface NavigationPreferenceAdapter.Callback
    
    Parameters:
    
    navigationPreference - The navigation preference, which has been selected, as an instance of the class NavigationPreference. The navigation preference may not be null
    
    arguments - The arguments, which should be passed to the fragment, which is associated with the navigation preference, as an instance of the class Bundle or null, if no arguments should be passed to the fragment
  - onNavigationPreferenceUnselected
```
public final void onNavigationPreferenceUnselected()
```
    Description copied from interface: NavigationPreferenceAdapter.Callback
    
    The method, which is invoked, when a navigation preference has been unselected.
    
    Specified by:
    
    onNavigationPreferenceUnselected in interface NavigationPreferenceAdapter.Callback
  - onNavigationPreferenceAdded
```
public final void onNavigationPreferenceAdded(NavigationPreference navigationPreference)
```
    Description copied from interface: NavigationPreferenceAdapter.Callback
    
    The method, which is invoked, when a navigation preference has been added.
    
    Specified by:
    
    onNavigationPreferenceAdded in interface NavigationPreferenceAdapter.Callback
    
    Parameters:
    
    navigationPreference - The navigation preference, which has been added, as an instance of the class NavigationPreference. The navigation preference may not be null
  - onNavigationPreferenceRemoved
```
public final void onNavigationPreferenceRemoved(NavigationPreference navigationPreference)
```
    Description copied from interface: NavigationPreferenceAdapter.Callback
    
    The method, which is invoked, when a navigation preference has been removed.
    
    Specified by:
    
    onNavigationPreferenceRemoved in interface NavigationPreferenceAdapter.Callback
    
    Parameters:
    
    navigationPreference - The navigation preference, which has been removed, as an instance of the class NavigationPreference. The navigation preference may not be null
  - onBackPressed
```
public void onBackPressed()
```
  - onOptionsItemSelected
```
public boolean onOptionsItemSelected(android.view.MenuItem item)
```
  - onCreate
```
protected void onCreate(android.os.Bundle savedInstanceState)
```
  - onSaveInstanceState
```
protected void onSaveInstanceState(android.os.Bundle outState)
```
  - onRestoreInstanceState
```
protected void onRestoreInstanceState(android.os.Bundle savedInstanceState)
```

Class PreferenceActivity

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EXTRA_SHOW_FRAGMENT

EXTRA_SHOW_FRAGMENT_ARGUMENTS

EXTRA_SHOW_FRAGMENT_TITLE

EXTRA_HIDE_NAVIGATION

EXTRA_SHOW_BUTTON_BAR

EXTRA_NEXT_BUTTON_TEXT

EXTRA_BACK_BUTTON_TEXT

EXTRA_FINISH_BUTTON_TEXT

EXTRA_SHOW_PROGRESS

EXTRA_NO_BREAD_CRUMBS

EXTRA_PROGRESS_FORMAT

Constructor Detail

PreferenceActivity

Method Detail

addPreferenceFragmentListener

removePreferenceFragmentListener

addWizardListener

removeWizardListener

addNavigationListener

removeNavigationListener

isSplitScreen

getNavigationFragment

getPreferenceFragment

getFrameLayout

getCardView

getNavigationToolbar

getBreadCrumbToolbar

getButtonBar

getNextButton

getBackButton

getFinishButton

useSplitScreen

getNavigationWidth

setNavigationWidth

isNavigationHidden

hideNavigation

isNavigationIconOverridden

overrideNavigationIcon

isButtonBarShown

showButtonBar

getNextButtonText

setNextButtonText

setNextButtonText

getBackButtonText

setBackButtonText

setBackButtonText

getFinishButtonText

setFinishButtonText

setFinishButtonText

isProgressShown

showProgress

getProgressFormat

setProgressFormat

setProgressFormat

isBreadCrumbHidden

hideBreadCrumb

getToolbarElevation

setToolbarElevation

getBreadCrumbElevation

setBreadCrumbElevation

getCardViewElevation

setCardViewElevation

getButtonBarElevation

setButtonBarElevation

getCardViewBackgroundColor

setCardViewBackgroundColor

getBreadCrumbBackgroundColor

setBreadCrumbBackgroundColor

getButtonBarBackground

setButtonBarBackgroundColor

setButtonBarBackground

setButtonBarBackground

getNavigationBackground

setNavigationBackgroundColor