de.mrapp.android.preference.activity.fragment

Class NavigationFragment

java.lang.Object

PreferenceFragmentCompat

de.mrapp.android.preference.activity.fragment.AbstractPreferenceFragment

de.mrapp.android.preference.activity.fragment.NavigationFragment

All Implemented Interfaces:

NavigationPreferenceAdapter.Callback

public class NavigationFragment
extends AbstractPreferenceFragment
implements NavigationPreferenceAdapter.Callback

A fragment, which contains the navigation of a PreferenceActivity.

Since:

5.0.0

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
NavigationFragment()

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 navigation.
NavigationFragment.Callback	getCallback() Returns the callback, which is notified about the fragment's events.
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 navigation.
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.
boolean	isAdapterCreated() Returns, whether the adapter, which contains the navigation preferences, has been created yet, or not.
void	onActivityCreated(android.os.Bundle savedInstanceState)
protected PreferenceAdapter	onCreatePreferenceAdapter(PreferenceScreen preferenceScreen) The method, which is invoked in order to create the adapter, which is used to manage the fragment's preferences.
void	onCreatePreferences(android.os.Bundle savedInstanceState, java.lang.String rootKey)
RecyclerView	onCreateRecyclerView(android.view.LayoutInflater inflater, android.view.ViewGroup parent, android.os.Bundle savedInstanceState)
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	onSelectNavigationPreference(NavigationPreference navigationPreference) The method, which is invoked, when a navigation preference is about to be selected.
void	selectNavigationPreference(int index, android.os.Bundle arguments) Selects a specific navigation preference.
void	setAdapterCallback(NavigationPreferenceAdapter.Callback callback) Sets the callback, which should be notified about the events of the adapter, which contains the navigation preferences.
void	setCallback(NavigationFragment.Callback callback) Sets the callback, which should be notified about the fragment's events.
void	setEnabled(boolean enabled) Sets, whether the navigation should be 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.fragment.AbstractPreferenceFragment

getDividerColor, onCreate, onCreateAdapter, onCreateView, setDividerColor

Methods inherited from class java.lang.Object

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

Constructor Detail

NavigationFragment

public NavigationFragment()

Method Detail

setCallback

public final void setCallback(NavigationFragment.Callback callback)

Sets the callback, which should be notified about the fragment's events.

Parameters:

callback - The callback, which should be set, as an instance of the type NavigationFragment.Callback or null, if no callback should be notified

getCallback

public final NavigationFragment.Callback getCallback()

Returns the callback, which is notified about the fragment's events.

Returns:

The callback, which is notified about the fragment's events, as an instance of the type NavigationFragment.Callback or null, if no callback is notified

setAdapterCallback

public final void setAdapterCallback(NavigationPreferenceAdapter.Callback callback)

Sets the callback, which should be notified about the events of the adapter, which contains the navigation preferences.

Parameters:

callback - The callback, which should be set, as an instance of the type NavigationPreferenceAdapter.Callback or null, if no callback should be notified

getNavigationPreferenceCount

public final int getNavigationPreferenceCount()

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

Returns:

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

Returns:

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

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 or null, if the adapter, which contains the navigation preferences, has not been initialized yet

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

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(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 navigation should be enabled, i.e. whether the navigation preferences should be clickable, or not.

Parameters:

enabled - True, if the navigation should be enabled, false otherwise

isAdapterCreated

public final boolean isAdapterCreated()

Returns, whether the adapter, which contains the navigation preferences, has been created yet, or not.

Returns:

True, if the adapter has been created yet, false otherwise

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

onActivityCreated

public final void onActivityCreated(android.os.Bundle savedInstanceState)

onCreatePreferences

public void onCreatePreferences(android.os.Bundle savedInstanceState,
                                java.lang.String rootKey)

onCreateRecyclerView

public final RecyclerView onCreateRecyclerView(android.view.LayoutInflater inflater,
                                               android.view.ViewGroup parent,
                                               android.os.Bundle savedInstanceState)

onCreatePreferenceAdapter

protected final PreferenceAdapter onCreatePreferenceAdapter(PreferenceScreen preferenceScreen)

Description copied from class: AbstractPreferenceFragment

The method, which is invoked in order to create the adapter, which is used to manage the fragment's preferences. This method may be overridden by subclasses in order to use custom adapters.

Overrides:

onCreatePreferenceAdapter in class AbstractPreferenceFragment

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

Returns:

The adapter, which has been created, as an instance of the class PreferenceAdapter. The adapter may not be null