de.mrapp.android.preference.activity.adapter

Class NavigationPreferenceAdapter

java.lang.Object

PreferenceGroupAdapter

de.mrapp.android.preference.activity.adapter.PreferenceAdapter

de.mrapp.android.preference.activity.adapter.NavigationPreferenceAdapter

All Implemented Interfaces:

NavigationPreference.Callback

public class NavigationPreferenceAdapter
extends PreferenceAdapter
implements NavigationPreference.Callback

A PreferenceAdapter, which is used to visualize the navigation preferences of a PreferenceActivity. It allows to register a callback at the adapter's NavigationPreferences

Since:

5.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	NavigationPreferenceAdapter.Callback Defines the callback, a class, which should be notified about the adapter's events, must implement.

Constructor Summary

Constructors

Constructor and Description
NavigationPreferenceAdapter(PreferenceScreen preferenceScreen, NavigationPreferenceAdapter.Callback callback) Creates a new PreferenceAdapter, which is used to visualize the navigation preferences of a PreferenceActivity.

Method Summary

Modifier and Type	Method and Description
java.util.List<NavigationPreference>	getAllNavigationPreferences() Returns a list, which contains all navigation preferences, which are contained by the adapter.
NavigationPreference	getNavigationPreference(int index) Returns the navigation preference, which corresponds to a specific index.
int	getNavigationPreferenceCount() Returns the number of navigation preferences, which are contained by the adapter.
NavigationPreference	getSelectedNavigationPreference() Returns the currently selected navigation preference.
int	getSelectedNavigationPreferenceIndex() Returns the index of the navigation preference, which is currently selected, among all navigation preferences.
int	indexOfNavigationPreference(NavigationPreference navigationPreference) Returns the index of a specific navigation preference among all navigation preferences, which are contained by the adapter.
void	onShowFragment(NavigationPreference navigationPreference) The method, which is invoked, when the fragment, which is associated with a specific navigation preference, should be shown.
protected void	onVisualizePreference(Preference preference, PreferenceViewHolder viewHolder) The method, which is invoked, when a specific preference is visualized.
void	selectNavigationPreference(int index, android.os.Bundle arguments) Selects a specific navigation preference.
void	selectNavigationPreference(NavigationPreference navigationPreference, android.os.Bundle arguments) Selects a specific navigation preference.
void	setEnabled(boolean enabled) Sets, whether the items of the adapter are enabled, i.e.
void	setSelectionColor(int color) Sets the background color of the currently selected navigation preference.

Methods inherited from class de.mrapp.android.preference.activity.adapter.PreferenceAdapter

onBindViewHolder

Methods inherited from class java.lang.Object

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

Constructor Detail

NavigationPreferenceAdapter

public NavigationPreferenceAdapter(PreferenceScreen preferenceScreen,
                                   NavigationPreferenceAdapter.Callback callback)

Creates a new PreferenceAdapter, which is used to visualize the navigation preferences of a PreferenceActivity.

Parameters:

preferenceScreen - The preference screen, which contains the preferences, which should be managed by the adapter, as an instance of the class PreferenceScreen. The preference screen may not be null

callback - The callback, which should be notified about the adapter's events, as an instance of the type NavigationPreferenceAdapter.Callback or null, if no callback should be notified

Method Detail

getNavigationPreferenceCount

public final int getNavigationPreferenceCount()

Returns the number of navigation preferences, which are contained by the adapter.

Returns:

The number of navigation preferences, which are contained by the adapter, 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 adapter.

Returns:

A list, which contains all navigation preferences, which are contained by the adapter, as an instance of the type List or an empty collection, if no navigation preferences are contained by the adapter

indexOfNavigationPreference

public final int indexOfNavigationPreference(NavigationPreference navigationPreference)

Returns the index of a specific navigation preference among all navigation preferences, which are contained by the adapter.

Parameters:

navigationPreference - The navigation preference, whose index should be returned, as an instance of the class NavigationPreference. The navigation preference may not be null

Returns:

The index of the given navigation preference as an Integer value or -1, if the navigation preference is not contained by the adapter

getNavigationPreference

public final NavigationPreference getNavigationPreference(int index)

Returns the navigation preference, which corresponds to a specific index.

Parameters:

index - The index of the navigation preference, which should be returned, among all navigation preferences as an Integer value

Returns:

The navigation preference, which corresponds to the given index, as an instance of the class NavigationPreference. The navigation preference may not be null

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 selected

getSelectedNavigationPreferenceIndex

public final int getSelectedNavigationPreferenceIndex()

Returns the index of the navigation preference, which is currently selected, among all navigation preferences.

Returns:

The index of the navigation preference, which is currently selected, as an Integer value or -1, if no navigation preference is selected

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 or null, if no navigation preference should be selected

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

selectNavigationPreference

public final void selectNavigationPreference(int index,
                                             android.os.Bundle arguments)

Selects a specific navigation preference.

Parameters:

index - The index of the navigation preference, which should be selected, among all navigation preferences, as an Integer value or -1, if no navigation preference should be selected

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

setSelectionColor

public final void setSelectionColor(int color)

Sets the background color of the currently selected navigation preference.

Parameters:

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

setEnabled

public final void setEnabled(boolean enabled)

Sets, whether the items of the adapter are enabled, i.e. clickable, or not.

Parameters:

enabled - True, if the items of the adapter should be enabled, false otherwise

onShowFragment

public final void onShowFragment(NavigationPreference navigationPreference)

Description copied from interface: NavigationPreference.Callback

The method, which is invoked, when the fragment, which is associated with a specific navigation preference, should be shown.

Specified by:

onShowFragment in interface NavigationPreference.Callback

Parameters:

navigationPreference - The navigation preference, whose fragment should be shown, as an instance of the class NavigationPreference. The navigation preference may not be null

onVisualizePreference

protected final void onVisualizePreference(Preference preference,
                                           PreferenceViewHolder viewHolder)

Description copied from class: PreferenceAdapter

The method, which is invoked, when a specific preference is visualized. This method may be overridden by subclasses in order to modify the appearance of the preference.

Overrides:

onVisualizePreference in class PreferenceAdapter

Parameters:

preference - The preference, which is visualized, as an instance of the class Preference. The preference may not be null

viewHolder - The view holder, which corresponds to the preference, as an instance of the class PreferenceViewHolder. The view holder may not be null