From 8721b44e8df772c7c449724364a2817ce8077889 Mon Sep 17 00:00:00 2001 From: Michael Rapp Date: Sun, 27 May 2018 03:14:25 +0200 Subject: [PATCH] Added new javadoc. --- doc/javadoc/allclasses-frame.html | 37 + doc/javadoc/allclasses-noframe.html | 37 + doc/javadoc/constant-values.html | 247 ++ .../activity/NavigationListener.html | 254 ++ .../NavigationPreference.Callback.html | 240 ++ .../NavigationPreference.SavedState.html | 327 ++ .../activity/NavigationPreference.html | 824 +++++ .../activity/PreferenceActivity.html | 2648 +++++++++++++++++ .../activity/PreferenceFragment.html | 838 ++++++ .../activity/PreferenceFragmentListener.html | 262 ++ .../activity/RestoreDefaultsListener.html | 312 ++ .../preference/activity/WizardListener.html | 356 +++ .../NavigationPreferenceAdapter.Callback.html | 328 ++ .../adapter/NavigationPreferenceAdapter.html | 636 ++++ .../activity/adapter/PreferenceAdapter.html | 355 +++ .../activity/adapter/package-frame.html | 25 + .../activity/adapter/package-summary.html | 167 ++ .../activity/adapter/package-tree.html | 151 + .../HideViewOnScrollAnimation.Direction.html | 351 +++ .../animation/HideViewOnScrollAnimation.html | 508 ++++ .../HideViewOnScrollAnimationListener.html | 273 ++ .../activity/animation/package-frame.html | 28 + .../activity/animation/package-summary.html | 178 ++ .../activity/animation/package-tree.html | 155 + .../fragment/AbstractPreferenceFragment.html | 458 +++ .../fragment/NavigationFragment.Callback.html | 258 ++ .../activity/fragment/NavigationFragment.html | 843 ++++++ .../activity/fragment/package-frame.html | 25 + .../activity/fragment/package-summary.html | 166 ++ .../activity/fragment/package-tree.html | 151 + .../preference/activity/package-frame.html | 31 + .../preference/activity/package-summary.html | 206 ++ .../preference/activity/package-tree.html | 194 ++ .../activity/view/ToolbarLarge.html | 596 ++++ .../activity/view/package-frame.html | 20 + .../activity/view/package-summary.html | 142 + .../activity/view/package-tree.html | 147 + doc/javadoc/deprecated-list.html | 122 + doc/javadoc/help-doc.html | 223 ++ doc/javadoc/index-files/index-1.html | 156 + doc/javadoc/index-files/index-10.html | 157 + doc/javadoc/index-files/index-11.html | 159 + doc/javadoc/index-files/index-12.html | 379 +++ doc/javadoc/index-files/index-13.html | 144 + doc/javadoc/index-files/index-14.html | 134 + doc/javadoc/index-files/index-15.html | 134 + doc/javadoc/index-files/index-16.html | 131 + doc/javadoc/index-files/index-2.html | 130 + doc/javadoc/index-files/index-3.html | 135 + doc/javadoc/index-files/index-4.html | 196 ++ doc/javadoc/index-files/index-5.html | 377 +++ doc/javadoc/index-files/index-6.html | 166 ++ doc/javadoc/index-files/index-7.html | 179 ++ doc/javadoc/index-files/index-8.html | 184 ++ doc/javadoc/index-files/index-9.html | 304 ++ doc/javadoc/index.html | 75 + doc/javadoc/overview-frame.html | 25 + doc/javadoc/overview-summary.html | 149 + doc/javadoc/overview-tree.html | 245 ++ doc/javadoc/package-list | 5 + doc/javadoc/script.js | 30 + doc/javadoc/stylesheet.css | 574 ++++ 62 files changed, 17287 insertions(+) create mode 100644 doc/javadoc/allclasses-frame.html create mode 100644 doc/javadoc/allclasses-noframe.html create mode 100644 doc/javadoc/constant-values.html create mode 100644 doc/javadoc/de/mrapp/android/preference/activity/NavigationListener.html create mode 100644 doc/javadoc/de/mrapp/android/preference/activity/NavigationPreference.Callback.html create mode 100644 doc/javadoc/de/mrapp/android/preference/activity/NavigationPreference.SavedState.html create mode 100644 doc/javadoc/de/mrapp/android/preference/activity/NavigationPreference.html create mode 100644 doc/javadoc/de/mrapp/android/preference/activity/PreferenceActivity.html create mode 100644 doc/javadoc/de/mrapp/android/preference/activity/PreferenceFragment.html create mode 100644 doc/javadoc/de/mrapp/android/preference/activity/PreferenceFragmentListener.html create mode 100644 doc/javadoc/de/mrapp/android/preference/activity/RestoreDefaultsListener.html create mode 100644 doc/javadoc/de/mrapp/android/preference/activity/WizardListener.html create mode 100644 doc/javadoc/de/mrapp/android/preference/activity/adapter/NavigationPreferenceAdapter.Callback.html create mode 100644 doc/javadoc/de/mrapp/android/preference/activity/adapter/NavigationPreferenceAdapter.html create mode 100644 doc/javadoc/de/mrapp/android/preference/activity/adapter/PreferenceAdapter.html create mode 100644 doc/javadoc/de/mrapp/android/preference/activity/adapter/package-frame.html create mode 100644 doc/javadoc/de/mrapp/android/preference/activity/adapter/package-summary.html create mode 100644 doc/javadoc/de/mrapp/android/preference/activity/adapter/package-tree.html create mode 100644 doc/javadoc/de/mrapp/android/preference/activity/animation/HideViewOnScrollAnimation.Direction.html create mode 100644 doc/javadoc/de/mrapp/android/preference/activity/animation/HideViewOnScrollAnimation.html create mode 100644 doc/javadoc/de/mrapp/android/preference/activity/animation/HideViewOnScrollAnimationListener.html create mode 100644 doc/javadoc/de/mrapp/android/preference/activity/animation/package-frame.html create mode 100644 doc/javadoc/de/mrapp/android/preference/activity/animation/package-summary.html create mode 100644 doc/javadoc/de/mrapp/android/preference/activity/animation/package-tree.html create mode 100644 doc/javadoc/de/mrapp/android/preference/activity/fragment/AbstractPreferenceFragment.html create mode 100644 doc/javadoc/de/mrapp/android/preference/activity/fragment/NavigationFragment.Callback.html create mode 100644 doc/javadoc/de/mrapp/android/preference/activity/fragment/NavigationFragment.html create mode 100644 doc/javadoc/de/mrapp/android/preference/activity/fragment/package-frame.html create mode 100644 doc/javadoc/de/mrapp/android/preference/activity/fragment/package-summary.html create mode 100644 doc/javadoc/de/mrapp/android/preference/activity/fragment/package-tree.html create mode 100644 doc/javadoc/de/mrapp/android/preference/activity/package-frame.html create mode 100644 doc/javadoc/de/mrapp/android/preference/activity/package-summary.html create mode 100644 doc/javadoc/de/mrapp/android/preference/activity/package-tree.html create mode 100644 doc/javadoc/de/mrapp/android/preference/activity/view/ToolbarLarge.html create mode 100644 doc/javadoc/de/mrapp/android/preference/activity/view/package-frame.html create mode 100644 doc/javadoc/de/mrapp/android/preference/activity/view/package-summary.html create mode 100644 doc/javadoc/de/mrapp/android/preference/activity/view/package-tree.html create mode 100644 doc/javadoc/deprecated-list.html create mode 100644 doc/javadoc/help-doc.html create mode 100644 doc/javadoc/index-files/index-1.html create mode 100644 doc/javadoc/index-files/index-10.html create mode 100644 doc/javadoc/index-files/index-11.html create mode 100644 doc/javadoc/index-files/index-12.html create mode 100644 doc/javadoc/index-files/index-13.html create mode 100644 doc/javadoc/index-files/index-14.html create mode 100644 doc/javadoc/index-files/index-15.html create mode 100644 doc/javadoc/index-files/index-16.html create mode 100644 doc/javadoc/index-files/index-2.html create mode 100644 doc/javadoc/index-files/index-3.html create mode 100644 doc/javadoc/index-files/index-4.html create mode 100644 doc/javadoc/index-files/index-5.html create mode 100644 doc/javadoc/index-files/index-6.html create mode 100644 doc/javadoc/index-files/index-7.html create mode 100644 doc/javadoc/index-files/index-8.html create mode 100644 doc/javadoc/index-files/index-9.html create mode 100644 doc/javadoc/index.html create mode 100644 doc/javadoc/overview-frame.html create mode 100644 doc/javadoc/overview-summary.html create mode 100644 doc/javadoc/overview-tree.html create mode 100644 doc/javadoc/package-list create mode 100644 doc/javadoc/script.js create mode 100644 doc/javadoc/stylesheet.css diff --git a/doc/javadoc/allclasses-frame.html b/doc/javadoc/allclasses-frame.html new file mode 100644 index 0000000..ec646af --- /dev/null +++ b/doc/javadoc/allclasses-frame.html @@ -0,0 +1,37 @@ + + + + + +All Classes + + + + + +

All Classes

+
+ +
+ + diff --git a/doc/javadoc/allclasses-noframe.html b/doc/javadoc/allclasses-noframe.html new file mode 100644 index 0000000..c4076c2 --- /dev/null +++ b/doc/javadoc/allclasses-noframe.html @@ -0,0 +1,37 @@ + + + + + +All Classes + + + + + +

All Classes

+
+ +
+ + diff --git a/doc/javadoc/constant-values.html b/doc/javadoc/constant-values.html new file mode 100644 index 0000000..b2468de --- /dev/null +++ b/doc/javadoc/constant-values.html @@ -0,0 +1,247 @@ + + + + + +Constant Field Values + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Constant Field Values

+

Contents

+ +
+
+ + +

de.mrapp.*

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/javadoc/de/mrapp/android/preference/activity/NavigationListener.html b/doc/javadoc/de/mrapp/android/preference/activity/NavigationListener.html new file mode 100644 index 0000000..0b0f46b --- /dev/null +++ b/doc/javadoc/de/mrapp/android/preference/activity/NavigationListener.html @@ -0,0 +1,254 @@ + + + + + +NavigationListener + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
de.mrapp.android.preference.activity
+

Interface NavigationListener

+
+
+
+
    +
  • +
    +
    +
    public interface NavigationListener
    +
    Defines the interface, a class, which should be notified when NavigationPreferences are + added or removed to/from a PreferenceActivity, must implement.
    +
    +
    Since:
    +
    5.0.0
    +
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        onNavigationPreferenceAdded

        +
        void onNavigationPreferenceAdded(@NonNull
+                                 NavigationPreference navigationPreference)
        +
        The method, which is invoked, when a navigation preference has been added.
        +
        +
        Parameters:
        +
        navigationPreference - The navigation preference, which has been added, as an instance of the class NavigationPreference. The navigation preference may not be null
        +
        +
        • +
      + + + +
        +
      • +

        onNavigationPreferenceRemoved

        +
        void onNavigationPreferenceRemoved(@NonNull
+                                   NavigationPreference navigationPreference)
        +
        The method, which is invoked, when a navigation preference has been removed.
        +
        +
        Parameters:
        +
        navigationPreference - The navigation preference, which has been removed, as an instance of the class NavigationPreference. The navigation preference may not be null
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/doc/javadoc/de/mrapp/android/preference/activity/NavigationPreference.Callback.html b/doc/javadoc/de/mrapp/android/preference/activity/NavigationPreference.Callback.html new file mode 100644 index 0000000..25f8423 --- /dev/null +++ b/doc/javadoc/de/mrapp/android/preference/activity/NavigationPreference.Callback.html @@ -0,0 +1,240 @@ + + + + + +NavigationPreference.Callback + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
de.mrapp.android.preference.activity
+

Interface NavigationPreference.Callback

+
+
+
+
    +
  • +
    +
    All Known Implementing Classes:
    +
    NavigationPreferenceAdapter
    +
    +
    +
    Enclosing class:
    +
    NavigationPreference
    +
    +
    +
    +
    public static interface NavigationPreference.Callback
    +
    Defines the callback, a class, which should be notified, when the fragment, which is + associated with a navigation preference, should be shown, must implement.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        onShowFragment

        +
        void onShowFragment(@NonNull
+                    NavigationPreference navigationPreference)
        +
        The method, which is invoked, when the fragment, which is associated with a specific + navigation preference, should be shown.
        +
        +
        Parameters:
        +
        navigationPreference - The navigation preference, whose fragment should be shown, as an instance of the + class NavigationPreference. The navigation preference may not be null
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/doc/javadoc/de/mrapp/android/preference/activity/NavigationPreference.SavedState.html b/doc/javadoc/de/mrapp/android/preference/activity/NavigationPreference.SavedState.html new file mode 100644 index 0000000..03b73e7 --- /dev/null +++ b/doc/javadoc/de/mrapp/android/preference/activity/NavigationPreference.SavedState.html @@ -0,0 +1,327 @@ + + + + + +NavigationPreference.SavedState + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
de.mrapp.android.preference.activity
+

Class NavigationPreference.SavedState

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    android.os.Parcelable
    +
    +
    +
    Enclosing class:
    +
    NavigationPreference
    +
    +
    +
    +
    public static class NavigationPreference.SavedState
+extends de.mrapp.android.util.view.AbstractSavedState
    +
    A data structure, which allows to save the internal state of a NavigationPreference.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      +
        +
      • + + +

        Nested classes/interfaces inherited from interface android.os.Parcelable

        +android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>
        • +
      +
      • +
    + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static android.os.Parcelable.Creator<NavigationPreference.SavedState>CREATOR +
      A creator, which allows to create instances of the class NavigationPreference.SavedState from + parcels.
      +
      +
        +
      • + + +

        Fields inherited from interface android.os.Parcelable

        +CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE
        • +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      voidwriteToParcel(android.os.Parcel dest, + int flags) 
      +
        +
      • + + +

        Methods inherited from class de.mrapp.android.util.view.AbstractSavedState

        +describeContents, getSuperState
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Method Detail

      + + + +
        +
      • +

        writeToParcel

        +
        public final void writeToParcel(android.os.Parcel dest,
+                                int flags)
        +
        +
        Specified by:
        +
        writeToParcel in interface android.os.Parcelable
        +
        Overrides:
        +
        writeToParcel in class de.mrapp.android.util.view.AbstractSavedState
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/doc/javadoc/de/mrapp/android/preference/activity/NavigationPreference.html b/doc/javadoc/de/mrapp/android/preference/activity/NavigationPreference.html new file mode 100644 index 0000000..f08e9d0 --- /dev/null +++ b/doc/javadoc/de/mrapp/android/preference/activity/NavigationPreference.html @@ -0,0 +1,824 @@ + + + + + +NavigationPreference + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
de.mrapp.android.preference.activity
+

Class NavigationPreference

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Comparable<android.support.v7.preference.Preference>
    +
    +
    +
    +
    public class NavigationPreference
+extends android.support.v7.preference.Preference
    +
    A preference, which allows to show a fragment within a PreferenceActivity when clicked.
    +
    +
    Since:
    +
    5.0.0
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      + + + + + + + + + + + + + + +
      Nested Classes 
      Modifier and TypeClass and Description
      static interface NavigationPreference.Callback +
      Defines the callback, a class, which should be notified, when the fragment, which is + associated with a navigation preference, should be shown, must implement.
      +
      static class NavigationPreference.SavedState +
      A data structure, which allows to save the internal state of a NavigationPreference.
      +
      +
        +
      • + + +

        Nested classes/interfaces inherited from class android.support.v7.preference.Preference

        +android.support.v7.preference.Preference.BaseSavedState, android.support.v7.preference.Preference.OnPreferenceChangeListener, android.support.v7.preference.Preference.OnPreferenceClickListener
        • +
      +
      • +
    + +
      +
    • + + +

      Field Summary

      +
        +
      • + + +

        Fields inherited from class android.support.v7.preference.Preference

        +DEFAULT_ORDER
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      NavigationPreference(android.content.Context context) +
      Creates a new preference, which allows to show a preference screen within a PreferenceActivity when clicked.
      +
      NavigationPreference(android.content.Context context, + android.util.AttributeSet attributeSet) +
      Creates a new preference, which allows to show a preference screen within a PreferenceActivity when clicked.
      +
      NavigationPreference(android.content.Context context, + android.util.AttributeSet attributeSet, + int defaultStyle) +
      Creates a new preference, which allows to show a preference screen within a PreferenceActivity when clicked.
      +
      NavigationPreference(android.content.Context context, + android.util.AttributeSet attributeSet, + int defaultStyle, + int defaultStyleResource) +
      Creates a new preference, which allows to show a preference screen within a PreferenceActivity when clicked.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      java.lang.CharSequencegetBreadCrumbTitle() +
      Returns the breadcrumb title, which is shown, when showing the fragment, which is associated + with the preference.
      +
      android.os.BundlegetExtras() +
      Returns the arguments, which are passed to the fragment, which is associated with the + preference.
      +
      java.lang.StringgetFragment() +
      Returns the fully classified class name of the fragment, which is associated with the + preference.
      +
      android.content.res.ColorStateListgetIconTintList() +
      Returns the color state list, which is used to tint the preference's icon.
      +
      android.graphics.PorterDuff.ModegetIconTintMode() +
      Returns the mode, which is used to tint the preference's icon.
      +
      protected voidonRestoreInstanceState(android.os.Parcelable state) 
      protected android.os.ParcelableonSaveInstanceState() 
      voidperformClick() +
      Performs a click on the preference.
      +
      voidsetBreadCrumbTitle(java.lang.CharSequence breadCrumbTitle) +
      Sets the breadcrumb title, which should be shown, when showing the fragment, which is + associated with the preference.
      +
      voidsetBreadCrumbTitle(int resourceId) +
      Sets the breadcrumb title, which should be shown, when showing the fragment, which is + associated with the preference.
      +
      voidsetCallback(NavigationPreference.Callback callback) +
      Sets the callback, which should be notified, when the fragment, which is associated with the + preference, should be shown.
      +
      voidsetExtras(android.os.Bundle extras) +
      Sets the argument, which should be passed to the fragment, which is associated with the + preference.
      +
      voidsetFragment(java.lang.String fragment) +
      Sets the fully classified class name of the fragment, which should be associated with the + preference.
      +
      voidsetIcon(android.graphics.drawable.Drawable icon) 
      voidsetIconTint(int color) +
      Sets the color, which should be used to tint the preference's icon.
      +
      voidsetIconTintList(android.content.res.ColorStateList tintList) +
      Sets the color state list, which should be used to tint the preference's icon.
      +
      voidsetIconTintMode(android.graphics.PorterDuff.Mode tintMode) +
      Sets the mode, which should be used to tint the preference's icon.
      +
      voidsetOnPreferenceClickListener(android.support.v7.preference.Preference.OnPreferenceClickListener listener) 
      +
        +
      • + + +

        Methods inherited from class android.support.v7.preference.Preference

        +callChangeListener, clearWasDetached, compareTo, findPreferenceInHierarchy, getContext, getDependency, getIcon, getIntent, getKey, getLayoutResource, getOnPreferenceChangeListener, getOnPreferenceClickListener, getOrder, getParent, getPersistedBoolean, getPersistedFloat, getPersistedInt, getPersistedLong, getPersistedString, getPersistedStringSet, getPreferenceDataStore, getPreferenceManager, getSharedPreferences, getShouldDisableView, getSummary, getTitle, getWidgetLayoutResource, hasKey, isEnabled, isIconSpaceReserved, isPersistent, isSelectable, isSingleLineTitle, isVisible, notifyChanged, notifyDependencyChange, notifyHierarchyChanged, onAttached, onAttachedToHierarchy, onAttachedToHierarchy, onBindViewHolder, onClick, onDependencyChanged, onDetached, onGetDefaultValue, onInitializeAccessibilityNodeInfo, onParentChanged, onPrepareForRemoval, onSetInitialValue, peekExtras, performClick, persistBoolean, persistFloat, persistInt, persistLong, persistString, persistStringSet, restoreHierarchyState, saveHierarchyState, setDefaultValue, setDependency, setEnabled, setIcon, setIconSpaceReserved, setIntent, setKey, setLayoutResource, setOnPreferenceChangeListener, setOrder, setPersistent, setPreferenceDataStore, setSelectable, setShouldDisableView, setSingleLineTitle, setSummary, setSummary, setTitle, setTitle, setViewId, setVisible, setWidgetLayoutResource, shouldDisableDependents, shouldPersist, toString, wasDetached
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        NavigationPreference

        +
        public NavigationPreference(@NonNull
+                            android.content.Context context)
        +
        Creates a new preference, which allows to show a preference screen within a PreferenceActivity when clicked.
        +
        +
        Parameters:
        +
        context - The context, which should be used by the preference, as an instance of the class + Context. The context may not be null
        +
        +
        • +
      + + + +
        +
      • +

        NavigationPreference

        +
        public NavigationPreference(@NonNull
+                            android.content.Context context,
+                            @Nullable
+                            android.util.AttributeSet attributeSet)
        +
        Creates a new preference, which allows to show a preference screen within a PreferenceActivity when clicked.
        +
        +
        Parameters:
        +
        context - The context, which should be used by the preference, as an instance of the class + Context. The context may not be null
        +
        attributeSet - The attributes of the XML tag that is inflating the preference, as an instance of the + type AttributeSet or null, if no attributes are available
        +
        +
        • +
      + + + +
        +
      • +

        NavigationPreference

        +
        public NavigationPreference(@NonNull
+                            android.content.Context context,
+                            @Nullable
+                            android.util.AttributeSet attributeSet,
+                            @AttrRes
+                            int defaultStyle)
        +
        Creates a new preference, which allows to show a preference screen within a PreferenceActivity when clicked.
        +
        +
        Parameters:
        +
        context - The context, which should be used by the preference, as an instance of the class + Context. The context may not be null
        +
        attributeSet - The attributes of the XML tag that is inflating the preference, as an instance of the + type AttributeSet or null, if no attributes are available
        +
        defaultStyle - The default style to apply to this preference. If 0, no style will be applied (beyond + what is included in the theme). This may either be an attribute resource, whose value + will be retrieved from the current theme, or an explicit style resource
        +
        +
        • +
      + + + +
        +
      • +

        NavigationPreference

        +
        public NavigationPreference(@NonNull
+                            android.content.Context context,
+                            @Nullable
+                            android.util.AttributeSet attributeSet,
+                            @AttrRes
+                            int defaultStyle,
+                            @StyleRes
+                            int defaultStyleResource)
        +
        Creates a new preference, which allows to show a preference screen within a PreferenceActivity when clicked.
        +
        +
        Parameters:
        +
        context - The context, which should be used by the preference, as an instance of the class + Context. The context may not be null
        +
        attributeSet - The attributes of the XML tag that is inflating the preference, as an instance of the + type AttributeSet or null, if no attributes are available
        +
        defaultStyle - The default style to apply to this preference. If 0, no style will be applied (beyond + what is included in the theme). This may either be an attribute resource, whose value + will be retrieved from the current theme, or an explicit style resource
        +
        defaultStyleResource - A resource identifier of a style resource that supplies default values for the + preference, used only if the default style is 0 or can not be found in the theme. Can + be 0 to not look for defaults
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setCallback

        +
        public final void setCallback(@Nullable
+                              NavigationPreference.Callback callback)
        +
        Sets the callback, which should be notified, when the fragment, which is associated with the + preference, should be shown.
        +
        +
        Parameters:
        +
        callback - The callback, which should be set, as an instance of the type NavigationPreference.Callback or + null, if no callback should be notified
        +
        +
        • +
      + + + +
        +
      • +

        performClick

        +
        public final void performClick()
        +
        Performs a click on the preference.
        +
        +
        Overrides:
        +
        performClick in class android.support.v7.preference.Preference
        +
        +
        • +
      + + + +
        +
      • +

        getBreadCrumbTitle

        +
        @Nullable
+public final java.lang.CharSequence getBreadCrumbTitle()
        +
        Returns the breadcrumb title, which is shown, when showing the fragment, which is associated + with the preference.
        +
        +
        Returns:
        +
        The breadcrumb title, which is shown, when showing the fragment, which is associated + with the preference, as an instance of the type CharSequence or null, if no + breadcrumb title is available
        +
        +
        • +
      + + + +
        +
      • +

        setBreadCrumbTitle

        +
        public final void setBreadCrumbTitle(@StringRes
+                                     int resourceId)
        +
        Sets the breadcrumb title, which should be shown, when showing the fragment, which is + associated with the preference.
        +
        +
        Parameters:
        +
        resourceId - The resource id of the breadcrumb title, which should be set, as an Integer + value. The resource id must correspond to a valid string resource
        +
        +
        • +
      + + + +
        +
      • +

        setBreadCrumbTitle

        +
        public final void setBreadCrumbTitle(@Nullable
+                                     java.lang.CharSequence breadCrumbTitle)
        +
        Sets the breadcrumb title, which should be shown, when showing the fragment, which is + associated with the preference.
        +
        +
        Parameters:
        +
        breadCrumbTitle - The breadcrumb title, which should be set, as an instance of the type CharSequence or null, if no breadcrumb title should be set
        +
        +
        • +
      + + + +
        +
      • +

        getFragment

        +
        @Nullable
+public final java.lang.String getFragment()
        +
        Returns the fully classified class name of the fragment, which is associated with the + preference.
        +
        +
        Overrides:
        +
        getFragment in class android.support.v7.preference.Preference
        +
        Returns:
        +
        The fully classified class name of the fragment, which is associated with the + preference, as a String or null, if no fragment is associated with the preference
        +
        +
        • +
      + + + +
        +
      • +

        setFragment

        +
        public final void setFragment(@Nullable
+                              java.lang.String fragment)
        +
        Sets the fully classified class name of the fragment, which should be associated with the + preference.
        +
        +
        Overrides:
        +
        setFragment in class android.support.v7.preference.Preference
        +
        Parameters:
        +
        fragment - The fully classified class name of the fragment, which should be set, as a String or null, if no fragment should be set
        +
        +
        • +
      + + + +
        +
      • +

        getExtras

        +
        @Nullable
+public final android.os.Bundle getExtras()
        +
        Returns the arguments, which are passed to the fragment, which is associated with the + preference.
        +
        +
        Overrides:
        +
        getExtras in class android.support.v7.preference.Preference
        +
        Returns:
        +
        The arguments, which are passed to the fragment, which is associated with the + preference, as an instance of the class Bundle or null, if no arguments are passed to + the fragment
        +
        +
        • +
      + + + +
        +
      • +

        setExtras

        +
        public final void setExtras(@Nullable
+                            android.os.Bundle extras)
        +
        Sets the argument, which should be passed to the fragment, which is associated with the + preference.
        +
        +
        Parameters:
        +
        extras - The arguments, which should be set, as an instance of the class Bundle or + null, if no arguments should be passed to the fragment
        +
        +
        • +
      + + + +
        +
      • +

        getIconTintList

        +
        public final android.content.res.ColorStateList getIconTintList()
        +
        Returns the color state list, which is used to tint the preference's icon.
        +
        +
        Returns:
        +
        The color state list, which is used to tint the preference's icon as an instance of + the class ColorStateList or null, if no color state list has been set
        +
        +
        • +
      + + + +
        +
      • +

        setIconTint

        +
        public final void setIconTint(int color)
        +
        Sets the color, which should be used to tint the preference's icon.
        +
        +
        Parameters:
        +
        color - The color, which should be set, as an Integer value
        +
        +
        • +
      + + + +
        +
      • +

        setIconTintList

        +
        public final void setIconTintList(@Nullable
+                                  android.content.res.ColorStateList tintList)
        +
        Sets the color state list, which should be used to tint the preference's icon.
        +
        +
        Parameters:
        +
        tintList - The color state list, which should be set, as an instance of the class ColorStateList or null, if no color state list should be set
        +
        +
        • +
      + + + +
        +
      • +

        getIconTintMode

        +
        @NonNull
+public final android.graphics.PorterDuff.Mode getIconTintMode()
        +
        Returns the mode, which is used to tint the preference's icon.
        +
        +
        Returns:
        +
        The mode, which is used to tint the preference's icon, as a value of the enum PorterDuff.Mode. The mode may not be null
        +
        +
        • +
      + + + +
        +
      • +

        setIconTintMode

        +
        public final void setIconTintMode(@NonNull
+                                  android.graphics.PorterDuff.Mode tintMode)
        +
        Sets the mode, which should be used to tint the preference's icon.
        +
        +
        Parameters:
        +
        tintMode - The mode, which should be set, as a value of the enum PorterDuff.Mode. The + mode may not be null
        +
        +
        • +
      + + + +
        +
      • +

        setIcon

        +
        public void setIcon(android.graphics.drawable.Drawable icon)
        +
        +
        Overrides:
        +
        setIcon in class android.support.v7.preference.Preference
        +
        +
        • +
      + + + +
        +
      • +

        setOnPreferenceClickListener

        +
        public final void setOnPreferenceClickListener(@Nullable
+                                               android.support.v7.preference.Preference.OnPreferenceClickListener listener)
        +
        +
        Overrides:
        +
        setOnPreferenceClickListener in class android.support.v7.preference.Preference
        +
        +
        • +
      + + + +
        +
      • +

        onSaveInstanceState

        +
        protected final android.os.Parcelable onSaveInstanceState()
        +
        +
        Overrides:
        +
        onSaveInstanceState in class android.support.v7.preference.Preference
        +
        +
        • +
      + + + +
        +
      • +

        onRestoreInstanceState

        +
        protected final void onRestoreInstanceState(android.os.Parcelable state)
        +
        +
        Overrides:
        +
        onRestoreInstanceState in class android.support.v7.preference.Preference
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/doc/javadoc/de/mrapp/android/preference/activity/PreferenceActivity.html b/doc/javadoc/de/mrapp/android/preference/activity/PreferenceActivity.html new file mode 100644 index 0000000..3403513 --- /dev/null +++ b/doc/javadoc/de/mrapp/android/preference/activity/PreferenceActivity.html @@ -0,0 +1,2648 @@ + + + + + +PreferenceActivity + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
de.mrapp.android.preference.activity
+

Class PreferenceActivity

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    android.arch.lifecycle.LifecycleOwner, android.arch.lifecycle.ViewModelStoreOwner, android.content.ComponentCallbacks, android.content.ComponentCallbacks2, android.support.v4.app.ActivityCompat.OnRequestPermissionsResultCallback, android.support.v4.app.ActivityCompat.RequestPermissionsRequestCodeValidator, android.support.v4.app.TaskStackBuilder.SupportParentable, android.support.v7.app.ActionBarDrawerToggle.DelegateProvider, android.support.v7.app.AppCompatCallback, android.view.KeyEvent.Callback, android.view.LayoutInflater.Factory, android.view.LayoutInflater.Factory2, android.view.View.OnCreateContextMenuListener, android.view.Window.Callback, NavigationPreferenceAdapter.Callback, NavigationFragment.Callback
    +
    +
    +
    +
    public abstract class PreferenceActivity
+extends android.support.v7.app.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
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      +
        +
      • + + +

        Nested classes/interfaces inherited from class android.support.v4.app.SupportActivity

        +android.support.v4.app.SupportActivity.ExtraData
        • +
      +
      • +
    + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static java.lang.StringEXTRA_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.StringEXTRA_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.StringEXTRA_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.StringEXTRA_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.StringEXTRA_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.StringEXTRA_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.StringEXTRA_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.StringEXTRA_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.StringEXTRA_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.StringEXTRA_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.StringEXTRA_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.
      +
      +
        +
      • + + +

        Fields inherited from class android.app.Activity

        +DEFAULT_KEYS_DIALER, DEFAULT_KEYS_DISABLE, DEFAULT_KEYS_SEARCH_GLOBAL, DEFAULT_KEYS_SEARCH_LOCAL, DEFAULT_KEYS_SHORTCUT, FOCUSED_STATE_SET, RESULT_CANCELED, RESULT_FIRST_USER, RESULT_OK
        • +
      +
        +
      • + + +

        Fields inherited from class android.content.Context

        +ACCESSIBILITY_SERVICE, ACCOUNT_SERVICE, ACTIVITY_SERVICE, ALARM_SERVICE, APP_OPS_SERVICE, APPWIDGET_SERVICE, AUDIO_SERVICE, BATTERY_SERVICE, BIND_ABOVE_CLIENT, BIND_ADJUST_WITH_ACTIVITY, BIND_ALLOW_OOM_MANAGEMENT, BIND_AUTO_CREATE, BIND_DEBUG_UNBIND, BIND_EXTERNAL_SERVICE, BIND_IMPORTANT, BIND_NOT_FOREGROUND, BIND_WAIVE_PRIORITY, BLUETOOTH_SERVICE, CAMERA_SERVICE, CAPTIONING_SERVICE, CARRIER_CONFIG_SERVICE, CLIPBOARD_SERVICE, COMPANION_DEVICE_SERVICE, CONNECTIVITY_SERVICE, CONSUMER_IR_SERVICE, CONTEXT_IGNORE_SECURITY, CONTEXT_INCLUDE_CODE, CONTEXT_RESTRICTED, DEVICE_POLICY_SERVICE, DISPLAY_SERVICE, DOWNLOAD_SERVICE, DROPBOX_SERVICE, FINGERPRINT_SERVICE, HARDWARE_PROPERTIES_SERVICE, INPUT_METHOD_SERVICE, INPUT_SERVICE, JOB_SCHEDULER_SERVICE, KEYGUARD_SERVICE, LAUNCHER_APPS_SERVICE, LAYOUT_INFLATER_SERVICE, LOCATION_SERVICE, MEDIA_PROJECTION_SERVICE, MEDIA_ROUTER_SERVICE, MEDIA_SESSION_SERVICE, MIDI_SERVICE, MODE_APPEND, MODE_ENABLE_WRITE_AHEAD_LOGGING, MODE_MULTI_PROCESS, MODE_NO_LOCALIZED_COLLATORS, MODE_PRIVATE, MODE_WORLD_READABLE, MODE_WORLD_WRITEABLE, NETWORK_STATS_SERVICE, NFC_SERVICE, NOTIFICATION_SERVICE, NSD_SERVICE, POWER_SERVICE, PRINT_SERVICE, RECEIVER_VISIBLE_TO_INSTANT_APPS, RESTRICTIONS_SERVICE, SEARCH_SERVICE, SENSOR_SERVICE, SHORTCUT_SERVICE, STORAGE_SERVICE, STORAGE_STATS_SERVICE, SYSTEM_HEALTH_SERVICE, TELECOM_SERVICE, TELEPHONY_SERVICE, TELEPHONY_SUBSCRIPTION_SERVICE, TEXT_CLASSIFICATION_SERVICE, TEXT_SERVICES_MANAGER_SERVICE, TV_INPUT_SERVICE, UI_MODE_SERVICE, USAGE_STATS_SERVICE, USB_SERVICE, USER_SERVICE, VIBRATOR_SERVICE, WALLPAPER_SERVICE, WIFI_AWARE_SERVICE, WIFI_P2P_SERVICE, WIFI_SERVICE, WINDOW_SERVICE
        • +
      +
        +
      • + + +

        Fields inherited from interface android.content.ComponentCallbacks2

        +TRIM_MEMORY_BACKGROUND, TRIM_MEMORY_COMPLETE, TRIM_MEMORY_MODERATE, TRIM_MEMORY_RUNNING_CRITICAL, TRIM_MEMORY_RUNNING_LOW, TRIM_MEMORY_RUNNING_MODERATE, TRIM_MEMORY_UI_HIDDEN
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      PreferenceActivity() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      voidaddNavigationListener(NavigationListener listener) +
      Adds a new listener, which should be notified, when a navigation preference has been added or + removed to/from the activity.
      +
      voidaddPreferenceFragmentListener(PreferenceFragmentListener listener) +
      Adds a new listener, which should be notified, when the currently shown preference fragment + has been changed, to the activity.
      +
      voidaddWizardListener(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.ButtongetBackButton() +
      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.CharSequencegetBackButtonText() +
      Returns the text of the back button, which is shown, when the activity is used as a wizard.
      +
      intgetBreadCrumbBackgroundColor() +
      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.
      +
      intgetBreadCrumbElevation() +
      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.
      +
      android.support.v7.widget.ToolbargetBreadCrumbToolbar() +
      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.ViewGroupgetButtonBar() +
      Returns the button bar, which is shown when the activity is used as a wizard.
      +
      android.graphics.drawable.DrawablegetButtonBarBackground() +
      Returns the background of the button bar, which is shown, when the activity is used as a + wizard.
      +
      intgetButtonBarElevation() +
      Returns the elevation of the button bar, which is shown when using the activity as a wizard.
      +
      android.support.v7.widget.CardViewgetCardView() +
      Returns the card view, which contains the currently shown preference fragment, when using the + split screen layout.
      +
      intgetCardViewBackgroundColor() +
      Returns the background color of the card view, which contains the currently shown preference + fragment, when using the split screen layout.
      +
      intgetCardViewElevation() +
      Returns the elevation of the card view, which contains the currently shown preference + fragment, when using the split screen layout.
      +
      android.widget.ButtongetFinishButton() +
      Returns the finish button, which is shown when the activity is used as a wizard and the last + navigation preference is selected.
      +
      java.lang.CharSequencegetFinishButtonText() +
      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.FrameLayoutgetFrameLayout() +
      Returns the frame layout, which contains the activity's views.
      +
      android.graphics.drawable.DrawablegetNavigationBackground() +
      Returns the background of the navigation.
      +
      intgetNavigationDividerColor() +
      Returns the color of the dividers, which are contained by the navigation.
      +
      android.support.v7.preference.PreferenceFragmentCompatgetNavigationFragment() +
      Returns the preference fragment, which contains the activity's navigation.
      +
      intgetNavigationPreferenceCount() +
      Returns the number of navigation preferences, which are contained by the activity.
      +
      intgetNavigationSelectionColor() +
      Returns the background color of the currently selected navigation preference.
      +
      android.support.v7.widget.ToolbargetNavigationToolbar() +
      Returns the toolbar, which is used to show the activity's title, when using the split screen + layout.
      +
      intgetNavigationWidth() +
      Returns the width of the navigation, when using the split screen layout.
      +
      android.widget.ButtongetNextButton() +
      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.CharSequencegetNextButtonText() +
      Returns the text of the next button, which is shown, when the activity is used as a wizard.
      +
      android.support.v4.app.FragmentgetPreferenceFragment() +
      Returns the currently shown preference fragment.
      +
      java.lang.StringgetProgressFormat() +
      Returns the string, which is used to format the progress, which is shown, when the activity + is used as a wizard.
      +
      NavigationPreferencegetSelectedNavigationPreference() +
      Returns the currently selected navigation preference.
      +
      intgetToolbarElevation() +
      Returns the elevation of the activity's toolbar.
      +
      voidhideBreadCrumb(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.
      +
      voidhideNavigation(boolean hideNavigation) +
      Hides or shows the navigation.
      +
      booleanisBreadCrumbHidden() +
      Returns, whether the toolbar, which is used to show the bread crumb of the currently selected + navigation preference, is hidden, or not.
      +
      booleanisButtonBarShown() +
      Returns, whether the activity is used as a wizard, or not.
      +
      booleanisNavigationHidden() +
      Returns, whether the navigation is currently hidden, or not.
      +
      booleanisNavigationIconOverridden() +
      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.
      +
      booleanisNavigationPreferenceSelected() +
      Returns, whether a navigation preference is currently selected, or not.
      +
      booleanisPreferenceFragmentShown() +
      Returns, whether a preference fragment is currently shown, or not.
      +
      booleanisProgressShown() +
      Returns, whether the progress is shown, if the activity is used as a wizard.
      +
      booleanisSplitScreen() +
      Returns, whether the split screen layout is used, or not.
      +
      voidonBackPressed() 
      protected voidonCreate(android.os.Bundle savedInstanceState) 
      protected voidonCreateNavigation(android.support.v7.preference.PreferenceFragmentCompat fragment) +
      The method, which is invoked on implementing subclasses, when the navigation is created.
      +
      voidonNavigationAdapterCreated() +
      The method, which is invoked, when the adapter, which contains the navigation items, has + been created.
      +
      voidonNavigationFragmentCreated(android.support.v7.preference.PreferenceFragmentCompat fragment) +
      The method, which is invoked, when the navigation fragment has been attached to its + activity.
      +
      voidonNavigationPreferenceAdded(NavigationPreference navigationPreference) +
      The method, which is invoked, when a navigation preference has been added.
      +
      voidonNavigationPreferenceRemoved(NavigationPreference navigationPreference) +
      The method, which is invoked, when a navigation preference has been removed.
      +
      voidonNavigationPreferenceSelected(NavigationPreference navigationPreference, + android.os.Bundle arguments) +
      The method, which is invoked, when a navigation preference has been selected.
      +
      voidonNavigationPreferenceUnselected() +
      The method, which is invoked, when a navigation preference has been unselected.
      +
      booleanonOptionsItemSelected(android.view.MenuItem item) 
      protected voidonRestoreInstanceState(android.os.Bundle savedInstanceState) 
      protected voidonSaveInstanceState(android.os.Bundle outState) 
      booleanonSelectNavigationPreference(NavigationPreference navigationPreference) +
      The method, which is invoked, when a navigation preference is about to be selected.
      +
      voidoverrideNavigationIcon(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.
      +
      voidremoveNavigationListener(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.
      +
      voidremovePreferenceFragmentListener(PreferenceFragmentListener listener) +
      Removes a specific listener, which should not be notified, when the currently shown + preference fragment has been changed, anymore.
      +
      voidremoveWizardListener(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.
      +
      voidselectNavigationPreference(NavigationPreference navigationPreference) +
      Selects a specific navigation preference.
      +
      voidselectNavigationPreference(NavigationPreference navigationPreference, + android.os.Bundle arguments) +
      Selects a specific navigation preference.
      +
      voidsetBackButtonText(java.lang.CharSequence text) +
      Sets the text of the back button, which is shown, when the activity is used as a wizard.
      +
      voidsetBackButtonText(int resourceId) +
      Sets the text of the back button, which is shown, when the activity is used as a wizard.
      +
      voidsetBreadCrumbBackgroundColor(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.
      +
      voidsetBreadCrumbElevation(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.
      +
      voidsetButtonBarBackground(android.graphics.drawable.Drawable background) +
      Sets the background of the button bar, which is shown, when the activity is used as a + wizard.
      +
      voidsetButtonBarBackground(int resourceId) +
      Sets the background of the button bar, which is shown, when the activity is used as a + wizard.
      +
      voidsetButtonBarBackgroundColor(int color) +
      Sets the background of the button bar, which is shown, when the activity is used as a + wizard.
      +
      voidsetButtonBarElevation(int elevation) +
      Sets the elevation of the button bar, which is shown when using the activity as a wizard.
      +
      voidsetCardViewBackgroundColor(int color) +
      Sets the background color of the card view, which contains the currently shown preference + fragment, when using the split screen layout.
      +
      voidsetCardViewElevation(int elevation) +
      Sets the elevation of the card view, which contains the currently shown prefernce fragment, + when using the split screen layout.
      +
      voidsetFinishButtonText(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.
      +
      voidsetFinishButtonText(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.
      +
      voidsetNavigationBackground(android.graphics.drawable.Drawable background) +
      Sets the background of the navigation.
      +
      voidsetNavigationBackground(int resourceId) +
      Sets the background of the navigation.
      +
      voidsetNavigationBackgroundColor(int color) +
      Sets the background color of the navigation.
      +
      voidsetNavigationDividerColor(int color) +
      Sets the color of the dividers, which are contained by the navigation.
      +
      voidsetNavigationSelectionColor(int color) +
      Sets the background color of the currently selected navigation preference.
      +
      voidsetNavigationWidth(int width) +
      Sets the width of the navigation, when using the split screen layout.
      +
      voidsetNextButtonText(java.lang.CharSequence text) +
      Sets the text of the next button, which is shown, when the activity is used as a wizard.
      +
      voidsetNextButtonText(int resourceId) +
      Sets the text of the next button, which is shown, when the activity is used as a wizard.
      +
      voidsetProgressFormat(int resourceId) +
      Sets the string, which should be used to format the progress, which is shown, when the + activity is used as a wizard.
      +
      voidsetProgressFormat(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.
      +
      voidsetTitle(java.lang.CharSequence title) 
      voidsetTitle(int resourceId) 
      voidsetToolbarElevation(int elevation) +
      Sets the elevation of the activity's toolbar.
      +
      voidshowButtonBar(boolean show) +
      Shows or hides the view group, which contains the buttons, which are shown when the activity + is used as a wizard.
      +
      voidshowProgress(boolean showProgress) +
      Sets, whether the progress should be shown, when the activity is used as a wizard.
      +
      voidunselectNavigationPreference() +
      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.
      +
      voiduseSplitScreen(boolean useSplitScreen) +
      Sets, whether the split screen layout should be used on tablets, or not.
      +
      +
        +
      • + + +

        Methods inherited from class android.support.v7.app.AppCompatActivity

        +addContentView, closeOptionsMenu, dispatchKeyEvent, findViewById, getDelegate, getDrawerToggleDelegate, getMenuInflater, getResources, getSupportActionBar, getSupportParentActivityIntent, invalidateOptionsMenu, onConfigurationChanged, onContentChanged, onCreateSupportNavigateUpTaskStack, onDestroy, onKeyDown, onMenuItemSelected, onMenuOpened, onPanelClosed, onPostCreate, onPostResume, onPrepareSupportNavigateUpTaskStack, onStart, onStop, onSupportActionModeFinished, onSupportActionModeStarted, onSupportContentChanged, onSupportNavigateUp, onTitleChanged, onWindowStartingSupportActionMode, openOptionsMenu, setContentView, setContentView, setContentView, setSupportActionBar, setSupportProgress, setSupportProgressBarIndeterminate, setSupportProgressBarIndeterminateVisibility, setSupportProgressBarVisibility, setTheme, startSupportActionMode, supportInvalidateOptionsMenu, supportNavigateUpTo, supportRequestWindowFeature, supportShouldUpRecreateTask
        • +
      +
        +
      • + + +

        Methods inherited from class android.support.v4.app.FragmentActivity

        +dump, getLastCustomNonConfigurationInstance, getLifecycle, getSupportFragmentManager, getSupportLoaderManager, getViewModelStore, onActivityResult, onAttachFragment, onCreatePanelMenu, onLowMemory, onMultiWindowModeChanged, onNewIntent, onPause, onPictureInPictureModeChanged, onPrepareOptionsPanel, onPreparePanel, onRequestPermissionsResult, onResume, onResumeFragments, onRetainCustomNonConfigurationInstance, onRetainNonConfigurationInstance, onStateNotSaved, setEnterSharedElementCallback, setExitSharedElementCallback, startActivityForResult, startActivityFromFragment, startActivityFromFragment, startIntentSenderFromFragment, supportFinishAfterTransition, supportPostponeEnterTransition, supportStartPostponedEnterTransition, validateRequestPermissionsRequestCode
        • +
      +
        +
      • + + +

        Methods inherited from class android.support.v4.app.SupportActivity

        +getExtraData, putExtraData
        • +
      +
        +
      • + + +

        Methods inherited from class android.app.Activity

        +attachBaseContext, closeContextMenu, createPendingResult, dismissDialog, dismissKeyboardShortcutsHelper, dispatchGenericMotionEvent, dispatchKeyShortcutEvent, dispatchPopulateAccessibilityEvent, dispatchTouchEvent, dispatchTrackballEvent, enterPictureInPictureMode, enterPictureInPictureMode, finish, finishActivity, finishActivityFromChild, finishAffinity, finishAfterTransition, finishAndRemoveTask, finishFromChild, getActionBar, getApplication, getCallingActivity, getCallingPackage, getChangingConfigurations, getComponentName, getContentScene, getContentTransitionManager, getCurrentFocus, getFragmentManager, getIntent, getLastNonConfigurationInstance, getLayoutInflater, getLoaderManager, getLocalClassName, getMaxNumPictureInPictureActions, getMediaController, getParent, getParentActivityIntent, getPreferences, getReferrer, getRequestedOrientation, getSearchEvent, getSystemService, getTaskId, getTitle, getTitleColor, getVoiceInteractor, getVolumeControlStream, getWindow, getWindowManager, hasWindowFocus, isActivityTransitionRunning, isChangingConfigurations, isChild, isDestroyed, isFinishing, isImmersive, isInMultiWindowMode, isInPictureInPictureMode, isLocalVoiceInteractionSupported, isTaskRoot, isVoiceInteraction, isVoiceInteractionRoot, managedQuery, moveTaskToBack, navigateUpTo, navigateUpToFromChild, onActionModeFinished, onActionModeStarted, onActivityReenter, onApplyThemeResource, onAttachedToWindow, onAttachFragment, onChildTitleChanged, onContextItemSelected, onContextMenuClosed, onCreate, onCreateContextMenu, onCreateDescription, onCreateDialog, onCreateDialog, onCreateNavigateUpTaskStack, onCreateOptionsMenu, onCreatePanelView, onCreateThumbnail, onDetachedFromWindow, onEnterAnimationComplete, onGenericMotionEvent, onKeyLongPress, onKeyMultiple, onKeyShortcut, onKeyUp, onLocalVoiceInteractionStarted, onLocalVoiceInteractionStopped, onMultiWindowModeChanged, onNavigateUp, onNavigateUpFromChild, onOptionsMenuClosed, onPictureInPictureModeChanged, onPostCreate, onPrepareDialog, onPrepareDialog, onPrepareNavigateUpTaskStack, onPrepareOptionsMenu, onProvideAssistContent, onProvideAssistData, onProvideKeyboardShortcuts, onProvideReferrer, onRestart, onRestoreInstanceState, onSaveInstanceState, onSearchRequested, onSearchRequested, onTouchEvent, onTrackballEvent, onTrimMemory, onUserInteraction, onUserLeaveHint, onVisibleBehindCanceled, onWindowAttributesChanged, onWindowFocusChanged, onWindowStartingActionMode, onWindowStartingActionMode, openContextMenu, overridePendingTransition, postponeEnterTransition, recreate, registerForContextMenu, releaseInstance, removeDialog, reportFullyDrawn, requestDragAndDropPermissions, requestPermissions, requestShowKeyboardShortcuts, requestVisibleBehind, requestWindowFeature, runOnUiThread, setActionBar, setContentTransitionManager, setDefaultKeyMode, setEnterSharedElementCallback, setExitSharedElementCallback, setFeatureDrawable, setFeatureDrawableAlpha, setFeatureDrawableResource, setFeatureDrawableUri, setFinishOnTouchOutside, setImmersive, setIntent, setMediaController, setPictureInPictureParams, setProgress, setProgressBarIndeterminate, setProgressBarIndeterminateVisibility, setProgressBarVisibility, setRequestedOrientation, setResult, setResult, setSecondaryProgress, setShowWhenLocked, setTaskDescription, setTitleColor, setTurnScreenOn, setVisible, setVolumeControlStream, setVrModeEnabled, shouldShowRequestPermissionRationale, shouldUpRecreateTask, showAssist, showDialog, showDialog, showLockTaskEscapeMessage, startActionMode, startActionMode, startActivities, startActivities, startActivity, startActivity, startActivityFromChild, startActivityFromChild, startActivityFromFragment, startActivityFromFragment, startActivityIfNeeded, startActivityIfNeeded, startIntentSender, startIntentSender, startIntentSenderFromChild, startIntentSenderFromChild, startLocalVoiceInteraction, startLockTask, startManagingCursor, startNextMatchingActivity, startNextMatchingActivity, startPostponedEnterTransition, startSearch, stopLocalVoiceInteraction, stopLockTask, stopManagingCursor, takeKeyEvents, triggerSearch, unregisterForContextMenu
        • +
      +
        +
      • + + +

        Methods inherited from class android.view.ContextThemeWrapper

        +applyOverrideConfiguration, getAssets, getTheme
        • +
      +
        +
      • + + +

        Methods inherited from class android.content.ContextWrapper

        +bindService, checkCallingOrSelfPermission, checkCallingOrSelfUriPermission, checkCallingPermission, checkCallingUriPermission, checkPermission, checkSelfPermission, checkUriPermission, checkUriPermission, clearWallpaper, createConfigurationContext, createContextForSplit, createDeviceProtectedStorageContext, createDisplayContext, createPackageContext, databaseList, deleteDatabase, deleteFile, deleteSharedPreferences, enforceCallingOrSelfPermission, enforceCallingOrSelfUriPermission, enforceCallingPermission, enforceCallingUriPermission, enforcePermission, enforceUriPermission, enforceUriPermission, fileList, getApplicationContext, getApplicationInfo, getBaseContext, getCacheDir, getClassLoader, getCodeCacheDir, getContentResolver, getDatabasePath, getDataDir, getDir, getExternalCacheDir, getExternalCacheDirs, getExternalFilesDir, getExternalFilesDirs, getExternalMediaDirs, getFilesDir, getFileStreamPath, getMainLooper, getNoBackupFilesDir, getObbDir, getObbDirs, getPackageCodePath, getPackageManager, getPackageName, getPackageResourcePath, getSharedPreferences, getSystemServiceName, getWallpaper, getWallpaperDesiredMinimumHeight, getWallpaperDesiredMinimumWidth, grantUriPermission, isDeviceProtectedStorage, isRestricted, moveDatabaseFrom, moveSharedPreferencesFrom, openFileInput, openFileOutput, openOrCreateDatabase, openOrCreateDatabase, peekWallpaper, registerReceiver, registerReceiver, registerReceiver, registerReceiver, removeStickyBroadcast, removeStickyBroadcastAsUser, revokeUriPermission, revokeUriPermission, sendBroadcast, sendBroadcast, sendBroadcastAsUser, sendBroadcastAsUser, sendOrderedBroadcast, sendOrderedBroadcast, sendOrderedBroadcastAsUser, sendStickyBroadcast, sendStickyBroadcastAsUser, sendStickyOrderedBroadcast, sendStickyOrderedBroadcastAsUser, setWallpaper, setWallpaper, startForegroundService, startInstrumentation, startService, stopService, unbindService, unregisterReceiver
        • +
      +
        +
      • + + +

        Methods inherited from class android.content.Context

        +getColor, getColorStateList, getDrawable, getString, getString, getSystemService, getText, obtainStyledAttributes, obtainStyledAttributes, obtainStyledAttributes, obtainStyledAttributes, registerComponentCallbacks, unregisterComponentCallbacks
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

        Methods inherited from interface android.view.Window.Callback

        +onPointerCaptureChanged
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      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(@NonNull
+                                                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(@NonNull
+                                                   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(@NonNull
+                                    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(@NonNull
+                                       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(@NonNull
+                                        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(@NonNull
+                                           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 android.support.v7.preference.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 android.support.v4.app.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 android.support.v7.widget.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 android.support.v7.widget.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 android.support.v7.widget.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

        +
        @Px
+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(@Px
+                                     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

        +
        @NonNull
+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(@StringRes
+                                    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(@NonNull
+                                    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

        +
        @NonNull
+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(@StringRes
+                                    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(@NonNull
+                                    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

        +
        @NonNull
+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(@StringRes
+                                      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(@NonNull
+                                      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

        +
        @NonNull
+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(@StringRes
+                                    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(@NonNull
+                                    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

        +
        @Nullable
+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(@DrawableRes
+                                         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(@Nullable
+                                         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

        +
        @Nullable
+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(@DrawableRes
+                                          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(@Nullable
+                                          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

        +
        @NonNull
+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

        +
        @Nullable
+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(@NonNull
+                                             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(@NonNull
+                                             NavigationPreference navigationPreference,
+                                             @Nullable
+                                             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(@NonNull
+                                  android.support.v7.preference.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(@StringRes
+                           int resourceId)
        +
        +
        Overrides:
        +
        setTitle in class android.app.Activity
        +
        +
        • +
      + + + +
        +
      • +

        setTitle

        +
        public final void setTitle(@Nullable
+                           java.lang.CharSequence title)
        +
        +
        Overrides:
        +
        setTitle in class android.app.Activity
        +
        +
        • +
      + + + +
        +
      • +

        onNavigationFragmentCreated

        +
        public final void onNavigationFragmentCreated(@NonNull
+                                              android.support.v7.preference.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
        +
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        onNavigationPreferenceSelected

        +
        public final void onNavigationPreferenceSelected(@NonNull
+                                                 NavigationPreference navigationPreference,
+                                                 @Nullable
+                                                 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
        +
        +
        • +
      + + + + + + + + + + + + + + + +
        +
      • +

        onBackPressed

        +
        @CallSuper
+public void onBackPressed()
        +
        +
        Overrides:
        +
        onBackPressed in class android.support.v4.app.FragmentActivity
        +
        +
        • +
      + + + +
        +
      • +

        onOptionsItemSelected

        +
        @CallSuper
+public boolean onOptionsItemSelected(android.view.MenuItem item)
        +
        +
        Overrides:
        +
        onOptionsItemSelected in class android.app.Activity
        +
        +
        • +
      + + + +
        +
      • +

        onCreate

        +
        @CallSuper
+protected void onCreate(android.os.Bundle savedInstanceState)
        +
        +
        Overrides:
        +
        onCreate in class android.support.v7.app.AppCompatActivity
        +
        +
        • +
      + + + +
        +
      • +

        onSaveInstanceState

        +
        protected void onSaveInstanceState(android.os.Bundle outState)
        +
        +
        Overrides:
        +
        onSaveInstanceState in class android.support.v7.app.AppCompatActivity
        +
        +
        • +
      + + + +
        +
      • +

        onRestoreInstanceState

        +
        protected void onRestoreInstanceState(android.os.Bundle savedInstanceState)
        +
        +
        Overrides:
        +
        onRestoreInstanceState in class android.app.Activity
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/doc/javadoc/de/mrapp/android/preference/activity/PreferenceFragment.html b/doc/javadoc/de/mrapp/android/preference/activity/PreferenceFragment.html new file mode 100644 index 0000000..4f34b44 --- /dev/null +++ b/doc/javadoc/de/mrapp/android/preference/activity/PreferenceFragment.html @@ -0,0 +1,838 @@ + + + + + +PreferenceFragment + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
de.mrapp.android.preference.activity
+

Class PreferenceFragment

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    android.arch.lifecycle.LifecycleOwner, android.arch.lifecycle.ViewModelStoreOwner, android.content.ComponentCallbacks, android.support.v7.preference.DialogPreference.TargetFragment, android.support.v7.preference.PreferenceManager.OnDisplayPreferenceDialogListener, android.support.v7.preference.PreferenceManager.OnNavigateToScreenListener, android.support.v7.preference.PreferenceManager.OnPreferenceTreeClickListener, android.view.View.OnCreateContextMenuListener
    +
    +
    +
    +
    public abstract class PreferenceFragment
+extends AbstractPreferenceFragment
    +
    A fragment, which allows to show multiple preferences. Additionally, a button, which allows to + restore the preferences' default values, can be shown.
    +
    +
    Since:
    +
    1.1.0
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      +
        +
      • + + +

        Nested classes/interfaces inherited from class android.support.v7.preference.PreferenceFragmentCompat

        +android.support.v7.preference.PreferenceFragmentCompat.OnPreferenceDisplayDialogCallback, android.support.v7.preference.PreferenceFragmentCompat.OnPreferenceStartFragmentCallback, android.support.v7.preference.PreferenceFragmentCompat.OnPreferenceStartScreenCallback
        • +
      +
        +
      • + + +

        Nested classes/interfaces inherited from class android.support.v4.app.Fragment

        +android.support.v4.app.Fragment.InstantiationException, android.support.v4.app.Fragment.SavedState
        • +
      +
      • +
    + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static java.lang.StringEXTRA_RESTORE_DEFAULTS_BUTTON_TEXT +
      When attaching this fragment to an activity and using EXTRA_SHOW_RESTORE_DEFAULTS_BUTTON, + this extra can also be specified to supply a custom text for the button, which allows to + restore the preferences' default values.
      +
      static java.lang.StringEXTRA_SHOW_RESTORE_DEFAULTS_BUTTON +
      When attaching this fragment to an activity, the passed bundle can contain this extra boolean + to display the button, which allows to restore the preferences' default values.
      +
      +
        +
      • + + +

        Fields inherited from class android.support.v7.preference.PreferenceFragmentCompat

        +ARG_PREFERENCE_ROOT
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      PreferenceFragment() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      voidaddRestoreDefaultsListener(RestoreDefaultsListener listener) +
      Adds a new listener, which should be notified, when the preferences' default values should be + restored, to the fragment.
      +
      android.view.ViewGroupgetButtonBar() +
      Returns the view group, which contains the button, which allows to restore the preferences' + default values.
      +
      android.graphics.drawable.DrawablegetButtonBarBackground() +
      Returns the background of the view group, which contains the button, which allows to restore + the preferences' default values.
      +
      intgetButtonBarElevation() +
      Returns the elevation of the view group, which contains the button, which allows to restore + the preferences' default values.
      +
      android.widget.FrameLayoutgetFrameLayout() +
      Returns the frame layout, which contains the fragment's views.
      +
      android.widget.ButtongetRestoreDefaultsButton() +
      Returns the button, which allows to restore the preferences' default values.
      +
      java.lang.CharSequencegetRestoreDefaultsButtonText() +
      Returns the text of the button, which allows to restore the preferences' default values.
      +
      booleanisRestoreDefaultsButtonShown() +
      Returns, whether the button, which allows to restore the preferences' default values, is + currently shown, or not.
      +
      voidonActivityCreated(android.os.Bundle savedInstanceState) 
      voidonCreate(android.os.Bundle savedInstanceState) 
      android.view.ViewonCreateView(android.view.LayoutInflater inflater, + android.view.ViewGroup parent, + android.os.Bundle savedInstanceState) 
      voidremoveRestoreDefaultsListener(RestoreDefaultsListener listener) +
      Removes a specific listener, which should not be notified anymore, when the preferences' + default values should be restored, from the fragment.
      +
      voidrestoreDefaults() +
      Restores the default values of all preferences, which are contained by the fragment.
      +
      voidsetButtonBarBackground(android.graphics.drawable.Drawable background) +
      Sets the background of the view group, which contains the button, which allows to restore the + preferences' default values.
      +
      voidsetButtonBarBackground(int resourceId) +
      Sets the background of the view group, which contains the button, which allows to restore the + preferences' default values.
      +
      voidsetButtonBarBackgroundColor(int color) +
      Sets the background color of the view group, which contains the button, which allows to + restore the preferences' default values.
      +
      voidsetButtonBarElevation(int elevation) +
      Sets the elevation of the view group, which contains the button, which allows to restore the + preferences' default values.
      +
      voidsetRestoreDefaultsButtonText(java.lang.CharSequence text) +
      Sets the text of the button, which allows to restore the preferences' default values.
      +
      voidsetRestoreDefaultsButtonText(int resourceId) +
      Sets the text of the button, which allows to restore the preferences' default values.
      +
      voidshowRestoreDefaultsButton(boolean show) +
      Shows or hides the button, which allows to restore the preferences' default values.
      +
      + +
        +
      • + + +

        Methods inherited from class android.support.v7.preference.PreferenceFragmentCompat

        +addPreferencesFromResource, findPreference, getCallbackFragment, getListView, getPreferenceManager, getPreferenceScreen, onBindPreferences, onCreateLayoutManager, onCreatePreferences, onCreateRecyclerView, onDestroyView, onDisplayPreferenceDialog, onNavigateToScreen, onPreferenceTreeClick, onSaveInstanceState, onStart, onStop, onUnbindPreferences, onViewCreated, scrollToPreference, scrollToPreference, setDivider, setDividerHeight, setPreferenceScreen, setPreferencesFromResource
        • +
      +
        +
      • + + +

        Methods inherited from class android.support.v4.app.Fragment

        +dump, equals, getActivity, getAllowEnterTransitionOverlap, getAllowReturnTransitionOverlap, getArguments, getChildFragmentManager, getContext, getEnterTransition, getExitTransition, getFragmentManager, getHost, getId, getLayoutInflater, getLayoutInflater, getLifecycle, getLoaderManager, getParentFragment, getReenterTransition, getResources, getRetainInstance, getReturnTransition, getSharedElementEnterTransition, getSharedElementReturnTransition, getString, getString, getTag, getTargetFragment, getTargetRequestCode, getText, getUserVisibleHint, getView, getViewModelStore, hashCode, hasOptionsMenu, instantiate, instantiate, isAdded, isDetached, isHidden, isInLayout, isMenuVisible, isRemoving, isResumed, isStateSaved, isVisible, onActivityResult, onAttach, onAttach, onAttachFragment, onConfigurationChanged, onContextItemSelected, onCreateAnimation, onCreateAnimator, onCreateContextMenu, onCreateOptionsMenu, onDestroy, onDestroyOptionsMenu, onDetach, onGetLayoutInflater, onHiddenChanged, onInflate, onInflate, onLowMemory, onMultiWindowModeChanged, onOptionsItemSelected, onOptionsMenuClosed, onPause, onPictureInPictureModeChanged, onPrepareOptionsMenu, onRequestPermissionsResult, onResume, onViewStateRestored, postponeEnterTransition, registerForContextMenu, requestPermissions, requireActivity, requireContext, requireFragmentManager, requireHost, setAllowEnterTransitionOverlap, setAllowReturnTransitionOverlap, setArguments, setEnterSharedElementCallback, setEnterTransition, setExitSharedElementCallback, setExitTransition, setHasOptionsMenu, setInitialSavedState, setMenuVisibility, setReenterTransition, setRetainInstance, setReturnTransition, setSharedElementEnterTransition, setSharedElementReturnTransition, setTargetFragment, setUserVisibleHint, shouldShowRequestPermissionRationale, startActivity, startActivity, startActivityForResult, startActivityForResult, startIntentSenderForResult, startPostponedEnterTransition, toString, unregisterForContextMenu
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        EXTRA_SHOW_RESTORE_DEFAULTS_BUTTON

        +
        public static final java.lang.String EXTRA_SHOW_RESTORE_DEFAULTS_BUTTON
        +
        When attaching this fragment to an activity, the passed bundle can contain this extra boolean + to display the button, which allows to restore the preferences' default values.
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        EXTRA_RESTORE_DEFAULTS_BUTTON_TEXT

        +
        public static final java.lang.String EXTRA_RESTORE_DEFAULTS_BUTTON_TEXT
        +
        When attaching this fragment to an activity and using EXTRA_SHOW_RESTORE_DEFAULTS_BUTTON, + this extra can also be specified to supply a custom text for the button, which allows to + restore the preferences' default values.
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PreferenceFragment

        +
        public PreferenceFragment()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getFrameLayout

        +
        public final android.widget.FrameLayout getFrameLayout()
        +
        Returns the frame layout, which contains the fragment's views. It is the root view of the + fragment.
        +
        +
        Returns:
        +
        The frame layout, which contains the fragment's views, as an instance of the class + FrameLayout or null, if the fragment has not been created yet
        +
        +
        • +
      + + + +
        +
      • +

        getButtonBar

        +
        public final android.view.ViewGroup getButtonBar()
        +
        Returns the view group, which contains the button, which allows to restore the preferences' + default values.
        +
        +
        Returns:
        +
        The view group, which contains the button, which allows to restore the preferences' + default values, as an instance of the class ViewGroup or null, if the button is not + shown or if the fragment has not been created yet
        +
        +
        • +
      + + + +
        +
      • +

        getRestoreDefaultsButton

        +
        public final android.widget.Button getRestoreDefaultsButton()
        +
        Returns the button, which allows to restore the preferences' default values.
        +
        +
        Returns:
        +
        The button, which allows to restore the preferences' default values, as an instance + of the class Button or null, if the button is not shown
        +
        +
        • +
      + + + +
        +
      • +

        addRestoreDefaultsListener

        +
        public final void addRestoreDefaultsListener(@NonNull
+                                             RestoreDefaultsListener listener)
        +
        Adds a new listener, which should be notified, when the preferences' default values should be + restored, to the fragment.
        +
        +
        Parameters:
        +
        listener - The listener, which should be added as an instance of the type RestoreDefaultsListener. The listener may not be null
        +
        +
        • +
      + + + +
        +
      • +

        removeRestoreDefaultsListener

        +
        public final void removeRestoreDefaultsListener(@NonNull
+                                                RestoreDefaultsListener listener)
        +
        Removes a specific listener, which should not be notified anymore, when the preferences' + default values should be restored, from the fragment.
        +
        +
        Parameters:
        +
        listener - The listener, which should be removed as an instance of the type RestoreDefaultsListener. The listener may not be null
        +
        +
        • +
      + + + +
        +
      • +

        restoreDefaults

        +
        public final void restoreDefaults()
        +
        Restores the default values of all preferences, which are contained by the fragment.
        +
        • +
      + + + +
        +
      • +

        isRestoreDefaultsButtonShown

        +
        public final boolean isRestoreDefaultsButtonShown()
        +
        Returns, whether the button, which allows to restore the preferences' default values, is + currently shown, or not.
        +
        +
        Returns:
        +
        True, if the button, which allows to restore the preferences' default values, is + currently shown, false otherwise
        +
        +
        • +
      + + + +
        +
      • +

        showRestoreDefaultsButton

        +
        public final void showRestoreDefaultsButton(boolean show)
        +
        Shows or hides the button, which allows to restore the preferences' default values.
        +
        +
        Parameters:
        +
        show - True, if the button, which allows to restore the preferences' default values, should + be shown, false otherwise
        +
        +
        • +
      + + + +
        +
      • +

        getRestoreDefaultsButtonText

        +
        @NonNull
+public final java.lang.CharSequence getRestoreDefaultsButtonText()
        +
        Returns the text of the button, which allows to restore the preferences' default values.
        +
        +
        Returns:
        +
        The text of the button, which allows to restore the preferences' default values, as + an instance of the class CharSequence
        +
        +
        • +
      + + + +
        +
      • +

        setRestoreDefaultsButtonText

        +
        public final void setRestoreDefaultsButtonText(@StringRes
+                                               int resourceId)
        +
        Sets the text of the button, which allows to restore the preferences' default values. The + text is only set, if the button is shown.
        +
        +
        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
        +
        +
        • +
      + + + +
        +
      • +

        setRestoreDefaultsButtonText

        +
        public final void setRestoreDefaultsButtonText(@NonNull
+                                               java.lang.CharSequence text)
        +
        Sets the text of the button, which allows to restore the preferences' default values. The + text is only set, if the button is shown.
        +
        +
        Parameters:
        +
        text - The text, which should be set, as an instance of the class CharSequence. The + text may neither be null, nor empty
        +
        +
        • +
      + + + +
        +
      • +

        getButtonBarBackground

        +
        public final android.graphics.drawable.Drawable getButtonBarBackground()
        +
        Returns the background of the view group, which contains the button, which allows to restore + the preferences' default values.
        +
        +
        Returns:
        +
        The background of the view group, which contains the button, which allows to restore + the preferences' default values, as an instance of the class Drawable
        +
        +
        • +
      + + + +
        +
      • +

        setButtonBarBackground

        +
        public final void setButtonBarBackground(@DrawableRes
+                                         int resourceId)
        +
        Sets the background of the view group, which contains the button, which allows to restore the + preferences' default values.
        +
        +
        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
        +
        +
        • +
      + + + +
        +
      • +

        setButtonBarBackgroundColor

        +
        public final void setButtonBarBackgroundColor(int color)
        +
        Sets the background color of the view group, which contains the button, which allows to + restore the preferences' default values. shown.
        +
        +
        Parameters:
        +
        color - The background color, which should be set, as an Integer value
        +
        +
        • +
      + + + +
        +
      • +

        setButtonBarBackground

        +
        public final void setButtonBarBackground(@Nullable
+                                         android.graphics.drawable.Drawable background)
        +
        Sets the background of the view group, which contains the button, which allows to restore the + preferences' default values.
        +
        +
        Parameters:
        +
        background - The background, which should be set, as an instance of the class Drawable or + null, if no background should be set
        +
        +
        • +
      + + + +
        +
      • +

        getButtonBarElevation

        +
        public final int getButtonBarElevation()
        +
        Returns the elevation of the view group, which contains the button, which allows to restore + the preferences' default values.
        +
        +
        Returns:
        +
        The elevation in dp as an Integer value
        +
        +
        • +
      + + + +
        +
      • +

        setButtonBarElevation

        +
        public final void setButtonBarElevation(int elevation)
        +
        Sets the elevation of the view group, which contains the button, which allows to restore the + preferences' default values.
        +
        +
        Parameters:
        +
        elevation - The elevation, which should be set, in dp as an Integer value. The elevation + must be at least 1 and at maximum 16
        +
        +
        • +
      + + + + + + + +
        +
      • +

        onActivityCreated

        +
        @CallSuper
+public void onActivityCreated(android.os.Bundle savedInstanceState)
        +
        +
        Overrides:
        +
        onActivityCreated in class android.support.v7.preference.PreferenceFragmentCompat
        +
        +
        • +
      + + + +
        +
      • +

        onCreateView

        +
        @NonNull
+ @CallSuper
+public android.view.View onCreateView(android.view.LayoutInflater inflater,
+                                                           android.view.ViewGroup parent,
+                                                           android.os.Bundle savedInstanceState)
        +
        +
        Overrides:
        +
        onCreateView in class AbstractPreferenceFragment
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/doc/javadoc/de/mrapp/android/preference/activity/PreferenceFragmentListener.html b/doc/javadoc/de/mrapp/android/preference/activity/PreferenceFragmentListener.html new file mode 100644 index 0000000..ec6495b --- /dev/null +++ b/doc/javadoc/de/mrapp/android/preference/activity/PreferenceFragmentListener.html @@ -0,0 +1,262 @@ + + + + + +PreferenceFragmentListener + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
de.mrapp.android.preference.activity
+

Interface PreferenceFragmentListener

+
+
+
+
    +
  • +
    +
    +
    public interface PreferenceFragmentListener
    +
    Defines the interface, a class, which should be notified when the currently shown preference + fragment of a PreferenceActivity has been changed, must implement.
    +
    +
    Since:
    +
    2.1.1
    +
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        onPreferenceFragmentShown

        +
        void onPreferenceFragmentShown(@NonNull
+                               NavigationPreference navigationPreference,
+                               @NonNull
+                               android.support.v4.app.Fragment fragment)
        +
        The method, which is invoked, when a preference fragment has been shown.
        +
        +
        Parameters:
        +
        navigationPreference - The navigation preference, the fragment, which has been shown, is associated with, as + an instance of the class NavigationPreference. The navigation preference may + not be null
        +
        fragment - The fragment, which has been shown, as an instance of the class Fragment. The + fragment may not be null
        +
        +
        • +
      + + + +
        +
      • +

        onPreferenceFragmentHidden

        +
        void onPreferenceFragmentHidden(@NonNull
+                                android.support.v4.app.Fragment fragment)
        +
        The method, which is invoked, when a previously shown preference fragment has been hidden.
        +
        +
        Parameters:
        +
        fragment - The fragment, which has been hidden, as an instance of the class Fragment. The + fragment may not be null
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/doc/javadoc/de/mrapp/android/preference/activity/RestoreDefaultsListener.html b/doc/javadoc/de/mrapp/android/preference/activity/RestoreDefaultsListener.html new file mode 100644 index 0000000..bf393da --- /dev/null +++ b/doc/javadoc/de/mrapp/android/preference/activity/RestoreDefaultsListener.html @@ -0,0 +1,312 @@ + + + + + +RestoreDefaultsListener + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
de.mrapp.android.preference.activity
+

Interface RestoreDefaultsListener

+
+
+
+
    +
  • +
    +
    +
    public interface RestoreDefaultsListener
    +
    Defines the interface, a class, which should be notified, when the default values of the + preferences, which belong to a PreferenceFragment, should be restored.
    +
    +
    Since:
    +
    1.1.0
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethod and Description
      voidonRestoredDefaultValue(PreferenceFragment fragment, + android.support.v7.preference.Preference preference, + java.lang.Object oldValue, + java.lang.Object newValue) +
      The method, which is invoked, when the default value of a specific preference has been + restored.
      +
      booleanonRestoreDefaultValueRequested(PreferenceFragment fragment, + android.support.v7.preference.Preference preference, + java.lang.Object currentValue) +
      The method, which is invoked, when the default value of a specific preference, should be + restored.
      +
      booleanonRestoreDefaultValuesRequested(PreferenceFragment fragment) +
      The method, which is invoked, when the default values of the preferences, which belong to a + specific preference fragment, should be restored.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        onRestoreDefaultValuesRequested

        +
        boolean onRestoreDefaultValuesRequested(@NonNull
+                                        PreferenceFragment fragment)
        +
        The method, which is invoked, when the default values of the preferences, which belong to a + specific preference fragment, should be restored.
        +
        +
        Parameters:
        +
        fragment - The fragment, whose preferences' default values should be restored, as an instance of + the class PreferenceFragment
        +
        Returns:
        +
        True, if restoring the preferences' default values should be proceeded, false + otherwise
        +
        +
        • +
      + + + +
        +
      • +

        onRestoreDefaultValueRequested

        +
        boolean onRestoreDefaultValueRequested(@NonNull
+                                       PreferenceFragment fragment,
+                                       @NonNull
+                                       android.support.v7.preference.Preference preference,
+                                       java.lang.Object currentValue)
        +
        The method, which is invoked, when the default value of a specific preference, should be + restored.
        +
        +
        Parameters:
        +
        fragment - The fragment, the preference, whose default value should be restored, belongs to, as + an instance of the class PreferenceFragment
        +
        preference - The preference, whose default value should be restored, as an instance of the class + Preference
        +
        currentValue - The current value of the preference, whose default value should be restored, as an + instance of the class Object
        +
        Returns:
        +
        True, if restoring the preference's default value should be proceeded, false + otherwise
        +
        +
        • +
      + + + +
        +
      • +

        onRestoredDefaultValue

        +
        void onRestoredDefaultValue(@NonNull
+                            PreferenceFragment fragment,
+                            @NonNull
+                            android.support.v7.preference.Preference preference,
+                            java.lang.Object oldValue,
+                            java.lang.Object newValue)
        +
        The method, which is invoked, when the default value of a specific preference has been + restored.
        +
        +
        Parameters:
        +
        fragment - The fragment, the preference, whose default value has been restored, belongs to, as + an instance of the class PreferenceFragment
        +
        preference - The preference, whose default value has been restored, as an instance of the class + Preference
        +
        oldValue - The old value of the preference, whose default value has been restored, as an + instance of the class Object
        +
        newValue - The new value of the preference, whose default value has been restored, as an + instance of the class Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/doc/javadoc/de/mrapp/android/preference/activity/WizardListener.html b/doc/javadoc/de/mrapp/android/preference/activity/WizardListener.html new file mode 100644 index 0000000..53fb00f --- /dev/null +++ b/doc/javadoc/de/mrapp/android/preference/activity/WizardListener.html @@ -0,0 +1,356 @@ + + + + + +WizardListener + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
de.mrapp.android.preference.activity
+

Interface WizardListener

+
+
+
+
    +
  • +
    +
    +
    public interface WizardListener
    +
    Defines the interface a class, which should be notified when the user navigates within a PreferenceActivity, which is used as wizard, by using its next-, back- and finish-button. The + return values of the interface's methods allow to take influence on the navigation, e.g. if the + currently shown preferences should be validated.
    +
    +
    Since:
    +
    1.0.0
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethod and Description
      booleanonFinish(NavigationPreference navigationPreference, + android.support.v4.app.Fragment fragment, + android.os.Bundle bundle) +
      The method, which is invoked, when the user wants to finish the last step of the wizard.
      +
      android.os.BundleonNextStep(NavigationPreference navigationPreference, + android.support.v4.app.Fragment fragment, + android.os.Bundle bundle) +
      The method, which is invoked, when the user wants to navigate to the next step of the + wizard.
      +
      android.os.BundleonPreviousStep(NavigationPreference navigationPreference, + android.support.v4.app.Fragment fragment, + android.os.Bundle bundle) +
      The method, which is invoked, when the user wants to navigate to the previous step of the + wizard.
      +
      booleanonSkip(NavigationPreference navigationPreference, + android.support.v4.app.Fragment fragment, + android.os.Bundle bundle) +
      The method, which is invoked, when the user wants to skip the wizard.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        onNextStep

        +
        android.os.Bundle onNextStep(@NonNull
+                             NavigationPreference navigationPreference,
+                             @NonNull
+                             android.support.v4.app.Fragment fragment,
+                             @Nullable
+                             android.os.Bundle bundle)
        +
        The method, which is invoked, when the user wants to navigate to the next step of the + wizard.
        +
        +
        Parameters:
        +
        navigationPreference - The currently selected navigation preference as an instance of the class NavigationPreference. The navigation preference may not be null
        +
        fragment - The currently shown preference fragment as an instance of the class Fragment. The + fragment may not be null
        +
        bundle - A bundle, which contains the parameters, which have been passed to the currently + shown preference fragment, as an instance of the class Bundle or null, if no + parameters have been passed to the fragment
        +
        Returns:
        +
        The bundle, which should be passed to the next fragment, as an instance of the class + Bundle or null, if navigating to the next step of the wizard should not be allowed
        +
        +
        • +
      + + + +
        +
      • +

        onPreviousStep

        +
        android.os.Bundle onPreviousStep(@NonNull
+                                 NavigationPreference navigationPreference,
+                                 @NonNull
+                                 android.support.v4.app.Fragment fragment,
+                                 @Nullable
+                                 android.os.Bundle bundle)
        +
        The method, which is invoked, when the user wants to navigate to the previous step of the + wizard.
        +
        +
        Parameters:
        +
        navigationPreference - The currently selected navigation preference as an instance of the class NavigationPreference. The navigation preference may not be null
        +
        fragment - The currently shown preference fragment as an instance of the class Fragment. The + fragment may not be null
        +
        bundle - A bundle, which contains the parameters, which have been passed to the currently + shown preference fragment, as an instance of the class Bundle or null, if no + parameters have been passed to the fragment
        +
        Returns:
        +
        The bundle, which should be passed to the next fragment, as an instance of the class + Bundle or null, if navigating to the previous step of the wizard should not be + allowed
        +
        +
        • +
      + + + +
        +
      • +

        onFinish

        +
        boolean onFinish(@NonNull
+                 NavigationPreference navigationPreference,
+                 @NonNull
+                 android.support.v4.app.Fragment fragment,
+                 @Nullable
+                 android.os.Bundle bundle)
        +
        The method, which is invoked, when the user wants to finish the last step of the wizard.
        +
        +
        Parameters:
        +
        navigationPreference - The currently selected navigation preference as an instance of the class NavigationPreference. The navigation preference may not be null
        +
        fragment - The currently shown preference fragment as an instance of the class Fragment. The + fragment may not be null
        +
        bundle - A bundle, which contains the parameters, which have been passed to the currently + shown preference fragment, as an instance of the class Bundle or null, if no + parameters have been passed to the fragment
        +
        Returns:
        +
        True, if finishing the wizard should be allowed, false otherwise
        +
        +
        • +
      + + + +
        +
      • +

        onSkip

        +
        boolean onSkip(@NonNull
+               NavigationPreference navigationPreference,
+               @NonNull
+               android.support.v4.app.Fragment fragment,
+               @Nullable
+               android.os.Bundle bundle)
        +
        The method, which is invoked, when the user wants to skip the wizard.
        +
        +
        Parameters:
        +
        navigationPreference - The currently selected navigation preference as an instance of the class NavigationPreference. The navigation preference may not be null
        +
        fragment - The currently shown preference fragment as an instance of the class Fragment. The + fragment may not be null
        +
        bundle - A bundle, which contains the parameters, which have been passed to the currently + shown preference fragment, as an instance of the class Bundle or null, if no + parameters have been passed to the fragment
        +
        Returns:
        +
        True, if skipping the wizard should be allowed, false otherwise
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/doc/javadoc/de/mrapp/android/preference/activity/adapter/NavigationPreferenceAdapter.Callback.html b/doc/javadoc/de/mrapp/android/preference/activity/adapter/NavigationPreferenceAdapter.Callback.html new file mode 100644 index 0000000..5e66f68 --- /dev/null +++ b/doc/javadoc/de/mrapp/android/preference/activity/adapter/NavigationPreferenceAdapter.Callback.html @@ -0,0 +1,328 @@ + + + + + +NavigationPreferenceAdapter.Callback + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
de.mrapp.android.preference.activity.adapter
+

Interface NavigationPreferenceAdapter.Callback

+
+
+
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        onSelectNavigationPreference

        +
        boolean onSelectNavigationPreference(@NonNull
+                                     NavigationPreference navigationPreference)
        +
        The method, which is invoked, when a navigation preference is about to be selected.
        +
        +
        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

        +
        void onNavigationPreferenceSelected(@NonNull
+                                    NavigationPreference navigationPreference,
+                                    @Nullable
+                                    android.os.Bundle arguments)
        +
        The method, which is invoked, when a navigation preference has been selected.
        +
        +
        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

        +
        void onNavigationPreferenceUnselected()
        +
        The method, which is invoked, when a navigation preference has been unselected.
        +
        • +
      + + + +
        +
      • +

        onNavigationPreferenceAdded

        +
        void onNavigationPreferenceAdded(@NonNull
+                                 NavigationPreference navigationPreference)
        +
        The method, which is invoked, when a navigation preference has been added.
        +
        +
        Parameters:
        +
        navigationPreference - The navigation preference, which has been added, as an instance of the class + NavigationPreference. The navigation preference may not be null
        +
        +
        • +
      + + + +
        +
      • +

        onNavigationPreferenceRemoved

        +
        void onNavigationPreferenceRemoved(@NonNull
+                                   NavigationPreference navigationPreference)
        +
        The method, which is invoked, when a navigation preference has been removed.
        +
        +
        Parameters:
        +
        navigationPreference - The navigation preference, which has been removed, as an instance of the class + NavigationPreference. The navigation preference may not be null
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/doc/javadoc/de/mrapp/android/preference/activity/adapter/NavigationPreferenceAdapter.html b/doc/javadoc/de/mrapp/android/preference/activity/adapter/NavigationPreferenceAdapter.html new file mode 100644 index 0000000..520f557 --- /dev/null +++ b/doc/javadoc/de/mrapp/android/preference/activity/adapter/NavigationPreferenceAdapter.html @@ -0,0 +1,636 @@ + + + + + +NavigationPreferenceAdapter + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
de.mrapp.android.preference.activity.adapter
+

Class NavigationPreferenceAdapter

+
+
+ +
+ +
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      + + + + + + + + + + +
      Nested Classes 
      Modifier and TypeClass and Description
      static interface NavigationPreferenceAdapter.Callback +
      Defines the callback, a class, which should be notified about the adapter's events, must + implement.
      +
      +
      • +
    + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      java.util.List<NavigationPreference>getAllNavigationPreferences() +
      Returns a list, which contains all navigation preferences, which are contained by the + adapter.
      +
      NavigationPreferencegetNavigationPreference(int index) +
      Returns the navigation preference, which corresponds to a specific index.
      +
      intgetNavigationPreferenceCount() +
      Returns the number of navigation preferences, which are contained by the adapter.
      +
      NavigationPreferencegetSelectedNavigationPreference() +
      Returns the currently selected navigation preference.
      +
      intgetSelectedNavigationPreferenceIndex() +
      Returns the index of the navigation preference, which is currently selected, among all + navigation preferences.
      +
      intindexOfNavigationPreference(NavigationPreference navigationPreference) +
      Returns the index of a specific navigation preference among all navigation preferences, which + are contained by the adapter.
      +
      voidonShowFragment(NavigationPreference navigationPreference) +
      The method, which is invoked, when the fragment, which is associated with a specific + navigation preference, should be shown.
      +
      protected voidonVisualizePreference(android.support.v7.preference.Preference preference, + android.support.v7.preference.PreferenceViewHolder viewHolder) +
      The method, which is invoked, when a specific preference is visualized.
      +
      voidselectNavigationPreference(int index, + android.os.Bundle arguments) +
      Selects a specific navigation preference.
      +
      voidselectNavigationPreference(NavigationPreference navigationPreference, + android.os.Bundle arguments) +
      Selects a specific navigation preference.
      +
      voidsetEnabled(boolean enabled) +
      Sets, whether the items of the adapter are enabled, i.e.
      +
      voidsetSelectionColor(int color) +
      Sets the background color of the currently selected navigation preference.
      +
      + +
        +
      • + + +

        Methods inherited from class android.support.v7.preference.PreferenceGroupAdapter

        +getItem, getItemCount, getItemId, getItemViewType, getPreferenceAdapterPosition, getPreferenceAdapterPosition, onCreateViewHolder, onPreferenceChange, onPreferenceHierarchyChange, onPreferenceVisibilityChange
        • +
      +
        +
      • + + +

        Methods inherited from class android.support.v7.widget.RecyclerView.Adapter

        +bindViewHolder, createViewHolder, hasObservers, hasStableIds, notifyDataSetChanged, notifyItemChanged, notifyItemChanged, notifyItemInserted, notifyItemMoved, notifyItemRangeChanged, notifyItemRangeChanged, notifyItemRangeInserted, notifyItemRangeRemoved, notifyItemRemoved, onAttachedToRecyclerView, onBindViewHolder, onDetachedFromRecyclerView, onFailedToRecycleView, onViewAttachedToWindow, onViewDetachedFromWindow, onViewRecycled, registerAdapterDataObserver, setHasStableIds, unregisterAdapterDataObserver
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        NavigationPreferenceAdapter

        +
        public NavigationPreferenceAdapter(@NonNull
+                                   android.support.v7.preference.PreferenceScreen preferenceScreen,
+                                   @Nullable
+                                   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

        +
        @NonNull
+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(@NonNull
+                                             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

        +
        @NonNull
+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

        +
        @Nullable
+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(@Nullable
+                                             NavigationPreference navigationPreference,
+                                             @Nullable
+                                             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,
+                                             @Nullable
+                                             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(@NonNull
+                                 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(@NonNull
+                                           android.support.v7.preference.Preference preference,
+                                           @NonNull
+                                           android.support.v7.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
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/doc/javadoc/de/mrapp/android/preference/activity/adapter/PreferenceAdapter.html b/doc/javadoc/de/mrapp/android/preference/activity/adapter/PreferenceAdapter.html new file mode 100644 index 0000000..ec64551 --- /dev/null +++ b/doc/javadoc/de/mrapp/android/preference/activity/adapter/PreferenceAdapter.html @@ -0,0 +1,355 @@ + + + + + +PreferenceAdapter + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
de.mrapp.android.preference.activity.adapter
+

Class PreferenceAdapter

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    android.support.v7.preference.PreferenceGroup.PreferencePositionCallback
    +
    +
    +
    Direct Known Subclasses:
    +
    NavigationPreferenceAdapter
    +
    +
    +
    +
    public class PreferenceAdapter
+extends android.support.v7.preference.PreferenceGroupAdapter
    +
    A recycler view adapter, which extends the class PreferenceGroupAdapter in order to modify the + appearance of preferences.
    +
    +
    Since:
    +
    6.0.0
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      PreferenceAdapter(android.support.v7.preference.PreferenceScreen preferenceScreen) +
      Creates a new recycler view adapter, which extends the class PreferenceGroupAdapter in order + to modify the appearance of preferences.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      voidonBindViewHolder(android.support.v7.preference.PreferenceViewHolder viewHolder, + int position) 
      protected voidonVisualizePreference(android.support.v7.preference.Preference preference, + android.support.v7.preference.PreferenceViewHolder viewHolder) +
      The method, which is invoked, when a specific preference is visualized.
      +
      +
        +
      • + + +

        Methods inherited from class android.support.v7.preference.PreferenceGroupAdapter

        +getItem, getItemCount, getItemId, getItemViewType, getPreferenceAdapterPosition, getPreferenceAdapterPosition, onCreateViewHolder, onPreferenceChange, onPreferenceHierarchyChange, onPreferenceVisibilityChange
        • +
      +
        +
      • + + +

        Methods inherited from class android.support.v7.widget.RecyclerView.Adapter

        +bindViewHolder, createViewHolder, hasObservers, hasStableIds, notifyDataSetChanged, notifyItemChanged, notifyItemChanged, notifyItemInserted, notifyItemMoved, notifyItemRangeChanged, notifyItemRangeChanged, notifyItemRangeInserted, notifyItemRangeRemoved, notifyItemRemoved, onAttachedToRecyclerView, onBindViewHolder, onDetachedFromRecyclerView, onFailedToRecycleView, onViewAttachedToWindow, onViewDetachedFromWindow, onViewRecycled, registerAdapterDataObserver, setHasStableIds, unregisterAdapterDataObserver
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        PreferenceAdapter

        +
        public PreferenceAdapter(@NonNull
+                         android.support.v7.preference.PreferenceScreen preferenceScreen)
        +
        Creates a new recycler view adapter, which extends the class PreferenceGroupAdapter in order + to modify the appearance of preferences.
        +
        +
        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
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        onVisualizePreference

        +
        @CallSuper
+protected void onVisualizePreference(@NonNull
+                                                android.support.v7.preference.Preference preference,
+                                                @NonNull
+                                                android.support.v7.preference.PreferenceViewHolder viewHolder)
        +
        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.
        +
        +
        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
        +
        +
        • +
      + + + +
        +
      • +

        onBindViewHolder

        +
        public final void onBindViewHolder(@NonNull
+                                   android.support.v7.preference.PreferenceViewHolder viewHolder,
+                                   int position)
        +
        +
        Overrides:
        +
        onBindViewHolder in class android.support.v7.preference.PreferenceGroupAdapter
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/doc/javadoc/de/mrapp/android/preference/activity/adapter/package-frame.html b/doc/javadoc/de/mrapp/android/preference/activity/adapter/package-frame.html new file mode 100644 index 0000000..96867fd --- /dev/null +++ b/doc/javadoc/de/mrapp/android/preference/activity/adapter/package-frame.html @@ -0,0 +1,25 @@ + + + + + +de.mrapp.android.preference.activity.adapter + + + + + +

de.mrapp.android.preference.activity.adapter

+
+

Interfaces

+ +

Classes

+ +
+ + diff --git a/doc/javadoc/de/mrapp/android/preference/activity/adapter/package-summary.html b/doc/javadoc/de/mrapp/android/preference/activity/adapter/package-summary.html new file mode 100644 index 0000000..a5b1c7b --- /dev/null +++ b/doc/javadoc/de/mrapp/android/preference/activity/adapter/package-summary.html @@ -0,0 +1,167 @@ + + + + + +de.mrapp.android.preference.activity.adapter + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package de.mrapp.android.preference.activity.adapter

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/javadoc/de/mrapp/android/preference/activity/adapter/package-tree.html b/doc/javadoc/de/mrapp/android/preference/activity/adapter/package-tree.html new file mode 100644 index 0000000..6558ce9 --- /dev/null +++ b/doc/javadoc/de/mrapp/android/preference/activity/adapter/package-tree.html @@ -0,0 +1,151 @@ + + + + + +de.mrapp.android.preference.activity.adapter Class Hierarchy + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package de.mrapp.android.preference.activity.adapter

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/javadoc/de/mrapp/android/preference/activity/animation/HideViewOnScrollAnimation.Direction.html b/doc/javadoc/de/mrapp/android/preference/activity/animation/HideViewOnScrollAnimation.Direction.html new file mode 100644 index 0000000..da61e75 --- /dev/null +++ b/doc/javadoc/de/mrapp/android/preference/activity/animation/HideViewOnScrollAnimation.Direction.html @@ -0,0 +1,351 @@ + + + + + +HideViewOnScrollAnimation.Direction + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
de.mrapp.android.preference.activity.animation
+

Enum HideViewOnScrollAnimation.Direction

+
+
+ +
+ +
+
+
    +
  • + +
      +
    • + + +

      Enum Constant Summary

      + + + + + + + + + + + +
      Enum Constants 
      Enum Constant and Description
      DOWN +
      If the view should be translated downwards.
      +
      UP +
      If the view should be translated upwards.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static HideViewOnScrollAnimation.DirectionvalueOf(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static HideViewOnScrollAnimation.Direction[]values() +
      Returns an array containing the constants of this enum type, in +the order they are declared.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static HideViewOnScrollAnimation.Direction[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (HideViewOnScrollAnimation.Direction c : HideViewOnScrollAnimation.Direction.values())
+    System.out.println(c);
+
        +
        +
        Returns:
        +
        an array containing the constants of this enum type, in the order they are declared
        +
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static HideViewOnScrollAnimation.Direction valueOf(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        +
        Parameters:
        +
        name - the name of the enum constant to be returned.
        +
        Returns:
        +
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/doc/javadoc/de/mrapp/android/preference/activity/animation/HideViewOnScrollAnimation.html b/doc/javadoc/de/mrapp/android/preference/activity/animation/HideViewOnScrollAnimation.html new file mode 100644 index 0000000..11966b8 --- /dev/null +++ b/doc/javadoc/de/mrapp/android/preference/activity/animation/HideViewOnScrollAnimation.html @@ -0,0 +1,508 @@ + + + + + +HideViewOnScrollAnimation + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
de.mrapp.android.preference.activity.animation
+

Class HideViewOnScrollAnimation

+
+
+ +
+
    +
  • +
    +
    +
    public class HideViewOnScrollAnimation
+extends android.support.v7.widget.RecyclerView.OnScrollListener
    +
    A scroll listener, which allows to animate a view to become hidden or shown depending on the + observed list view's scrolling direction.
    +
    +
    Since:
    +
    2.0.0
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      + + + + + + + + + + +
      Nested Classes 
      Modifier and TypeClass and Description
      static class HideViewOnScrollAnimation.Direction +
      Contains all possible directions, which can be used to translate the animated view in order + hide it.
      +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      HideViewOnScrollAnimation(android.view.View view, + HideViewOnScrollAnimation.Direction direction) +
      Creates a new scroll listener, which allows to animate a view to become hidden or shown + depending on the observed list view's scrolling direction.
      +
      HideViewOnScrollAnimation(android.view.View view, + HideViewOnScrollAnimation.Direction direction, + long animationDuration) +
      Creates a new scroll listener, which allows to animate a view to become hidden or shown + depending on the observed list view's scrolling direction.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      voidaddListener(HideViewOnScrollAnimationListener listener) +
      Adds a new listener, which should be notified about the animation's internal state, to the + animation.
      +
      longgetAnimationDuration() +
      Returns the duration of the animation, which is used to show or hide the view.
      +
      HideViewOnScrollAnimation.DirectiongetDirection() +
      Returns the direction, which should be be used to translate the view in order to hide it.
      +
      android.view.ViewgetView() +
      Returns the view, which is animated by the listener.
      +
      voidhideView() +
      Hides the view.
      +
      voidonScrolled(android.support.v7.widget.RecyclerView recyclerView, + int dx, + int dy) 
      voidremoveListener(HideViewOnScrollAnimationListener listener) +
      Removes a specific listener, which should not be notified about the animation's internal + state, from the animation.
      +
      voidshowView() +
      Shows the view.
      +
      +
        +
      • + + +

        Methods inherited from class android.support.v7.widget.RecyclerView.OnScrollListener

        +onScrollStateChanged
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        HideViewOnScrollAnimation

        +
        public HideViewOnScrollAnimation(@NonNull
+                                 android.view.View view,
+                                 @NonNull
+                                 HideViewOnScrollAnimation.Direction direction)
        +
        Creates a new scroll listener, which allows to animate a view to become hidden or shown + depending on the observed list view's scrolling direction.
        +
        +
        Parameters:
        +
        view - The view, which should be animated by the listener, as an instance of the class + View. The view may not be null
        +
        direction - The direction, which should be be used to translate the view in order to hide it, as + a value of the enum HideViewOnScrollAnimation.Direction. The direction may either be UP or + DOWN
        +
        +
        • +
      + + + +
        +
      • +

        HideViewOnScrollAnimation

        +
        public HideViewOnScrollAnimation(@NonNull
+                                 android.view.View view,
+                                 @NonNull
+                                 HideViewOnScrollAnimation.Direction direction,
+                                 long animationDuration)
        +
        Creates a new scroll listener, which allows to animate a view to become hidden or shown + depending on the observed list view's scrolling direction.
        +
        +
        Parameters:
        +
        view - The view, which should be animated by the listener, as an instance of the class + View. The view may not be null
        +
        direction - The direction, which should be be used to translate the view in order to hide it, as + a value of the enum HideViewOnScrollAnimation.Direction. The direction may either be UP or + DOWN
        +
        animationDuration - The duration of the animation, which is used to show or hide the view, in + milliseconds as a Long value. The duration must be greater than 0
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        showView

        +
        public final void showView()
        +
        Shows the view.
        +
        • +
      + + + +
        +
      • +

        hideView

        +
        public final void hideView()
        +
        Hides the view.
        +
        • +
      + + + +
        +
      • +

        getView

        +
        public final android.view.View getView()
        +
        Returns the view, which is animated by the listener.
        +
        +
        Returns:
        +
        The view, which is animated by the listener as an instance of the class View
        +
        +
        • +
      + + + +
        +
      • +

        getDirection

        +
        public final HideViewOnScrollAnimation.Direction getDirection()
        +
        Returns the direction, which should be be used to translate the view in order to hide it.
        +
        +
        Returns:
        +
        The direction, which should be be used to translate the view in order to hide it, as + a value of the enum HideViewOnScrollAnimation.Direction. The direction may either be UP or + DOWN
        +
        +
        • +
      + + + +
        +
      • +

        getAnimationDuration

        +
        public final long getAnimationDuration()
        +
        Returns the duration of the animation, which is used to show or hide the view.
        +
        +
        Returns:
        +
        The duration of the animation, which is used to show or hide the view, in + milliseconds as a Long value
        +
        +
        • +
      + + + +
        +
      • +

        addListener

        +
        public final void addListener(@NonNull
+                              HideViewOnScrollAnimationListener listener)
        +
        Adds a new listener, which should be notified about the animation's internal state, to the + animation.
        +
        +
        Parameters:
        +
        listener - The listener, which should be added, as an instance of the type HideViewOnScrollAnimationListener. The listener may not be null
        +
        +
        • +
      + + + +
        +
      • +

        removeListener

        +
        public final void removeListener(@NonNull
+                                 HideViewOnScrollAnimationListener listener)
        +
        Removes a specific listener, which should not be notified about the animation's internal + state, from the animation.
        +
        +
        Parameters:
        +
        listener - The listener, which should be removed, as an instance of the tpye HideViewOnScrollAnimationListener. The listener may not be null
        +
        +
        • +
      + + + +
        +
      • +

        onScrolled

        +
        public final void onScrolled(android.support.v7.widget.RecyclerView recyclerView,
+                             int dx,
+                             int dy)
        +
        +
        Overrides:
        +
        onScrolled in class android.support.v7.widget.RecyclerView.OnScrollListener
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/doc/javadoc/de/mrapp/android/preference/activity/animation/HideViewOnScrollAnimationListener.html b/doc/javadoc/de/mrapp/android/preference/activity/animation/HideViewOnScrollAnimationListener.html new file mode 100644 index 0000000..9d0b4ee --- /dev/null +++ b/doc/javadoc/de/mrapp/android/preference/activity/animation/HideViewOnScrollAnimationListener.html @@ -0,0 +1,273 @@ + + + + + +HideViewOnScrollAnimationListener + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
de.mrapp.android.preference.activity.animation
+

Interface HideViewOnScrollAnimationListener

+
+
+
+
    +
  • +
    +
    +
    public interface HideViewOnScrollAnimationListener
    +
    Defines the interface, a class, which should be notified about the internal state of a HideViewOnScrollAnimation, must implement.
    +
    +
    Since:
    +
    2.0.3
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethod and Description
      voidonScrollingDown(HideViewOnScrollAnimation animation, + android.view.View animatedView, + int scrollPosition) +
      The method, which is invoked, when the list view, which is observed by the animation, is + scrolling downwards.
      +
      voidonScrollingUp(HideViewOnScrollAnimation animation, + android.view.View animatedView, + int scrollPosition) +
      The method, which is invoked, when the list view, which is observed by the animation, is + scrolling upwards.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        onScrollingDown

        +
        void onScrollingDown(@NonNull
+                     HideViewOnScrollAnimation animation,
+                     @NonNull
+                     android.view.View animatedView,
+                     int scrollPosition)
        +
        The method, which is invoked, when the list view, which is observed by the animation, is + scrolling downwards.
        +
        +
        Parameters:
        +
        animation - The observer animation, as an instance of the class HideViewOnScrollAnimation
        +
        animatedView - The view, which is animated by the observed animation, as an instance of the class + View
        +
        scrollPosition - The current scroll position of the list view's first item in pixels as an Integer value
        +
        +
        • +
      + + + +
        +
      • +

        onScrollingUp

        +
        void onScrollingUp(@NonNull
+                   HideViewOnScrollAnimation animation,
+                   @NonNull
+                   android.view.View animatedView,
+                   int scrollPosition)
        +
        The method, which is invoked, when the list view, which is observed by the animation, is + scrolling upwards.
        +
        +
        Parameters:
        +
        animation - The observer animation, as an instance of the class HideViewOnScrollAnimation
        +
        animatedView - The view, which is animated by the observed animation, as an instance of the class + View
        +
        scrollPosition - The current scroll position of the list view's first item in pixels as an Integer value
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/doc/javadoc/de/mrapp/android/preference/activity/animation/package-frame.html b/doc/javadoc/de/mrapp/android/preference/activity/animation/package-frame.html new file mode 100644 index 0000000..078a589 --- /dev/null +++ b/doc/javadoc/de/mrapp/android/preference/activity/animation/package-frame.html @@ -0,0 +1,28 @@ + + + + + +de.mrapp.android.preference.activity.animation + + + + + +

de.mrapp.android.preference.activity.animation

+
+

Interfaces

+ +

Classes

+ +

Enums

+ +
+ + diff --git a/doc/javadoc/de/mrapp/android/preference/activity/animation/package-summary.html b/doc/javadoc/de/mrapp/android/preference/activity/animation/package-summary.html new file mode 100644 index 0000000..ddfbc2f --- /dev/null +++ b/doc/javadoc/de/mrapp/android/preference/activity/animation/package-summary.html @@ -0,0 +1,178 @@ + + + + + +de.mrapp.android.preference.activity.animation + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package de.mrapp.android.preference.activity.animation

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/javadoc/de/mrapp/android/preference/activity/animation/package-tree.html b/doc/javadoc/de/mrapp/android/preference/activity/animation/package-tree.html new file mode 100644 index 0000000..82a711f --- /dev/null +++ b/doc/javadoc/de/mrapp/android/preference/activity/animation/package-tree.html @@ -0,0 +1,155 @@ + + + + + +de.mrapp.android.preference.activity.animation Class Hierarchy + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package de.mrapp.android.preference.activity.animation

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +

Enum Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/javadoc/de/mrapp/android/preference/activity/fragment/AbstractPreferenceFragment.html b/doc/javadoc/de/mrapp/android/preference/activity/fragment/AbstractPreferenceFragment.html new file mode 100644 index 0000000..cc0079b --- /dev/null +++ b/doc/javadoc/de/mrapp/android/preference/activity/fragment/AbstractPreferenceFragment.html @@ -0,0 +1,458 @@ + + + + + +AbstractPreferenceFragment + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
de.mrapp.android.preference.activity.fragment
+

Class AbstractPreferenceFragment

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    android.arch.lifecycle.LifecycleOwner, android.arch.lifecycle.ViewModelStoreOwner, android.content.ComponentCallbacks, android.support.v7.preference.DialogPreference.TargetFragment, android.support.v7.preference.PreferenceManager.OnDisplayPreferenceDialogListener, android.support.v7.preference.PreferenceManager.OnNavigateToScreenListener, android.support.v7.preference.PreferenceManager.OnPreferenceTreeClickListener, android.view.View.OnCreateContextMenuListener
    +
    +
    +
    Direct Known Subclasses:
    +
    NavigationFragment, PreferenceFragment
    +
    +
    +
    +
    public abstract class AbstractPreferenceFragment
+extends android.support.v7.preference.PreferenceFragmentCompat
    +
    An abstract base class for all fragments, which show multiple preferences.
    +
    +
    Since:
    +
    5.0.0
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      +
        +
      • + + +

        Nested classes/interfaces inherited from class android.support.v7.preference.PreferenceFragmentCompat

        +android.support.v7.preference.PreferenceFragmentCompat.OnPreferenceDisplayDialogCallback, android.support.v7.preference.PreferenceFragmentCompat.OnPreferenceStartFragmentCallback, android.support.v7.preference.PreferenceFragmentCompat.OnPreferenceStartScreenCallback
        • +
      +
        +
      • + + +

        Nested classes/interfaces inherited from class android.support.v4.app.Fragment

        +android.support.v4.app.Fragment.InstantiationException, android.support.v4.app.Fragment.SavedState
        • +
      +
      • +
    + +
      +
    • + + +

      Field Summary

      +
        +
      • + + +

        Fields inherited from class android.support.v7.preference.PreferenceFragmentCompat

        +ARG_PREFERENCE_ROOT
        • +
      +
      • +
    + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      intgetDividerColor() +
      Returns the color of the dividers, which are shown above preference categories.
      +
      voidonCreate(android.os.Bundle savedInstanceState) 
      protected android.support.v7.widget.RecyclerView.Adapter<?>onCreateAdapter(android.support.v7.preference.PreferenceScreen preferenceScreen) 
      protected PreferenceAdapteronCreatePreferenceAdapter(android.support.v7.preference.PreferenceScreen preferenceScreen) +
      The method, which is invoked in order to create the adapter, which is used to manage the + fragment's preferences.
      +
      android.view.ViewonCreateView(android.view.LayoutInflater inflater, + android.view.ViewGroup parent, + android.os.Bundle savedInstanceState) 
      voidsetDividerColor(int color) +
      Sets the color of the dividers, which are shown above preference categories.
      +
      +
        +
      • + + +

        Methods inherited from class android.support.v7.preference.PreferenceFragmentCompat

        +addPreferencesFromResource, findPreference, getCallbackFragment, getListView, getPreferenceManager, getPreferenceScreen, onActivityCreated, onBindPreferences, onCreateLayoutManager, onCreatePreferences, onCreateRecyclerView, onDestroyView, onDisplayPreferenceDialog, onNavigateToScreen, onPreferenceTreeClick, onSaveInstanceState, onStart, onStop, onUnbindPreferences, onViewCreated, scrollToPreference, scrollToPreference, setDivider, setDividerHeight, setPreferenceScreen, setPreferencesFromResource
        • +
      +
        +
      • + + +

        Methods inherited from class android.support.v4.app.Fragment

        +dump, equals, getActivity, getAllowEnterTransitionOverlap, getAllowReturnTransitionOverlap, getArguments, getChildFragmentManager, getContext, getEnterTransition, getExitTransition, getFragmentManager, getHost, getId, getLayoutInflater, getLayoutInflater, getLifecycle, getLoaderManager, getParentFragment, getReenterTransition, getResources, getRetainInstance, getReturnTransition, getSharedElementEnterTransition, getSharedElementReturnTransition, getString, getString, getTag, getTargetFragment, getTargetRequestCode, getText, getUserVisibleHint, getView, getViewModelStore, hashCode, hasOptionsMenu, instantiate, instantiate, isAdded, isDetached, isHidden, isInLayout, isMenuVisible, isRemoving, isResumed, isStateSaved, isVisible, onActivityResult, onAttach, onAttach, onAttachFragment, onConfigurationChanged, onContextItemSelected, onCreateAnimation, onCreateAnimator, onCreateContextMenu, onCreateOptionsMenu, onDestroy, onDestroyOptionsMenu, onDetach, onGetLayoutInflater, onHiddenChanged, onInflate, onInflate, onLowMemory, onMultiWindowModeChanged, onOptionsItemSelected, onOptionsMenuClosed, onPause, onPictureInPictureModeChanged, onPrepareOptionsMenu, onRequestPermissionsResult, onResume, onViewStateRestored, postponeEnterTransition, registerForContextMenu, requestPermissions, requireActivity, requireContext, requireFragmentManager, requireHost, setAllowEnterTransitionOverlap, setAllowReturnTransitionOverlap, setArguments, setEnterSharedElementCallback, setEnterTransition, setExitSharedElementCallback, setExitTransition, setHasOptionsMenu, setInitialSavedState, setMenuVisibility, setReenterTransition, setRetainInstance, setReturnTransition, setSharedElementEnterTransition, setSharedElementReturnTransition, setTargetFragment, setUserVisibleHint, shouldShowRequestPermissionRationale, startActivity, startActivity, startActivityForResult, startActivityForResult, startIntentSenderForResult, startPostponedEnterTransition, toString, unregisterForContextMenu
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        AbstractPreferenceFragment

        +
        public AbstractPreferenceFragment()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getDividerColor

        +
        public final int getDividerColor()
        +
        Returns the color of the dividers, which are shown above preference categories.
        +
        +
        Returns:
        +
        The color of the dividers, which are shown above preference categories, as an Integer value
        +
        +
        • +
      + + + +
        +
      • +

        setDividerColor

        +
        public final void setDividerColor(int color)
        +
        Sets the color of the dividers, which are shown above preference categories.
        +
        +
        Parameters:
        +
        color - The color, which should be set, as an Integer value
        +
        +
        • +
      + + + +
        +
      • +

        onCreatePreferenceAdapter

        +
        @NonNull
+protected PreferenceAdapter onCreatePreferenceAdapter(@NonNull
+                                                               android.support.v7.preference.PreferenceScreen preferenceScreen)
        +
        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.
        +
        +
        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
        +
        +
        • +
      + + + +
        +
      • +

        onCreate

        +
        @CallSuper
+public void onCreate(android.os.Bundle savedInstanceState)
        +
        +
        Overrides:
        +
        onCreate in class android.support.v7.preference.PreferenceFragmentCompat
        +
        +
        • +
      + + + +
        +
      • +

        onCreateView

        +
        @CallSuper
+ @NonNull
+public android.view.View onCreateView(android.view.LayoutInflater inflater,
+                                                           android.view.ViewGroup parent,
+                                                           android.os.Bundle savedInstanceState)
        +
        +
        Overrides:
        +
        onCreateView in class android.support.v7.preference.PreferenceFragmentCompat
        +
        +
        • +
      + + + +
        +
      • +

        onCreateAdapter

        +
        @NonNull
+protected final android.support.v7.widget.RecyclerView.Adapter<?> onCreateAdapter(android.support.v7.preference.PreferenceScreen preferenceScreen)
        +
        +
        Overrides:
        +
        onCreateAdapter in class android.support.v7.preference.PreferenceFragmentCompat
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/doc/javadoc/de/mrapp/android/preference/activity/fragment/NavigationFragment.Callback.html b/doc/javadoc/de/mrapp/android/preference/activity/fragment/NavigationFragment.Callback.html new file mode 100644 index 0000000..771fb77 --- /dev/null +++ b/doc/javadoc/de/mrapp/android/preference/activity/fragment/NavigationFragment.Callback.html @@ -0,0 +1,258 @@ + + + + + +NavigationFragment.Callback + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
de.mrapp.android.preference.activity.fragment
+

Interface NavigationFragment.Callback

+
+
+
+
    +
  • +
    +
    All Known Implementing Classes:
    +
    PreferenceActivity
    +
    +
    +
    Enclosing class:
    +
    NavigationFragment
    +
    +
    +
    +
    public static interface NavigationFragment.Callback
    +
    Defines the interface, a class, which should be notified about the fragment's events, must + implement.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethod and Description
      voidonNavigationAdapterCreated() +
      The method, which is invoked, when the adapter, which contains the navigation items, has + been created.
      +
      voidonNavigationFragmentCreated(android.support.v7.preference.PreferenceFragmentCompat fragment) +
      The method, which is invoked, when the navigation fragment has been attached to its + activity.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        onNavigationFragmentCreated

        +
        void onNavigationFragmentCreated(@NonNull
+                                 android.support.v7.preference.PreferenceFragmentCompat fragment)
        +
        The method, which is invoked, when the navigation fragment has been attached to its + activity.
        +
        +
        Parameters:
        +
        fragment - The navigation fragment as an instance of the class PreferenceFragmentCompat. The + fragment may not be null
        +
        +
        • +
      + + + +
        +
      • +

        onNavigationAdapterCreated

        +
        void onNavigationAdapterCreated()
        +
        The method, which is invoked, when the adapter, which contains the navigation items, has + been created.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/doc/javadoc/de/mrapp/android/preference/activity/fragment/NavigationFragment.html b/doc/javadoc/de/mrapp/android/preference/activity/fragment/NavigationFragment.html new file mode 100644 index 0000000..627064a --- /dev/null +++ b/doc/javadoc/de/mrapp/android/preference/activity/fragment/NavigationFragment.html @@ -0,0 +1,843 @@ + + + + + +NavigationFragment + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
de.mrapp.android.preference.activity.fragment
+

Class NavigationFragment

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    android.arch.lifecycle.LifecycleOwner, android.arch.lifecycle.ViewModelStoreOwner, android.content.ComponentCallbacks, android.support.v7.preference.DialogPreference.TargetFragment, android.support.v7.preference.PreferenceManager.OnDisplayPreferenceDialogListener, android.support.v7.preference.PreferenceManager.OnNavigateToScreenListener, android.support.v7.preference.PreferenceManager.OnPreferenceTreeClickListener, android.view.View.OnCreateContextMenuListener, 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 TypeClass and Description
      static interface NavigationFragment.Callback +
      Defines the interface, a class, which should be notified about the fragment's events, must + implement.
      +
      +
        +
      • + + +

        Nested classes/interfaces inherited from class android.support.v7.preference.PreferenceFragmentCompat

        +android.support.v7.preference.PreferenceFragmentCompat.OnPreferenceDisplayDialogCallback, android.support.v7.preference.PreferenceFragmentCompat.OnPreferenceStartFragmentCallback, android.support.v7.preference.PreferenceFragmentCompat.OnPreferenceStartScreenCallback
        • +
      +
        +
      • + + +

        Nested classes/interfaces inherited from class android.support.v4.app.Fragment

        +android.support.v4.app.Fragment.InstantiationException, android.support.v4.app.Fragment.SavedState
        • +
      +
      • +
    + +
      +
    • + + +

      Field Summary

      +
        +
      • + + +

        Fields inherited from class android.support.v7.preference.PreferenceFragmentCompat

        +ARG_PREFERENCE_ROOT
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      NavigationFragment() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      java.util.List<NavigationPreference>getAllNavigationPreferences() +
      Returns a list, which contains all navigation preferences, which are contained by the + navigation.
      +
      NavigationFragment.CallbackgetCallback() +
      Returns the callback, which is notified about the fragment's events.
      +
      NavigationPreferencegetNavigationPreference(int index) +
      Returns the navigation preference, which corresponds to a specific index.
      +
      intgetNavigationPreferenceCount() +
      Returns the number of navigation preferences, which are contained by the navigation.
      +
      NavigationPreferencegetSelectedNavigationPreference() +
      Returns the currently selected navigation preference.
      +
      intgetSelectedNavigationPreferenceIndex() +
      Returns the index of the navigation preference, which is currently selected, among all + navigation preferences.
      +
      booleanisAdapterCreated() +
      Returns, whether the adapter, which contains the navigation preferences, has been created + yet, or not.
      +
      voidonActivityCreated(android.os.Bundle savedInstanceState) 
      protected PreferenceAdapteronCreatePreferenceAdapter(android.support.v7.preference.PreferenceScreen preferenceScreen) +
      The method, which is invoked in order to create the adapter, which is used to manage the + fragment's preferences.
      +
      voidonCreatePreferences(android.os.Bundle savedInstanceState, + java.lang.String rootKey) 
      android.support.v7.widget.RecyclerViewonCreateRecyclerView(android.view.LayoutInflater inflater, + android.view.ViewGroup parent, + android.os.Bundle savedInstanceState) 
      voidonNavigationPreferenceAdded(NavigationPreference navigationPreference) +
      The method, which is invoked, when a navigation preference has been added.
      +
      voidonNavigationPreferenceRemoved(NavigationPreference navigationPreference) +
      The method, which is invoked, when a navigation preference has been removed.
      +
      voidonNavigationPreferenceSelected(NavigationPreference navigationPreference, + android.os.Bundle arguments) +
      The method, which is invoked, when a navigation preference has been selected.
      +
      voidonNavigationPreferenceUnselected() +
      The method, which is invoked, when a navigation preference has been unselected.
      +
      booleanonSelectNavigationPreference(NavigationPreference navigationPreference) +
      The method, which is invoked, when a navigation preference is about to be selected.
      +
      voidselectNavigationPreference(int index, + android.os.Bundle arguments) +
      Selects a specific navigation preference.
      +
      voidsetAdapterCallback(NavigationPreferenceAdapter.Callback callback) +
      Sets the callback, which should be notified about the events of the adapter, which contains + the navigation preferences.
      +
      voidsetCallback(NavigationFragment.Callback callback) +
      Sets the callback, which should be notified about the fragment's events.
      +
      voidsetEnabled(boolean enabled) +
      Sets, whether the navigation should be enabled, i.e.
      +
      voidsetSelectionColor(int color) +
      Sets the background color of the currently selected navigation preference.
      +
      + +
        +
      • + + +

        Methods inherited from class android.support.v7.preference.PreferenceFragmentCompat

        +addPreferencesFromResource, findPreference, getCallbackFragment, getListView, getPreferenceManager, getPreferenceScreen, onBindPreferences, onCreateLayoutManager, onDestroyView, onDisplayPreferenceDialog, onNavigateToScreen, onPreferenceTreeClick, onSaveInstanceState, onStart, onStop, onUnbindPreferences, onViewCreated, scrollToPreference, scrollToPreference, setDivider, setDividerHeight, setPreferenceScreen, setPreferencesFromResource
        • +
      +
        +
      • + + +

        Methods inherited from class android.support.v4.app.Fragment

        +dump, equals, getActivity, getAllowEnterTransitionOverlap, getAllowReturnTransitionOverlap, getArguments, getChildFragmentManager, getContext, getEnterTransition, getExitTransition, getFragmentManager, getHost, getId, getLayoutInflater, getLayoutInflater, getLifecycle, getLoaderManager, getParentFragment, getReenterTransition, getResources, getRetainInstance, getReturnTransition, getSharedElementEnterTransition, getSharedElementReturnTransition, getString, getString, getTag, getTargetFragment, getTargetRequestCode, getText, getUserVisibleHint, getView, getViewModelStore, hashCode, hasOptionsMenu, instantiate, instantiate, isAdded, isDetached, isHidden, isInLayout, isMenuVisible, isRemoving, isResumed, isStateSaved, isVisible, onActivityResult, onAttach, onAttach, onAttachFragment, onConfigurationChanged, onContextItemSelected, onCreateAnimation, onCreateAnimator, onCreateContextMenu, onCreateOptionsMenu, onDestroy, onDestroyOptionsMenu, onDetach, onGetLayoutInflater, onHiddenChanged, onInflate, onInflate, onLowMemory, onMultiWindowModeChanged, onOptionsItemSelected, onOptionsMenuClosed, onPause, onPictureInPictureModeChanged, onPrepareOptionsMenu, onRequestPermissionsResult, onResume, onViewStateRestored, postponeEnterTransition, registerForContextMenu, requestPermissions, requireActivity, requireContext, requireFragmentManager, requireHost, setAllowEnterTransitionOverlap, setAllowReturnTransitionOverlap, setArguments, setEnterSharedElementCallback, setEnterTransition, setExitSharedElementCallback, setExitTransition, setHasOptionsMenu, setInitialSavedState, setMenuVisibility, setReenterTransition, setRetainInstance, setReturnTransition, setSharedElementEnterTransition, setSharedElementReturnTransition, setTargetFragment, setUserVisibleHint, shouldShowRequestPermissionRationale, startActivity, startActivity, startActivityForResult, startActivityForResult, startIntentSenderForResult, startPostponedEnterTransition, toString, unregisterForContextMenu
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        NavigationFragment

        +
        public NavigationFragment()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setCallback

        +
        public final void setCallback(@Nullable
+                              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

        +
        @Nullable
+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(@Nullable
+                                     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

        +
        @Nullable
+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,
+                                             @Nullable
+                                             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
        +
        +
        • +
      + + + + + + + +
        +
      • +

        onNavigationPreferenceSelected

        +
        public final void onNavigationPreferenceSelected(@NonNull
+                                                 NavigationPreference navigationPreference,
+                                                 @Nullable
+                                                 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
        +
        +
        • +
      + + + + + + + + + + + + + + + +
        +
      • +

        onActivityCreated

        +
        public final void onActivityCreated(android.os.Bundle savedInstanceState)
        +
        +
        Overrides:
        +
        onActivityCreated in class android.support.v7.preference.PreferenceFragmentCompat
        +
        +
        • +
      + + + +
        +
      • +

        onCreatePreferences

        +
        public void onCreatePreferences(android.os.Bundle savedInstanceState,
+                                java.lang.String rootKey)
        +
        +
        Specified by:
        +
        onCreatePreferences in class android.support.v7.preference.PreferenceFragmentCompat
        +
        +
        • +
      + + + +
        +
      • +

        onCreateRecyclerView

        +
        @NonNull
+public final android.support.v7.widget.RecyclerView onCreateRecyclerView(android.view.LayoutInflater inflater,
+                                                                                  android.view.ViewGroup parent,
+                                                                                  android.os.Bundle savedInstanceState)
        +
        +
        Overrides:
        +
        onCreateRecyclerView in class android.support.v7.preference.PreferenceFragmentCompat
        +
        +
        • +
      + + + +
        +
      • +

        onCreatePreferenceAdapter

        +
        @NonNull
+protected final PreferenceAdapter onCreatePreferenceAdapter(@NonNull
+                                                                     android.support.v7.preference.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
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/doc/javadoc/de/mrapp/android/preference/activity/fragment/package-frame.html b/doc/javadoc/de/mrapp/android/preference/activity/fragment/package-frame.html new file mode 100644 index 0000000..36591cf --- /dev/null +++ b/doc/javadoc/de/mrapp/android/preference/activity/fragment/package-frame.html @@ -0,0 +1,25 @@ + + + + + +de.mrapp.android.preference.activity.fragment + + + + + +

de.mrapp.android.preference.activity.fragment

+
+

Interfaces

+ +

Classes

+ +
+ + diff --git a/doc/javadoc/de/mrapp/android/preference/activity/fragment/package-summary.html b/doc/javadoc/de/mrapp/android/preference/activity/fragment/package-summary.html new file mode 100644 index 0000000..06930c8 --- /dev/null +++ b/doc/javadoc/de/mrapp/android/preference/activity/fragment/package-summary.html @@ -0,0 +1,166 @@ + + + + + +de.mrapp.android.preference.activity.fragment + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package de.mrapp.android.preference.activity.fragment

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/javadoc/de/mrapp/android/preference/activity/fragment/package-tree.html b/doc/javadoc/de/mrapp/android/preference/activity/fragment/package-tree.html new file mode 100644 index 0000000..99af8fc --- /dev/null +++ b/doc/javadoc/de/mrapp/android/preference/activity/fragment/package-tree.html @@ -0,0 +1,151 @@ + + + + + +de.mrapp.android.preference.activity.fragment Class Hierarchy + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package de.mrapp.android.preference.activity.fragment

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/javadoc/de/mrapp/android/preference/activity/package-frame.html b/doc/javadoc/de/mrapp/android/preference/activity/package-frame.html new file mode 100644 index 0000000..0f0098f --- /dev/null +++ b/doc/javadoc/de/mrapp/android/preference/activity/package-frame.html @@ -0,0 +1,31 @@ + + + + + +de.mrapp.android.preference.activity + + + + + +

de.mrapp.android.preference.activity

+
+

Interfaces

+ +

Classes

+ +
+ + diff --git a/doc/javadoc/de/mrapp/android/preference/activity/package-summary.html b/doc/javadoc/de/mrapp/android/preference/activity/package-summary.html new file mode 100644 index 0000000..15518a4 --- /dev/null +++ b/doc/javadoc/de/mrapp/android/preference/activity/package-summary.html @@ -0,0 +1,206 @@ + + + + + +de.mrapp.android.preference.activity + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package de.mrapp.android.preference.activity

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/javadoc/de/mrapp/android/preference/activity/package-tree.html b/doc/javadoc/de/mrapp/android/preference/activity/package-tree.html new file mode 100644 index 0000000..fcb350f --- /dev/null +++ b/doc/javadoc/de/mrapp/android/preference/activity/package-tree.html @@ -0,0 +1,194 @@ + + + + + +de.mrapp.android.preference.activity Class Hierarchy + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package de.mrapp.android.preference.activity

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/javadoc/de/mrapp/android/preference/activity/view/ToolbarLarge.html b/doc/javadoc/de/mrapp/android/preference/activity/view/ToolbarLarge.html new file mode 100644 index 0000000..af16d73 --- /dev/null +++ b/doc/javadoc/de/mrapp/android/preference/activity/view/ToolbarLarge.html @@ -0,0 +1,596 @@ + + + + + +ToolbarLarge + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
de.mrapp.android.preference.activity.view
+

Class ToolbarLarge

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    android.graphics.drawable.Drawable.Callback, android.view.accessibility.AccessibilityEventSource, android.view.KeyEvent.Callback, android.view.ViewManager, android.view.ViewParent
    +
    +
    +
    +
    public class ToolbarLarge
+extends android.widget.FrameLayout
    +
    A custom view, which may be used to visualize a large toolbar on devices with a large screen.
    +
    +
    Since:
    +
    2.0.0
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      +
        +
      • + + +

        Nested classes/interfaces inherited from class android.widget.FrameLayout

        +android.widget.FrameLayout.LayoutParams
        • +
      +
        +
      • + + +

        Nested classes/interfaces inherited from class android.view.ViewGroup

        +android.view.ViewGroup.MarginLayoutParams, android.view.ViewGroup.OnHierarchyChangeListener
        • +
      +
        +
      • + + +

        Nested classes/interfaces inherited from class android.view.View

        +android.view.View.AccessibilityDelegate, android.view.View.BaseSavedState, android.view.View.DragShadowBuilder, android.view.View.MeasureSpec, android.view.View.OnApplyWindowInsetsListener, android.view.View.OnAttachStateChangeListener, android.view.View.OnCapturedPointerListener, android.view.View.OnClickListener, android.view.View.OnContextClickListener, android.view.View.OnCreateContextMenuListener, android.view.View.OnDragListener, android.view.View.OnFocusChangeListener, android.view.View.OnGenericMotionListener, android.view.View.OnHoverListener, android.view.View.OnKeyListener, android.view.View.OnLayoutChangeListener, android.view.View.OnLongClickListener, android.view.View.OnScrollChangeListener, android.view.View.OnSystemUiVisibilityChangeListener, android.view.View.OnTouchListener
        • +
      +
      • +
    + +
      +
    • + + +

      Field Summary

      +
        +
      • + + +

        Fields inherited from class android.view.ViewGroup

        +CLIP_TO_PADDING_MASK, FOCUS_AFTER_DESCENDANTS, FOCUS_BEFORE_DESCENDANTS, FOCUS_BLOCK_DESCENDANTS, LAYOUT_MODE_CLIP_BOUNDS, LAYOUT_MODE_OPTICAL_BOUNDS, PERSISTENT_ALL_CACHES, PERSISTENT_ANIMATION_CACHE, PERSISTENT_NO_CACHE, PERSISTENT_SCROLLING_CACHE
        • +
      +
        +
      • + + +

        Fields inherited from class android.view.View

        +ACCESSIBILITY_LIVE_REGION_ASSERTIVE, ACCESSIBILITY_LIVE_REGION_NONE, ACCESSIBILITY_LIVE_REGION_POLITE, ALPHA, AUTOFILL_FLAG_INCLUDE_NOT_IMPORTANT_VIEWS, AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_DATE, AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_DAY, AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_MONTH, AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_YEAR, AUTOFILL_HINT_CREDIT_CARD_NUMBER, AUTOFILL_HINT_CREDIT_CARD_SECURITY_CODE, AUTOFILL_HINT_EMAIL_ADDRESS, AUTOFILL_HINT_NAME, AUTOFILL_HINT_PASSWORD, AUTOFILL_HINT_PHONE, AUTOFILL_HINT_POSTAL_ADDRESS, AUTOFILL_HINT_POSTAL_CODE, AUTOFILL_HINT_USERNAME, AUTOFILL_TYPE_DATE, AUTOFILL_TYPE_LIST, AUTOFILL_TYPE_NONE, AUTOFILL_TYPE_TEXT, AUTOFILL_TYPE_TOGGLE, DRAG_FLAG_GLOBAL, DRAG_FLAG_GLOBAL_PERSISTABLE_URI_PERMISSION, DRAG_FLAG_GLOBAL_PREFIX_URI_PERMISSION, DRAG_FLAG_GLOBAL_URI_READ, DRAG_FLAG_GLOBAL_URI_WRITE, DRAG_FLAG_OPAQUE, DRAWING_CACHE_QUALITY_AUTO, DRAWING_CACHE_QUALITY_HIGH, DRAWING_CACHE_QUALITY_LOW, EMPTY_STATE_SET, ENABLED_FOCUSED_SELECTED_STATE_SET, ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET, ENABLED_FOCUSED_STATE_SET, ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET, ENABLED_SELECTED_STATE_SET, ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET, ENABLED_STATE_SET, ENABLED_WINDOW_FOCUSED_STATE_SET, FIND_VIEWS_WITH_CONTENT_DESCRIPTION, FIND_VIEWS_WITH_TEXT, FOCUS_BACKWARD, FOCUS_DOWN, FOCUS_FORWARD, FOCUS_LEFT, FOCUS_RIGHT, FOCUS_UP, FOCUSABLE, FOCUSABLE_AUTO, FOCUSABLES_ALL, FOCUSABLES_TOUCH_MODE, FOCUSED_SELECTED_STATE_SET, FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET, FOCUSED_STATE_SET, FOCUSED_WINDOW_FOCUSED_STATE_SET, GONE, HAPTIC_FEEDBACK_ENABLED, IMPORTANT_FOR_ACCESSIBILITY_AUTO, IMPORTANT_FOR_ACCESSIBILITY_NO, IMPORTANT_FOR_ACCESSIBILITY_NO_HIDE_DESCENDANTS, IMPORTANT_FOR_ACCESSIBILITY_YES, IMPORTANT_FOR_AUTOFILL_AUTO, IMPORTANT_FOR_AUTOFILL_NO, IMPORTANT_FOR_AUTOFILL_NO_EXCLUDE_DESCENDANTS, IMPORTANT_FOR_AUTOFILL_YES, IMPORTANT_FOR_AUTOFILL_YES_EXCLUDE_DESCENDANTS, INVISIBLE, KEEP_SCREEN_ON, LAYER_TYPE_HARDWARE, LAYER_TYPE_NONE, LAYER_TYPE_SOFTWARE, LAYOUT_DIRECTION_INHERIT, LAYOUT_DIRECTION_LOCALE, LAYOUT_DIRECTION_LTR, LAYOUT_DIRECTION_RTL, MEASURED_HEIGHT_STATE_SHIFT, MEASURED_SIZE_MASK, MEASURED_STATE_MASK, MEASURED_STATE_TOO_SMALL, NO_ID, NOT_FOCUSABLE, OVER_SCROLL_ALWAYS, OVER_SCROLL_IF_CONTENT_SCROLLS, OVER_SCROLL_NEVER, PRESSED_ENABLED_FOCUSED_SELECTED_STATE_SET, PRESSED_ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET, PRESSED_ENABLED_FOCUSED_STATE_SET, PRESSED_ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET, PRESSED_ENABLED_SELECTED_STATE_SET, PRESSED_ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET, PRESSED_ENABLED_STATE_SET, PRESSED_ENABLED_WINDOW_FOCUSED_STATE_SET, PRESSED_FOCUSED_SELECTED_STATE_SET, PRESSED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET, PRESSED_FOCUSED_STATE_SET, PRESSED_FOCUSED_WINDOW_FOCUSED_STATE_SET, PRESSED_SELECTED_STATE_SET, PRESSED_SELECTED_WINDOW_FOCUSED_STATE_SET, PRESSED_STATE_SET, PRESSED_WINDOW_FOCUSED_STATE_SET, ROTATION, ROTATION_X, ROTATION_Y, SCALE_X, SCALE_Y, SCREEN_STATE_OFF, SCREEN_STATE_ON, SCROLL_AXIS_HORIZONTAL, SCROLL_AXIS_NONE, SCROLL_AXIS_VERTICAL, SCROLL_INDICATOR_BOTTOM, SCROLL_INDICATOR_END, SCROLL_INDICATOR_LEFT, SCROLL_INDICATOR_RIGHT, SCROLL_INDICATOR_START, SCROLL_INDICATOR_TOP, SCROLLBAR_POSITION_DEFAULT, SCROLLBAR_POSITION_LEFT, SCROLLBAR_POSITION_RIGHT, SCROLLBARS_INSIDE_INSET, SCROLLBARS_INSIDE_OVERLAY, SCROLLBARS_OUTSIDE_INSET, SCROLLBARS_OUTSIDE_OVERLAY, SELECTED_STATE_SET, SELECTED_WINDOW_FOCUSED_STATE_SET, SOUND_EFFECTS_ENABLED, STATUS_BAR_HIDDEN, STATUS_BAR_VISIBLE, SYSTEM_UI_FLAG_FULLSCREEN, SYSTEM_UI_FLAG_HIDE_NAVIGATION, SYSTEM_UI_FLAG_IMMERSIVE, SYSTEM_UI_FLAG_IMMERSIVE_STICKY, SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN, SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION, SYSTEM_UI_FLAG_LAYOUT_STABLE, SYSTEM_UI_FLAG_LIGHT_NAVIGATION_BAR, SYSTEM_UI_FLAG_LIGHT_STATUS_BAR, SYSTEM_UI_FLAG_LOW_PROFILE, SYSTEM_UI_FLAG_VISIBLE, SYSTEM_UI_LAYOUT_FLAGS, TEXT_ALIGNMENT_CENTER, TEXT_ALIGNMENT_GRAVITY, TEXT_ALIGNMENT_INHERIT, TEXT_ALIGNMENT_TEXT_END, TEXT_ALIGNMENT_TEXT_START, TEXT_ALIGNMENT_VIEW_END, TEXT_ALIGNMENT_VIEW_START, TEXT_DIRECTION_ANY_RTL, TEXT_DIRECTION_FIRST_STRONG, TEXT_DIRECTION_FIRST_STRONG_LTR, TEXT_DIRECTION_FIRST_STRONG_RTL, TEXT_DIRECTION_INHERIT, TEXT_DIRECTION_LOCALE, TEXT_DIRECTION_LTR, TEXT_DIRECTION_RTL, TRANSLATION_X, TRANSLATION_Y, TRANSLATION_Z, VIEW_LOG_TAG, VISIBLE, WINDOW_FOCUSED_STATE_SET, X, Y, Z
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      ToolbarLarge(android.content.Context context) +
      Creates a custom view, which may be used to visualize a large toolbar on devices with a large + screen.
      +
      ToolbarLarge(android.content.Context context, + android.util.AttributeSet attributeSet) +
      Creates a custom view, which may be used to visualize a large toolbar on devices with a large + screen.
      +
      ToolbarLarge(android.content.Context context, + android.util.AttributeSet attributeSet, + int defaultStyle) +
      Creates a custom view, which may be used to visualize a large toolbar on devices with a large + screen.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      intgetNavigationWidth() +
      Returns the width of the navigation.
      +
      java.lang.CharSequencegetTitle() +
      Returns the toolbar's title.
      +
      android.support.v7.widget.ToolbargetToolbar() +
      Returns the toolbar, which is used to show the title.
      +
      voidhideNavigation(boolean navigationHidden) +
      Hides or shows the navigation.
      +
      booleanisNavigationHidden() +
      Returns, whether the navigation is hidden, or not.
      +
      voidsetNavigationWidth(int width) +
      Sets the width of the navigation.
      +
      voidsetTitle(java.lang.CharSequence title) +
      Sets the toolbar's title.
      +
      voidsetTitle(int resourceId) +
      Sets the toolbar's title.
      +
      +
        +
      • + + +

        Methods inherited from class android.widget.FrameLayout

        +checkLayoutParams, generateDefaultLayoutParams, generateLayoutParams, generateLayoutParams, getAccessibilityClassName, getConsiderGoneChildrenWhenMeasuring, getMeasureAllChildren, onLayout, onMeasure, setForegroundGravity, setMeasureAllChildren, shouldDelayChildPressedState
        • +
      +
        +
      • + + +

        Methods inherited from class android.view.ViewGroup

        +addChildrenForAccessibility, addFocusables, addKeyboardNavigationClusters, addStatesFromChildren, addTouchables, addView, addView, addView, addView, addView, addViewInLayout, addViewInLayout, attachLayoutAnimationParameters, attachViewToParent, bringChildToFront, canAnimate, childDrawableStateChanged, childHasTransientStateChanged, cleanupLayoutState, clearChildFocus, clearDisappearingChildren, clearFocus, debug, detachAllViewsFromParent, detachViewFromParent, detachViewFromParent, detachViewsFromParent, dispatchApplyWindowInsets, dispatchCapturedPointerEvent, dispatchConfigurationChanged, dispatchDisplayHint, dispatchDragEvent, dispatchDraw, dispatchDrawableHotspotChanged, dispatchFreezeSelfOnly, dispatchGenericFocusedEvent, dispatchGenericPointerEvent, dispatchHoverEvent, dispatchKeyEvent, dispatchKeyEventPreIme, dispatchKeyShortcutEvent, dispatchPointerCaptureChanged, dispatchProvideAutofillStructure, dispatchProvideStructure, dispatchRestoreInstanceState, dispatchSaveInstanceState, dispatchSetActivated, dispatchSetPressed, dispatchSetSelected, dispatchSystemUiVisibilityChanged, dispatchThawSelfOnly, dispatchTouchEvent, dispatchTrackballEvent, dispatchUnhandledMove, dispatchVisibilityChanged, dispatchWindowFocusChanged, dispatchWindowSystemUiVisiblityChanged, dispatchWindowVisibilityChanged, drawableStateChanged, drawChild, endViewTransition, findFocus, findViewsWithText, focusableViewAvailable, focusSearch, gatherTransparentRegion, getChildAt, getChildCount, getChildDrawingOrder, getChildMeasureSpec, getChildStaticTransformation, getChildVisibleRect, getClipChildren, getClipToPadding, getDescendantFocusability, getFocusedChild, getLayoutAnimation, getLayoutAnimationListener, getLayoutMode, getLayoutTransition, getNestedScrollAxes, getOverlay, getPersistentDrawingCache, getTouchscreenBlocksFocus, hasFocus, hasTransientState, indexOfChild, invalidateChild, invalidateChildInParent, isAlwaysDrawnWithCacheEnabled, isAnimationCacheEnabled, isChildrenDrawingOrderEnabled, isChildrenDrawnWithCacheEnabled, isMotionEventSplittingEnabled, isTransitionGroup, jumpDrawablesToCurrentState, layout, measureChild, measureChildren, measureChildWithMargins, notifySubtreeAccessibilityStateChanged, offsetDescendantRectToMyCoords, offsetRectIntoDescendantCoords, onAttachedToWindow, onCreateDrawableState, onDescendantInvalidated, onDetachedFromWindow, onInterceptHoverEvent, onInterceptTouchEvent, onNestedFling, onNestedPreFling, onNestedPrePerformAccessibilityAction, onNestedPreScroll, onNestedScroll, onNestedScrollAccepted, onRequestFocusInDescendants, onRequestSendAccessibilityEvent, onResolvePointerIcon, onStartNestedScroll, onStopNestedScroll, onViewAdded, onViewRemoved, recomputeViewAttributes, removeAllViews, removeAllViewsInLayout, removeDetachedView, removeView, removeViewAt, removeViewInLayout, removeViews, removeViewsInLayout, requestChildFocus, requestChildRectangleOnScreen, requestDisallowInterceptTouchEvent, requestFocus, requestSendAccessibilityEvent, requestTransparentRegion, restoreDefaultFocus, scheduleLayoutAnimation, setAddStatesFromChildren, setAlwaysDrawnWithCacheEnabled, setAnimationCacheEnabled, setChildrenDrawingCacheEnabled, setChildrenDrawingOrderEnabled, setChildrenDrawnWithCacheEnabled, setClipChildren, setClipToPadding, setDescendantFocusability, setLayoutAnimation, setLayoutAnimationListener, setLayoutMode, setLayoutTransition, setMotionEventSplittingEnabled, setOnHierarchyChangeListener, setPersistentDrawingCache, setStaticTransformationsEnabled, setTouchscreenBlocksFocus, setTransitionGroup, showContextMenuForChild, showContextMenuForChild, startActionModeForChild, startActionModeForChild, startLayoutAnimation, startViewTransition, updateViewLayout
        • +
      +
        +
      • + + +

        Methods inherited from class android.view.View

        +addExtraDataToAccessibilityNodeInfo, addFocusables, addOnAttachStateChangeListener, addOnLayoutChangeListener, animate, announceForAccessibility, autofill, autofill, awakenScrollBars, awakenScrollBars, awakenScrollBars, bringToFront, buildDrawingCache, buildDrawingCache, buildLayer, callOnClick, cancelDragAndDrop, cancelLongPress, cancelPendingInputEvents, canResolveLayoutDirection, canResolveTextAlignment, canResolveTextDirection, canScrollHorizontally, canScrollVertically, checkInputConnectionProxy, clearAnimation, combineMeasuredStates, computeHorizontalScrollExtent, computeHorizontalScrollOffset, computeHorizontalScrollRange, computeScroll, computeSystemWindowInsets, computeVerticalScrollExtent, computeVerticalScrollOffset, computeVerticalScrollRange, createAccessibilityNodeInfo, createContextMenu, destroyDrawingCache, dispatchFinishTemporaryDetach, dispatchGenericMotionEvent, dispatchNestedFling, dispatchNestedPreFling, dispatchNestedPrePerformAccessibilityAction, dispatchNestedPreScroll, dispatchNestedScroll, dispatchPopulateAccessibilityEvent, dispatchStartTemporaryDetach, draw, drawableHotspotChanged, findViewById, findViewWithTag, fitSystemWindows, focusSearch, forceHasOverlappingRendering, forceLayout, generateViewId, getAccessibilityLiveRegion, getAccessibilityNodeProvider, getAccessibilityTraversalAfter, getAccessibilityTraversalBefore, getAlpha, getAnimation, getApplicationWindowToken, getAutofillHints, getAutofillId, getAutofillType, getAutofillValue, getBackground, getBackgroundTintList, getBackgroundTintMode, getBaseline, getBottom, getBottomFadingEdgeStrength, getBottomPaddingOffset, getCameraDistance, getClipBounds, getClipBounds, getClipToOutline, getContentDescription, getContext, getContextMenuInfo, getDefaultFocusHighlightEnabled, getDefaultSize, getDisplay, getDrawableState, getDrawingCache, getDrawingCache, getDrawingCacheBackgroundColor, getDrawingCacheQuality, getDrawingRect, getDrawingTime, getElevation, getFilterTouchesWhenObscured, getFitsSystemWindows, getFocusable, getFocusables, getFocusedRect, getForeground, getForegroundGravity, getForegroundTintList, getForegroundTintMode, getGlobalVisibleRect, getGlobalVisibleRect, getHandler, getHasOverlappingRendering, getHeight, getHitRect, getHorizontalFadingEdgeLength, getHorizontalScrollbarHeight, getId, getImportantForAccessibility, getImportantForAutofill, getKeepScreenOn, getKeyDispatcherState, getLabelFor, getLayerType, getLayoutDirection, getLayoutParams, getLeft, getLeftFadingEdgeStrength, getLeftPaddingOffset, getLocalVisibleRect, getLocationInWindow, getLocationOnScreen, getMatrix, getMeasuredHeight, getMeasuredHeightAndState, getMeasuredState, getMeasuredWidth, getMeasuredWidthAndState, getMinimumHeight, getMinimumWidth, getNextClusterForwardId, getNextFocusDownId, getNextFocusForwardId, getNextFocusLeftId, getNextFocusRightId, getNextFocusUpId, getOnFocusChangeListener, getOutlineProvider, getOverScrollMode, getPaddingBottom, getPaddingEnd, getPaddingLeft, getPaddingRight, getPaddingStart, getPaddingTop, getParent, getParentForAccessibility, getPivotX, getPivotY, getPointerIcon, getResources, getRevealOnFocusHint, getRight, getRightFadingEdgeStrength, getRightPaddingOffset, getRootView, getRootWindowInsets, getRotation, getRotationX, getRotationY, getScaleX, getScaleY, getScrollBarDefaultDelayBeforeFade, getScrollBarFadeDuration, getScrollBarSize, getScrollBarStyle, getScrollIndicators, getScrollX, getScrollY, getSolidColor, getStateListAnimator, getSuggestedMinimumHeight, getSuggestedMinimumWidth, getSystemUiVisibility, getTag, getTag, getTextAlignment, getTextDirection, getTooltipText, getTop, getTopFadingEdgeStrength, getTopPaddingOffset, getTouchables, getTouchDelegate, getTransitionName, getTranslationX, getTranslationY, getTranslationZ, getVerticalFadingEdgeLength, getVerticalScrollbarPosition, getVerticalScrollbarWidth, getViewTreeObserver, getVisibility, getWidth, getWindowAttachCount, getWindowId, getWindowSystemUiVisibility, getWindowToken, getWindowVisibility, getWindowVisibleDisplayFrame, getX, getY, getZ, hasExplicitFocusable, hasFocusable, hasNestedScrollingParent, hasOnClickListeners, hasOverlappingRendering, hasPointerCapture, hasWindowFocus, inflate, invalidate, invalidate, invalidate, invalidateDrawable, invalidateOutline, isAccessibilityFocused, isActivated, isAttachedToWindow, isClickable, isContextClickable, isDirty, isDrawingCacheEnabled, isDuplicateParentStateEnabled, isEnabled, isFocusable, isFocusableInTouchMode, isFocused, isFocusedByDefault, isHapticFeedbackEnabled, isHardwareAccelerated, isHorizontalFadingEdgeEnabled, isHorizontalScrollBarEnabled, isHovered, isImportantForAccessibility, isImportantForAutofill, isInEditMode, isInLayout, isInTouchMode, isKeyboardNavigationCluster, isLaidOut, isLayoutDirectionResolved, isLayoutRequested, isLongClickable, isNestedScrollingEnabled, isOpaque, isPaddingOffsetRequired, isPaddingRelative, isPressed, isSaveEnabled, isSaveFromParentEnabled, isScrollbarFadingEnabled, isScrollContainer, isSelected, isShown, isSoundEffectsEnabled, isTemporarilyDetached, isTextAlignmentResolved, isTextDirectionResolved, isVerticalFadingEdgeEnabled, isVerticalScrollBarEnabled, keyboardNavigationClusterSearch, measure, mergeDrawableStates, offsetLeftAndRight, offsetTopAndBottom, onAnimationEnd, onAnimationStart, onApplyWindowInsets, onCancelPendingInputEvents, onCapturedPointerEvent, onCheckIsTextEditor, onConfigurationChanged, onCreateContextMenu, onCreateInputConnection, onDisplayHint, onDragEvent, onDraw, onDrawForeground, onDrawScrollBars, onFilterTouchEventForSecurity, onFinishInflate, onFinishTemporaryDetach, onFocusChanged, onGenericMotionEvent, onHoverChanged, onHoverEvent, onInitializeAccessibilityEvent, onInitializeAccessibilityNodeInfo, onKeyDown, onKeyLongPress, onKeyMultiple, onKeyPreIme, onKeyShortcut, onKeyUp, onOverScrolled, onPointerCaptureChange, onPopulateAccessibilityEvent, onProvideAutofillStructure, onProvideAutofillVirtualStructure, onProvideStructure, onProvideVirtualStructure, onRestoreInstanceState, onRtlPropertiesChanged, onSaveInstanceState, onScreenStateChanged, onScrollChanged, onSetAlpha, onSizeChanged, onStartTemporaryDetach, onTouchEvent, onTrackballEvent, onVisibilityAggregated, onVisibilityChanged, onWindowFocusChanged, onWindowSystemUiVisibilityChanged, onWindowVisibilityChanged, overScrollBy, performAccessibilityAction, performClick, performContextClick, performContextClick, performHapticFeedback, performHapticFeedback, performLongClick, performLongClick, playSoundEffect, post, postDelayed, postInvalidate, postInvalidate, postInvalidateDelayed, postInvalidateDelayed, postInvalidateOnAnimation, postInvalidateOnAnimation, postOnAnimation, postOnAnimationDelayed, refreshDrawableState, releasePointerCapture, removeCallbacks, removeOnAttachStateChangeListener, removeOnLayoutChangeListener, requestApplyInsets, requestFitSystemWindows, requestFocus, requestFocus, requestFocusFromTouch, requestLayout, requestPointerCapture, requestRectangleOnScreen, requestRectangleOnScreen, requestUnbufferedDispatch, resolveSize, resolveSizeAndState, restoreHierarchyState, saveHierarchyState, scheduleDrawable, scrollBy, scrollTo, sendAccessibilityEvent, sendAccessibilityEventUnchecked, setAccessibilityDelegate, setAccessibilityLiveRegion, setAccessibilityTraversalAfter, setAccessibilityTraversalBefore, setActivated, setAlpha, setAnimation, setAutofillHints, setBackground, setBackgroundColor, setBackgroundDrawable, setBackgroundResource, setBackgroundTintList, setBackgroundTintMode, setBottom, setCameraDistance, setClickable, setClipBounds, setClipToOutline, setContentDescription, setContextClickable, setDefaultFocusHighlightEnabled, setDrawingCacheBackgroundColor, setDrawingCacheEnabled, setDrawingCacheQuality, setDuplicateParentStateEnabled, setElevation, setEnabled, setFadingEdgeLength, setFilterTouchesWhenObscured, setFitsSystemWindows, setFocusable, setFocusable, setFocusableInTouchMode, setFocusedByDefault, setForeground, setForegroundTintList, setForegroundTintMode, setHapticFeedbackEnabled, setHasTransientState, setHorizontalFadingEdgeEnabled, setHorizontalScrollBarEnabled, setHovered, setId, setImportantForAccessibility, setImportantForAutofill, setKeepScreenOn, setKeyboardNavigationCluster, setLabelFor, setLayerPaint, setLayerType, setLayoutDirection, setLayoutParams, setLeft, setLongClickable, setMeasuredDimension, setMinimumHeight, setMinimumWidth, setNestedScrollingEnabled, setNextClusterForwardId, setNextFocusDownId, setNextFocusForwardId, setNextFocusLeftId, setNextFocusRightId, setNextFocusUpId, setOnApplyWindowInsetsListener, setOnCapturedPointerListener, setOnClickListener, setOnContextClickListener, setOnCreateContextMenuListener, setOnDragListener, setOnFocusChangeListener, setOnGenericMotionListener, setOnHoverListener, setOnKeyListener, setOnLongClickListener, setOnScrollChangeListener, setOnSystemUiVisibilityChangeListener, setOnTouchListener, setOutlineProvider, setOverScrollMode, setPadding, setPaddingRelative, setPivotX, setPivotY, setPointerIcon, setPressed, setRevealOnFocusHint, setRight, setRotation, setRotationX, setRotationY, setSaveEnabled, setSaveFromParentEnabled, setScaleX, setScaleY, setScrollBarDefaultDelayBeforeFade, setScrollBarFadeDuration, setScrollbarFadingEnabled, setScrollBarSize, setScrollBarStyle, setScrollContainer, setScrollIndicators, setScrollIndicators, setScrollX, setScrollY, setSelected, setSoundEffectsEnabled, setStateListAnimator, setSystemUiVisibility, setTag, setTag, setTextAlignment, setTextDirection, setTooltipText, setTop, setTouchDelegate, setTransitionName, setTranslationX, setTranslationY, setTranslationZ, setVerticalFadingEdgeEnabled, setVerticalScrollBarEnabled, setVerticalScrollbarPosition, setVisibility, setWillNotCacheDrawing, setWillNotDraw, setX, setY, setZ, showContextMenu, showContextMenu, startActionMode, startActionMode, startAnimation, startDrag, startDragAndDrop, startNestedScroll, stopNestedScroll, toString, unscheduleDrawable, unscheduleDrawable, updateDragShadow, verifyDrawable, willNotCacheDrawing, willNotDraw
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
        +
      • + + +

        Methods inherited from interface android.view.ViewParent

        +canResolveLayoutDirection, canResolveTextAlignment, canResolveTextDirection, createContextMenu, getLayoutDirection, getParent, getParentForAccessibility, getTextAlignment, getTextDirection, isLayoutDirectionResolved, isLayoutRequested, isTextAlignmentResolved, isTextDirectionResolved, keyboardNavigationClusterSearch, requestFitSystemWindows, requestLayout
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ToolbarLarge

        +
        public ToolbarLarge(@NonNull
+                    android.content.Context context)
        +
        Creates a custom view, which may be used to visualize a large toolbar on devices with a large + screen.
        +
        +
        Parameters:
        +
        context - The context, the toolbar should belong to, as an instance of the class Context. The context may not be null
        +
        +
        • +
      + + + +
        +
      • +

        ToolbarLarge

        +
        public ToolbarLarge(@NonNull
+                    android.content.Context context,
+                    @Nullable
+                    android.util.AttributeSet attributeSet)
        +
        Creates a custom view, which may be used to visualize a large toolbar on devices with a large + screen.
        +
        +
        Parameters:
        +
        context - The context, the toolbar should belong to, as an instance of the class Context. The context may not be null
        +
        attributeSet - The attributes of the XML tag that is inflating the preference, as an instance of the + type AttributeSet or ull, if no attributes are available
        +
        +
        • +
      + + + +
        +
      • +

        ToolbarLarge

        +
        public ToolbarLarge(@NonNull
+                    android.content.Context context,
+                    @Nullable
+                    android.util.AttributeSet attributeSet,
+                    int defaultStyle)
        +
        Creates a custom view, which may be used to visualize a large toolbar on devices with a large + screen.
        +
        +
        Parameters:
        +
        context - The context, the toolbar should belong to, as an instance of the class Context. The context may not be null
        +
        attributeSet - The attributes of the XML tag that is inflating the preference, as an instance of the + type AttributeSet or null, if no attributes are available
        +
        defaultStyle - The default style to apply to this preference. If 0, no style will be applied (beyond + what is included in the theme). This may either be an attribute resource, whose value + will be retrieved from the current theme, or an explicit style resource
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getTitle

        +
        public final java.lang.CharSequence getTitle()
        +
        Returns the toolbar's title.
        +
        +
        Returns:
        +
        The toolbar's title as an instance of the class CharSequence or null, if no + title is set
        +
        +
        • +
      + + + +
        +
      • +

        setTitle

        +
        public final void setTitle(@Nullable
+                           java.lang.CharSequence title)
        +
        Sets the toolbar's title.
        +
        +
        Parameters:
        +
        title - The title, which should be set, as an instance of the class CharSequence or + null, if no title should be set
        +
        +
        • +
      + + + +
        +
      • +

        setTitle

        +
        public final void setTitle(@StringRes
+                           int resourceId)
        +
        Sets the toolbar's title.
        +
        +
        Parameters:
        +
        resourceId - The resource id of the title, which should be set, as an Integer value. The + resource id must correspond to a valid string resource
        +
        +
        • +
      + + + +
        +
      • +

        getNavigationWidth

        +
        @Px
+public final int getNavigationWidth()
        +
        Returns the width of the navigation.
        +
        +
        Returns:
        +
        The width of the navigation in pixels as an Integer value
        +
        +
        • +
      + + + +
        +
      • +

        setNavigationWidth

        +
        public final void setNavigationWidth(@Px
+                                     int width)
        +
        Sets the width of the navigation.
        +
        +
        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 hidden, or not.
        +
        +
        Returns:
        +
        True, if the navigation is hidden, false otherwise
        +
        +
        • +
      + + + +
        +
      • +

        hideNavigation

        +
        public final void hideNavigation(boolean navigationHidden)
        +
        Hides or shows the navigation.
        +
        +
        Parameters:
        +
        navigationHidden - True, if the navigation should be hidden, false otherwise
        +
        +
        • +
      + + + +
        +
      • +

        getToolbar

        +
        public final android.support.v7.widget.Toolbar getToolbar()
        +
        Returns the toolbar, which is used to show the title.
        +
        +
        Returns:
        +
        The toolbar, which is used to show the title, as an instance of the class Toolbar
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/doc/javadoc/de/mrapp/android/preference/activity/view/package-frame.html b/doc/javadoc/de/mrapp/android/preference/activity/view/package-frame.html new file mode 100644 index 0000000..abec66a --- /dev/null +++ b/doc/javadoc/de/mrapp/android/preference/activity/view/package-frame.html @@ -0,0 +1,20 @@ + + + + + +de.mrapp.android.preference.activity.view + + + + + +

de.mrapp.android.preference.activity.view

+
+

Classes

+ +
+ + diff --git a/doc/javadoc/de/mrapp/android/preference/activity/view/package-summary.html b/doc/javadoc/de/mrapp/android/preference/activity/view/package-summary.html new file mode 100644 index 0000000..a3797cd --- /dev/null +++ b/doc/javadoc/de/mrapp/android/preference/activity/view/package-summary.html @@ -0,0 +1,142 @@ + + + + + +de.mrapp.android.preference.activity.view + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package de.mrapp.android.preference.activity.view

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/javadoc/de/mrapp/android/preference/activity/view/package-tree.html b/doc/javadoc/de/mrapp/android/preference/activity/view/package-tree.html new file mode 100644 index 0000000..04f67bc --- /dev/null +++ b/doc/javadoc/de/mrapp/android/preference/activity/view/package-tree.html @@ -0,0 +1,147 @@ + + + + + +de.mrapp.android.preference.activity.view Class Hierarchy + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package de.mrapp.android.preference.activity.view

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/javadoc/deprecated-list.html b/doc/javadoc/deprecated-list.html new file mode 100644 index 0000000..1c62a0d --- /dev/null +++ b/doc/javadoc/deprecated-list.html @@ -0,0 +1,122 @@ + + + + + +Deprecated List + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Deprecated API

+

Contents

+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/javadoc/help-doc.html b/doc/javadoc/help-doc.html new file mode 100644 index 0000000..d549da0 --- /dev/null +++ b/doc/javadoc/help-doc.html @@ -0,0 +1,223 @@ + + + + + +API Help + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

How This API Document Is Organized

+
This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.
+
+
+ +This help file applies to API documentation generated using the standard doclet.
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/javadoc/index-files/index-1.html b/doc/javadoc/index-files/index-1.html new file mode 100644 index 0000000..7cb153a --- /dev/null +++ b/doc/javadoc/index-files/index-1.html @@ -0,0 +1,156 @@ + + + + + +A-Index + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
A C D E G H I N O P R S T U V W  + + +

A

+
+
AbstractPreferenceFragment - Class in de.mrapp.android.preference.activity.fragment
+
+
An abstract base class for all fragments, which show multiple preferences.
+
+
AbstractPreferenceFragment() - Constructor for class de.mrapp.android.preference.activity.fragment.AbstractPreferenceFragment
+
 
+
addListener(HideViewOnScrollAnimationListener) - Method in class de.mrapp.android.preference.activity.animation.HideViewOnScrollAnimation
+
+
Adds a new listener, which should be notified about the animation's internal state, to the + animation.
+
+
addNavigationListener(NavigationListener) - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
+
Adds a new listener, which should be notified, when a navigation preference has been added or + removed to/from the activity.
+
+
addPreferenceFragmentListener(PreferenceFragmentListener) - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
+
Adds a new listener, which should be notified, when the currently shown preference fragment + has been changed, to the activity.
+
+
addRestoreDefaultsListener(RestoreDefaultsListener) - Method in class de.mrapp.android.preference.activity.PreferenceFragment
+
+
Adds a new listener, which should be notified, when the preferences' default values should be + restored, to the fragment.
+
+
addWizardListener(WizardListener) - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
+
Adds a new listener, which should be notified, when the user navigates within the activity, + if it is used as a wizard.
+
+
+A C D E G H I N O P R S T U V W 
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/javadoc/index-files/index-10.html b/doc/javadoc/index-files/index-10.html new file mode 100644 index 0000000..3f22161 --- /dev/null +++ b/doc/javadoc/index-files/index-10.html @@ -0,0 +1,157 @@ + + + + + +P-Index + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
A C D E G H I N O P R S T U V W  + + +

P

+
+
performClick() - Method in class de.mrapp.android.preference.activity.NavigationPreference
+
+
Performs a click on the preference.
+
+
PreferenceActivity - Class in de.mrapp.android.preference.activity
+
+
An activity, which provides a navigation for accessing preferences, which are grouped as + different sections.
+
+
PreferenceActivity() - Constructor for class de.mrapp.android.preference.activity.PreferenceActivity
+
 
+
PreferenceAdapter - Class in de.mrapp.android.preference.activity.adapter
+
+
A recycler view adapter, which extends the class PreferenceGroupAdapter in order to modify the + appearance of preferences.
+
+
PreferenceAdapter(PreferenceScreen) - Constructor for class de.mrapp.android.preference.activity.adapter.PreferenceAdapter
+
+
Creates a new recycler view adapter, which extends the class PreferenceGroupAdapter in order + to modify the appearance of preferences.
+
+
PreferenceFragment - Class in de.mrapp.android.preference.activity
+
+
A fragment, which allows to show multiple preferences.
+
+
PreferenceFragment() - Constructor for class de.mrapp.android.preference.activity.PreferenceFragment
+
 
+
PreferenceFragmentListener - Interface in de.mrapp.android.preference.activity
+
+
Defines the interface, a class, which should be notified when the currently shown preference + fragment of a PreferenceActivity has been changed, must implement.
+
+
+A C D E G H I N O P R S T U V W 
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/javadoc/index-files/index-11.html b/doc/javadoc/index-files/index-11.html new file mode 100644 index 0000000..1a2e849 --- /dev/null +++ b/doc/javadoc/index-files/index-11.html @@ -0,0 +1,159 @@ + + + + + +R-Index + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
A C D E G H I N O P R S T U V W  + + +

R

+
+
removeListener(HideViewOnScrollAnimationListener) - Method in class de.mrapp.android.preference.activity.animation.HideViewOnScrollAnimation
+
+
Removes a specific listener, which should not be notified about the animation's internal + state, from the animation.
+
+
removeNavigationListener(NavigationListener) - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
+
Removes a specific listener, which should not be notified, when a navigation preference has + been added or removed to/from the activity, anymore.
+
+
removePreferenceFragmentListener(PreferenceFragmentListener) - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
+
Removes a specific listener, which should not be notified, when the currently shown + preference fragment has been changed, anymore.
+
+
removeRestoreDefaultsListener(RestoreDefaultsListener) - Method in class de.mrapp.android.preference.activity.PreferenceFragment
+
+
Removes a specific listener, which should not be notified anymore, when the preferences' + default values should be restored, from the fragment.
+
+
removeWizardListener(WizardListener) - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
+
Removes a specific listener, which should not be notified, when the user navigates within the + activity, if it is used as a wizard.
+
+
restoreDefaults() - Method in class de.mrapp.android.preference.activity.PreferenceFragment
+
+
Restores the default values of all preferences, which are contained by the fragment.
+
+
RestoreDefaultsListener - Interface in de.mrapp.android.preference.activity
+
+
Defines the interface, a class, which should be notified, when the default values of the + preferences, which belong to a PreferenceFragment, should be restored.
+
+
+A C D E G H I N O P R S T U V W 
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/javadoc/index-files/index-12.html b/doc/javadoc/index-files/index-12.html new file mode 100644 index 0000000..d9192a8 --- /dev/null +++ b/doc/javadoc/index-files/index-12.html @@ -0,0 +1,379 @@ + + + + + +S-Index + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
A C D E G H I N O P R S T U V W  + + +

S

+
+
selectNavigationPreference(NavigationPreference, Bundle) - Method in class de.mrapp.android.preference.activity.adapter.NavigationPreferenceAdapter
+
+
Selects a specific navigation preference.
+
+
selectNavigationPreference(int, Bundle) - Method in class de.mrapp.android.preference.activity.adapter.NavigationPreferenceAdapter
+
+
Selects a specific navigation preference.
+
+
selectNavigationPreference(int, Bundle) - Method in class de.mrapp.android.preference.activity.fragment.NavigationFragment
+
+
Selects a specific navigation preference.
+
+
selectNavigationPreference(NavigationPreference) - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
+
Selects a specific navigation preference.
+
+
selectNavigationPreference(NavigationPreference, Bundle) - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
+
Selects a specific navigation preference.
+
+
setAdapterCallback(NavigationPreferenceAdapter.Callback) - Method in class de.mrapp.android.preference.activity.fragment.NavigationFragment
+
+
Sets the callback, which should be notified about the events of the adapter, which contains + the navigation preferences.
+
+
setBackButtonText(int) - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
+
Sets the text of the back button, which is shown, when the activity is used as a wizard.
+
+
setBackButtonText(CharSequence) - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
+
Sets the text of the back button, which is shown, when the activity is used as a wizard.
+
+
setBreadCrumbBackgroundColor(int) - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
+
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.
+
+
setBreadCrumbElevation(int) - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
+
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.
+
+
setBreadCrumbTitle(int) - Method in class de.mrapp.android.preference.activity.NavigationPreference
+
+
Sets the breadcrumb title, which should be shown, when showing the fragment, which is + associated with the preference.
+
+
setBreadCrumbTitle(CharSequence) - Method in class de.mrapp.android.preference.activity.NavigationPreference
+
+
Sets the breadcrumb title, which should be shown, when showing the fragment, which is + associated with the preference.
+
+
setButtonBarBackground(int) - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
+
Sets the background of the button bar, which is shown, when the activity is used as a + wizard.
+
+
setButtonBarBackground(Drawable) - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
+
Sets the background of the button bar, which is shown, when the activity is used as a + wizard.
+
+
setButtonBarBackground(int) - Method in class de.mrapp.android.preference.activity.PreferenceFragment
+
+
Sets the background of the view group, which contains the button, which allows to restore the + preferences' default values.
+
+
setButtonBarBackground(Drawable) - Method in class de.mrapp.android.preference.activity.PreferenceFragment
+
+
Sets the background of the view group, which contains the button, which allows to restore the + preferences' default values.
+
+
setButtonBarBackgroundColor(int) - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
+
Sets the background of the button bar, which is shown, when the activity is used as a + wizard.
+
+
setButtonBarBackgroundColor(int) - Method in class de.mrapp.android.preference.activity.PreferenceFragment
+
+
Sets the background color of the view group, which contains the button, which allows to + restore the preferences' default values.
+
+
setButtonBarElevation(int) - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
+
Sets the elevation of the button bar, which is shown when using the activity as a wizard.
+
+
setButtonBarElevation(int) - Method in class de.mrapp.android.preference.activity.PreferenceFragment
+
+
Sets the elevation of the view group, which contains the button, which allows to restore the + preferences' default values.
+
+
setCallback(NavigationFragment.Callback) - Method in class de.mrapp.android.preference.activity.fragment.NavigationFragment
+
+
Sets the callback, which should be notified about the fragment's events.
+
+
setCallback(NavigationPreference.Callback) - Method in class de.mrapp.android.preference.activity.NavigationPreference
+
+
Sets the callback, which should be notified, when the fragment, which is associated with the + preference, should be shown.
+
+
setCardViewBackgroundColor(int) - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
+
Sets the background color of the card view, which contains the currently shown preference + fragment, when using the split screen layout.
+
+
setCardViewElevation(int) - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
+
Sets the elevation of the card view, which contains the currently shown prefernce fragment, + when using the split screen layout.
+
+
setDividerColor(int) - Method in class de.mrapp.android.preference.activity.fragment.AbstractPreferenceFragment
+
+
Sets the color of the dividers, which are shown above preference categories.
+
+
setEnabled(boolean) - Method in class de.mrapp.android.preference.activity.adapter.NavigationPreferenceAdapter
+
+
Sets, whether the items of the adapter are enabled, i.e.
+
+
setEnabled(boolean) - Method in class de.mrapp.android.preference.activity.fragment.NavigationFragment
+
+
Sets, whether the navigation should be enabled, i.e.
+
+
setExtras(Bundle) - Method in class de.mrapp.android.preference.activity.NavigationPreference
+
+
Sets the argument, which should be passed to the fragment, which is associated with the + preference.
+
+
setFinishButtonText(int) - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
+
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.
+
+
setFinishButtonText(CharSequence) - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
+
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.
+
+
setFragment(String) - Method in class de.mrapp.android.preference.activity.NavigationPreference
+
+
Sets the fully classified class name of the fragment, which should be associated with the + preference.
+
+
setIcon(Drawable) - Method in class de.mrapp.android.preference.activity.NavigationPreference
+
 
+
setIconTint(int) - Method in class de.mrapp.android.preference.activity.NavigationPreference
+
+
Sets the color, which should be used to tint the preference's icon.
+
+
setIconTintList(ColorStateList) - Method in class de.mrapp.android.preference.activity.NavigationPreference
+
+
Sets the color state list, which should be used to tint the preference's icon.
+
+
setIconTintMode(PorterDuff.Mode) - Method in class de.mrapp.android.preference.activity.NavigationPreference
+
+
Sets the mode, which should be used to tint the preference's icon.
+
+
setNavigationBackground(int) - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
+
Sets the background of the navigation.
+
+
setNavigationBackground(Drawable) - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
+
Sets the background of the navigation.
+
+
setNavigationBackgroundColor(int) - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
+
Sets the background color of the navigation.
+
+
setNavigationDividerColor(int) - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
+
Sets the color of the dividers, which are contained by the navigation.
+
+
setNavigationSelectionColor(int) - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
+
Sets the background color of the currently selected navigation preference.
+
+
setNavigationWidth(int) - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
+
Sets the width of the navigation, when using the split screen layout.
+
+
setNavigationWidth(int) - Method in class de.mrapp.android.preference.activity.view.ToolbarLarge
+
+
Sets the width of the navigation.
+
+
setNextButtonText(int) - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
+
Sets the text of the next button, which is shown, when the activity is used as a wizard.
+
+
setNextButtonText(CharSequence) - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
+
Sets the text of the next button, which is shown, when the activity is used as a wizard.
+
+
setOnPreferenceClickListener(Preference.OnPreferenceClickListener) - Method in class de.mrapp.android.preference.activity.NavigationPreference
+
 
+
setProgressFormat(int) - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
+
Sets the string, which should be used to format the progress, which is shown, when the + activity is used as a wizard.
+
+
setProgressFormat(String) - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
+
Sets the string, which should be used to format the progress, which is shown, when the + activity is used as a wizard.
+
+
setRestoreDefaultsButtonText(int) - Method in class de.mrapp.android.preference.activity.PreferenceFragment
+
+
Sets the text of the button, which allows to restore the preferences' default values.
+
+
setRestoreDefaultsButtonText(CharSequence) - Method in class de.mrapp.android.preference.activity.PreferenceFragment
+
+
Sets the text of the button, which allows to restore the preferences' default values.
+
+
setSelectionColor(int) - Method in class de.mrapp.android.preference.activity.adapter.NavigationPreferenceAdapter
+
+
Sets the background color of the currently selected navigation preference.
+
+
setSelectionColor(int) - Method in class de.mrapp.android.preference.activity.fragment.NavigationFragment
+
+
Sets the background color of the currently selected navigation preference.
+
+
setTitle(int) - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
 
+
setTitle(CharSequence) - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
 
+
setTitle(CharSequence) - Method in class de.mrapp.android.preference.activity.view.ToolbarLarge
+
+
Sets the toolbar's title.
+
+
setTitle(int) - Method in class de.mrapp.android.preference.activity.view.ToolbarLarge
+
+
Sets the toolbar's title.
+
+
setToolbarElevation(int) - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
+
Sets the elevation of the activity's toolbar.
+
+
showButtonBar(boolean) - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
+
Shows or hides the view group, which contains the buttons, which are shown when the activity + is used as a wizard.
+
+
showProgress(boolean) - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
+
Sets, whether the progress should be shown, when the activity is used as a wizard.
+
+
showRestoreDefaultsButton(boolean) - Method in class de.mrapp.android.preference.activity.PreferenceFragment
+
+
Shows or hides the button, which allows to restore the preferences' default values.
+
+
showView() - Method in class de.mrapp.android.preference.activity.animation.HideViewOnScrollAnimation
+
+
Shows the view.
+
+
+A C D E G H I N O P R S T U V W 
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/javadoc/index-files/index-13.html b/doc/javadoc/index-files/index-13.html new file mode 100644 index 0000000..9488355 --- /dev/null +++ b/doc/javadoc/index-files/index-13.html @@ -0,0 +1,144 @@ + + + + + +T-Index + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
A C D E G H I N O P R S T U V W  + + +

T

+
+
ToolbarLarge - Class in de.mrapp.android.preference.activity.view
+
+
A custom view, which may be used to visualize a large toolbar on devices with a large screen.
+
+
ToolbarLarge(Context) - Constructor for class de.mrapp.android.preference.activity.view.ToolbarLarge
+
+
Creates a custom view, which may be used to visualize a large toolbar on devices with a large + screen.
+
+
ToolbarLarge(Context, AttributeSet) - Constructor for class de.mrapp.android.preference.activity.view.ToolbarLarge
+
+
Creates a custom view, which may be used to visualize a large toolbar on devices with a large + screen.
+
+
ToolbarLarge(Context, AttributeSet, int) - Constructor for class de.mrapp.android.preference.activity.view.ToolbarLarge
+
+
Creates a custom view, which may be used to visualize a large toolbar on devices with a large + screen.
+
+
+A C D E G H I N O P R S T U V W 
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/javadoc/index-files/index-14.html b/doc/javadoc/index-files/index-14.html new file mode 100644 index 0000000..5ea39ad --- /dev/null +++ b/doc/javadoc/index-files/index-14.html @@ -0,0 +1,134 @@ + + + + + +U-Index + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
A C D E G H I N O P R S T U V W  + + +

U

+
+
unselectNavigationPreference() - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
+
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.
+
+
useSplitScreen(boolean) - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
+
Sets, whether the split screen layout should be used on tablets, or not.
+
+
+A C D E G H I N O P R S T U V W 
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/javadoc/index-files/index-15.html b/doc/javadoc/index-files/index-15.html new file mode 100644 index 0000000..9891241 --- /dev/null +++ b/doc/javadoc/index-files/index-15.html @@ -0,0 +1,134 @@ + + + + + +V-Index + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
A C D E G H I N O P R S T U V W  + + +

V

+
+
valueOf(String) - Static method in enum de.mrapp.android.preference.activity.animation.HideViewOnScrollAnimation.Direction
+
+
Returns the enum constant of this type with the specified name.
+
+
values() - Static method in enum de.mrapp.android.preference.activity.animation.HideViewOnScrollAnimation.Direction
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
+A C D E G H I N O P R S T U V W 
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/javadoc/index-files/index-16.html b/doc/javadoc/index-files/index-16.html new file mode 100644 index 0000000..a4d7824 --- /dev/null +++ b/doc/javadoc/index-files/index-16.html @@ -0,0 +1,131 @@ + + + + + +W-Index + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
A C D E G H I N O P R S T U V W  + + +

W

+
+
WizardListener - Interface in de.mrapp.android.preference.activity
+
+
Defines the interface a class, which should be notified when the user navigates within a PreferenceActivity, which is used as wizard, by using its next-, back- and finish-button.
+
+
writeToParcel(Parcel, int) - Method in class de.mrapp.android.preference.activity.NavigationPreference.SavedState
+
 
+
+A C D E G H I N O P R S T U V W 
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/javadoc/index-files/index-2.html b/doc/javadoc/index-files/index-2.html new file mode 100644 index 0000000..e806c08 --- /dev/null +++ b/doc/javadoc/index-files/index-2.html @@ -0,0 +1,130 @@ + + + + + +C-Index + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
A C D E G H I N O P R S T U V W  + + +

C

+
+
CREATOR - Static variable in class de.mrapp.android.preference.activity.NavigationPreference.SavedState
+
+
A creator, which allows to create instances of the class NavigationPreference.SavedState from + parcels.
+
+
+A C D E G H I N O P R S T U V W 
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/javadoc/index-files/index-3.html b/doc/javadoc/index-files/index-3.html new file mode 100644 index 0000000..7027b1c --- /dev/null +++ b/doc/javadoc/index-files/index-3.html @@ -0,0 +1,135 @@ + + + + + +D-Index + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
A C D E G H I N O P R S T U V W  + + +

D

+
+
de.mrapp.android.preference.activity - package de.mrapp.android.preference.activity
+
 
+
de.mrapp.android.preference.activity.adapter - package de.mrapp.android.preference.activity.adapter
+
 
+
de.mrapp.android.preference.activity.animation - package de.mrapp.android.preference.activity.animation
+
 
+
de.mrapp.android.preference.activity.fragment - package de.mrapp.android.preference.activity.fragment
+
 
+
de.mrapp.android.preference.activity.view - package de.mrapp.android.preference.activity.view
+
 
+
+A C D E G H I N O P R S T U V W 
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/javadoc/index-files/index-4.html b/doc/javadoc/index-files/index-4.html new file mode 100644 index 0000000..29ebbf5 --- /dev/null +++ b/doc/javadoc/index-files/index-4.html @@ -0,0 +1,196 @@ + + + + + +E-Index + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
A C D E G H I N O P R S T U V W  + + +

E

+
+
EXTRA_BACK_BUTTON_TEXT - Static variable in class de.mrapp.android.preference.activity.PreferenceActivity
+
+
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.
+
+
EXTRA_FINISH_BUTTON_TEXT - Static variable in class de.mrapp.android.preference.activity.PreferenceActivity
+
+
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.
+
+
EXTRA_HIDE_NAVIGATION - Static variable in class de.mrapp.android.preference.activity.PreferenceActivity
+
+
When starting this activity, the invoking intent can contain this extra boolean to specify + that the navigation should not be displayed.
+
+
EXTRA_NEXT_BUTTON_TEXT - Static variable in class de.mrapp.android.preference.activity.PreferenceActivity
+
+
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.
+
+
EXTRA_NO_BREAD_CRUMBS - Static variable in class de.mrapp.android.preference.activity.PreferenceActivity
+
+
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.
+
+
EXTRA_PROGRESS_FORMAT - Static variable in class de.mrapp.android.preference.activity.PreferenceActivity
+
+
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.
+
+
EXTRA_RESTORE_DEFAULTS_BUTTON_TEXT - Static variable in class de.mrapp.android.preference.activity.PreferenceFragment
+
+
When attaching this fragment to an activity and using EXTRA_SHOW_RESTORE_DEFAULTS_BUTTON, + this extra can also be specified to supply a custom text for the button, which allows to + restore the preferences' default values.
+
+
EXTRA_SHOW_BUTTON_BAR - Static variable in class de.mrapp.android.preference.activity.PreferenceActivity
+
+
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.
+
+
EXTRA_SHOW_FRAGMENT - Static variable in class de.mrapp.android.preference.activity.PreferenceActivity
+
+
When starting this activity, the invoking intent can contain this extra string to specify + which fragment should be initially displayed.
+
+
EXTRA_SHOW_FRAGMENT_ARGUMENTS - Static variable in class de.mrapp.android.preference.activity.PreferenceActivity
+
+
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.
+
+
EXTRA_SHOW_FRAGMENT_TITLE - Static variable in class de.mrapp.android.preference.activity.PreferenceActivity
+
+
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.
+
+
EXTRA_SHOW_PROGRESS - Static variable in class de.mrapp.android.preference.activity.PreferenceActivity
+
+
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.
+
+
EXTRA_SHOW_RESTORE_DEFAULTS_BUTTON - Static variable in class de.mrapp.android.preference.activity.PreferenceFragment
+
+
When attaching this fragment to an activity, the passed bundle can contain this extra boolean + to display the button, which allows to restore the preferences' default values.
+
+
+A C D E G H I N O P R S T U V W 
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/javadoc/index-files/index-5.html b/doc/javadoc/index-files/index-5.html new file mode 100644 index 0000000..559ec62 --- /dev/null +++ b/doc/javadoc/index-files/index-5.html @@ -0,0 +1,377 @@ + + + + + +G-Index + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
A C D E G H I N O P R S T U V W  + + +

G

+
+
getAllNavigationPreferences() - Method in class de.mrapp.android.preference.activity.adapter.NavigationPreferenceAdapter
+
+
Returns a list, which contains all navigation preferences, which are contained by the + adapter.
+
+
getAllNavigationPreferences() - Method in class de.mrapp.android.preference.activity.fragment.NavigationFragment
+
+
Returns a list, which contains all navigation preferences, which are contained by the + navigation.
+
+
getAllNavigationPreferences() - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
+
Returns a list, which contains all navigation preferences, which are contained by the + activity.
+
+
getAnimationDuration() - Method in class de.mrapp.android.preference.activity.animation.HideViewOnScrollAnimation
+
+
Returns the duration of the animation, which is used to show or hide the view.
+
+
getBackButton() - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
+
Returns the back button, which is shown when the activity is used as a wizard and the first + navigation preference is not selected.
+
+
getBackButtonText() - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
+
Returns the text of the back button, which is shown, when the activity is used as a wizard.
+
+
getBreadCrumbBackgroundColor() - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
+
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.
+
+
getBreadCrumbElevation() - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
+
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.
+
+
getBreadCrumbTitle() - Method in class de.mrapp.android.preference.activity.NavigationPreference
+
+
Returns the breadcrumb title, which is shown, when showing the fragment, which is associated + with the preference.
+
+
getBreadCrumbToolbar() - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
+
Returns the toolbar, which is used to show the bread crumb of the currently selected + navigation preference, when using the split screen layout.
+
+
getButtonBar() - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
+
Returns the button bar, which is shown when the activity is used as a wizard.
+
+
getButtonBar() - Method in class de.mrapp.android.preference.activity.PreferenceFragment
+
+
Returns the view group, which contains the button, which allows to restore the preferences' + default values.
+
+
getButtonBarBackground() - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
+
Returns the background of the button bar, which is shown, when the activity is used as a + wizard.
+
+
getButtonBarBackground() - Method in class de.mrapp.android.preference.activity.PreferenceFragment
+
+
Returns the background of the view group, which contains the button, which allows to restore + the preferences' default values.
+
+
getButtonBarElevation() - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
+
Returns the elevation of the button bar, which is shown when using the activity as a wizard.
+
+
getButtonBarElevation() - Method in class de.mrapp.android.preference.activity.PreferenceFragment
+
+
Returns the elevation of the view group, which contains the button, which allows to restore + the preferences' default values.
+
+
getCallback() - Method in class de.mrapp.android.preference.activity.fragment.NavigationFragment
+
+
Returns the callback, which is notified about the fragment's events.
+
+
getCardView() - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
+
Returns the card view, which contains the currently shown preference fragment, when using the + split screen layout.
+
+
getCardViewBackgroundColor() - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
+
Returns the background color of the card view, which contains the currently shown preference + fragment, when using the split screen layout.
+
+
getCardViewElevation() - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
+
Returns the elevation of the card view, which contains the currently shown preference + fragment, when using the split screen layout.
+
+
getDirection() - Method in class de.mrapp.android.preference.activity.animation.HideViewOnScrollAnimation
+
+
Returns the direction, which should be be used to translate the view in order to hide it.
+
+
getDividerColor() - Method in class de.mrapp.android.preference.activity.fragment.AbstractPreferenceFragment
+
+
Returns the color of the dividers, which are shown above preference categories.
+
+
getExtras() - Method in class de.mrapp.android.preference.activity.NavigationPreference
+
+
Returns the arguments, which are passed to the fragment, which is associated with the + preference.
+
+
getFinishButton() - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
+
Returns the finish button, which is shown when the activity is used as a wizard and the last + navigation preference is selected.
+
+
getFinishButtonText() - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
+
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.
+
+
getFragment() - Method in class de.mrapp.android.preference.activity.NavigationPreference
+
+
Returns the fully classified class name of the fragment, which is associated with the + preference.
+
+
getFrameLayout() - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
+
Returns the frame layout, which contains the activity's views.
+
+
getFrameLayout() - Method in class de.mrapp.android.preference.activity.PreferenceFragment
+
+
Returns the frame layout, which contains the fragment's views.
+
+
getIconTintList() - Method in class de.mrapp.android.preference.activity.NavigationPreference
+
+
Returns the color state list, which is used to tint the preference's icon.
+
+
getIconTintMode() - Method in class de.mrapp.android.preference.activity.NavigationPreference
+
+
Returns the mode, which is used to tint the preference's icon.
+
+
getNavigationBackground() - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
+
Returns the background of the navigation.
+
+
getNavigationDividerColor() - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
+
Returns the color of the dividers, which are contained by the navigation.
+
+
getNavigationFragment() - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
+
Returns the preference fragment, which contains the activity's navigation.
+
+
getNavigationPreference(int) - Method in class de.mrapp.android.preference.activity.adapter.NavigationPreferenceAdapter
+
+
Returns the navigation preference, which corresponds to a specific index.
+
+
getNavigationPreference(int) - Method in class de.mrapp.android.preference.activity.fragment.NavigationFragment
+
+
Returns the navigation preference, which corresponds to a specific index.
+
+
getNavigationPreferenceCount() - Method in class de.mrapp.android.preference.activity.adapter.NavigationPreferenceAdapter
+
+
Returns the number of navigation preferences, which are contained by the adapter.
+
+
getNavigationPreferenceCount() - Method in class de.mrapp.android.preference.activity.fragment.NavigationFragment
+
+
Returns the number of navigation preferences, which are contained by the navigation.
+
+
getNavigationPreferenceCount() - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
+
Returns the number of navigation preferences, which are contained by the activity.
+
+
getNavigationSelectionColor() - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
+
Returns the background color of the currently selected navigation preference.
+
+
getNavigationToolbar() - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
+
Returns the toolbar, which is used to show the activity's title, when using the split screen + layout.
+
+
getNavigationWidth() - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
+
Returns the width of the navigation, when using the split screen layout.
+
+
getNavigationWidth() - Method in class de.mrapp.android.preference.activity.view.ToolbarLarge
+
+
Returns the width of the navigation.
+
+
getNextButton() - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
+
Returns the next button, which is shown when the activity is used as a wizard and the last + navigation preference is not selected.
+
+
getNextButtonText() - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
+
Returns the text of the next button, which is shown, when the activity is used as a wizard.
+
+
getPreferenceFragment() - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
+
Returns the currently shown preference fragment.
+
+
getProgressFormat() - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
+
Returns the string, which is used to format the progress, which is shown, when the activity + is used as a wizard.
+
+
getRestoreDefaultsButton() - Method in class de.mrapp.android.preference.activity.PreferenceFragment
+
+
Returns the button, which allows to restore the preferences' default values.
+
+
getRestoreDefaultsButtonText() - Method in class de.mrapp.android.preference.activity.PreferenceFragment
+
+
Returns the text of the button, which allows to restore the preferences' default values.
+
+
getSelectedNavigationPreference() - Method in class de.mrapp.android.preference.activity.adapter.NavigationPreferenceAdapter
+
+
Returns the currently selected navigation preference.
+
+
getSelectedNavigationPreference() - Method in class de.mrapp.android.preference.activity.fragment.NavigationFragment
+
+
Returns the currently selected navigation preference.
+
+
getSelectedNavigationPreference() - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
+
Returns the currently selected navigation preference.
+
+
getSelectedNavigationPreferenceIndex() - Method in class de.mrapp.android.preference.activity.adapter.NavigationPreferenceAdapter
+
+
Returns the index of the navigation preference, which is currently selected, among all + navigation preferences.
+
+
getSelectedNavigationPreferenceIndex() - Method in class de.mrapp.android.preference.activity.fragment.NavigationFragment
+
+
Returns the index of the navigation preference, which is currently selected, among all + navigation preferences.
+
+
getTitle() - Method in class de.mrapp.android.preference.activity.view.ToolbarLarge
+
+
Returns the toolbar's title.
+
+
getToolbar() - Method in class de.mrapp.android.preference.activity.view.ToolbarLarge
+
+
Returns the toolbar, which is used to show the title.
+
+
getToolbarElevation() - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
+
Returns the elevation of the activity's toolbar.
+
+
getView() - Method in class de.mrapp.android.preference.activity.animation.HideViewOnScrollAnimation
+
+
Returns the view, which is animated by the listener.
+
+
+A C D E G H I N O P R S T U V W 
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/javadoc/index-files/index-6.html b/doc/javadoc/index-files/index-6.html new file mode 100644 index 0000000..dca9858 --- /dev/null +++ b/doc/javadoc/index-files/index-6.html @@ -0,0 +1,166 @@ + + + + + +H-Index + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
A C D E G H I N O P R S T U V W  + + +

H

+
+
hideBreadCrumb(boolean) - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
+
Sets, whether the toolbar, which is used to show the bread crumb of the currently selected + navigation preference, should be hidden, or not.
+
+
hideNavigation(boolean) - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
+
Hides or shows the navigation.
+
+
hideNavigation(boolean) - Method in class de.mrapp.android.preference.activity.view.ToolbarLarge
+
+
Hides or shows the navigation.
+
+
hideView() - Method in class de.mrapp.android.preference.activity.animation.HideViewOnScrollAnimation
+
+
Hides the view.
+
+
HideViewOnScrollAnimation - Class in de.mrapp.android.preference.activity.animation
+
+
A scroll listener, which allows to animate a view to become hidden or shown depending on the + observed list view's scrolling direction.
+
+
HideViewOnScrollAnimation(View, HideViewOnScrollAnimation.Direction) - Constructor for class de.mrapp.android.preference.activity.animation.HideViewOnScrollAnimation
+
+
Creates a new scroll listener, which allows to animate a view to become hidden or shown + depending on the observed list view's scrolling direction.
+
+
HideViewOnScrollAnimation(View, HideViewOnScrollAnimation.Direction, long) - Constructor for class de.mrapp.android.preference.activity.animation.HideViewOnScrollAnimation
+
+
Creates a new scroll listener, which allows to animate a view to become hidden or shown + depending on the observed list view's scrolling direction.
+
+
HideViewOnScrollAnimation.Direction - Enum in de.mrapp.android.preference.activity.animation
+
+
Contains all possible directions, which can be used to translate the animated view in order + hide it.
+
+
HideViewOnScrollAnimationListener - Interface in de.mrapp.android.preference.activity.animation
+
+
Defines the interface, a class, which should be notified about the internal state of a HideViewOnScrollAnimation, must implement.
+
+
+A C D E G H I N O P R S T U V W 
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/javadoc/index-files/index-7.html b/doc/javadoc/index-files/index-7.html new file mode 100644 index 0000000..1e94e1b --- /dev/null +++ b/doc/javadoc/index-files/index-7.html @@ -0,0 +1,179 @@ + + + + + +I-Index + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
A C D E G H I N O P R S T U V W  + + +

I

+
+
indexOfNavigationPreference(NavigationPreference) - Method in class de.mrapp.android.preference.activity.adapter.NavigationPreferenceAdapter
+
+
Returns the index of a specific navigation preference among all navigation preferences, which + are contained by the adapter.
+
+
isAdapterCreated() - Method in class de.mrapp.android.preference.activity.fragment.NavigationFragment
+
+
Returns, whether the adapter, which contains the navigation preferences, has been created + yet, or not.
+
+
isBreadCrumbHidden() - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
+
Returns, whether the toolbar, which is used to show the bread crumb of the currently selected + navigation preference, is hidden, or not.
+
+
isButtonBarShown() - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
+
Returns, whether the activity is used as a wizard, or not.
+
+
isNavigationHidden() - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
+
Returns, whether the navigation is currently hidden, or not.
+
+
isNavigationHidden() - Method in class de.mrapp.android.preference.activity.view.ToolbarLarge
+
+
Returns, whether the navigation is hidden, or not.
+
+
isNavigationIconOverridden() - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
+
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.
+
+
isNavigationPreferenceSelected() - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
+
Returns, whether a navigation preference is currently selected, or not.
+
+
isPreferenceFragmentShown() - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
+
Returns, whether a preference fragment is currently shown, or not.
+
+
isProgressShown() - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
+
Returns, whether the progress is shown, if the activity is used as a wizard.
+
+
isRestoreDefaultsButtonShown() - Method in class de.mrapp.android.preference.activity.PreferenceFragment
+
+
Returns, whether the button, which allows to restore the preferences' default values, is + currently shown, or not.
+
+
isSplitScreen() - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
+
Returns, whether the split screen layout is used, or not.
+
+
+A C D E G H I N O P R S T U V W 
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/javadoc/index-files/index-8.html b/doc/javadoc/index-files/index-8.html new file mode 100644 index 0000000..53e4b31 --- /dev/null +++ b/doc/javadoc/index-files/index-8.html @@ -0,0 +1,184 @@ + + + + + +N-Index + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
A C D E G H I N O P R S T U V W  + + +

N

+
+
NavigationFragment - Class in de.mrapp.android.preference.activity.fragment
+
+
A fragment, which contains the navigation of a PreferenceActivity.
+
+
NavigationFragment() - Constructor for class de.mrapp.android.preference.activity.fragment.NavigationFragment
+
 
+
NavigationFragment.Callback - Interface in de.mrapp.android.preference.activity.fragment
+
+
Defines the interface, a class, which should be notified about the fragment's events, must + implement.
+
+
NavigationListener - Interface in de.mrapp.android.preference.activity
+
+
Defines the interface, a class, which should be notified when NavigationPreferences are + added or removed to/from a PreferenceActivity, must implement.
+
+
NavigationPreference - Class in de.mrapp.android.preference.activity
+
+
A preference, which allows to show a fragment within a PreferenceActivity when clicked.
+
+
NavigationPreference(Context) - Constructor for class de.mrapp.android.preference.activity.NavigationPreference
+
+
Creates a new preference, which allows to show a preference screen within a PreferenceActivity when clicked.
+
+
NavigationPreference(Context, AttributeSet) - Constructor for class de.mrapp.android.preference.activity.NavigationPreference
+
+
Creates a new preference, which allows to show a preference screen within a PreferenceActivity when clicked.
+
+
NavigationPreference(Context, AttributeSet, int) - Constructor for class de.mrapp.android.preference.activity.NavigationPreference
+
+
Creates a new preference, which allows to show a preference screen within a PreferenceActivity when clicked.
+
+
NavigationPreference(Context, AttributeSet, int, int) - Constructor for class de.mrapp.android.preference.activity.NavigationPreference
+
+
Creates a new preference, which allows to show a preference screen within a PreferenceActivity when clicked.
+
+
NavigationPreference.Callback - Interface in de.mrapp.android.preference.activity
+
+
Defines the callback, a class, which should be notified, when the fragment, which is + associated with a navigation preference, should be shown, must implement.
+
+
NavigationPreference.SavedState - Class in de.mrapp.android.preference.activity
+
+
A data structure, which allows to save the internal state of a NavigationPreference.
+
+
NavigationPreferenceAdapter - Class in de.mrapp.android.preference.activity.adapter
+
+
A PreferenceAdapter, which is used to visualize the navigation preferences of a PreferenceActivity.
+
+
NavigationPreferenceAdapter(PreferenceScreen, NavigationPreferenceAdapter.Callback) - Constructor for class de.mrapp.android.preference.activity.adapter.NavigationPreferenceAdapter
+
+
Creates a new PreferenceAdapter, which is used to visualize the navigation + preferences of a PreferenceActivity.
+
+
NavigationPreferenceAdapter.Callback - Interface in de.mrapp.android.preference.activity.adapter
+
+
Defines the callback, a class, which should be notified about the adapter's events, must + implement.
+
+
+A C D E G H I N O P R S T U V W 
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/javadoc/index-files/index-9.html b/doc/javadoc/index-files/index-9.html new file mode 100644 index 0000000..7f26236 --- /dev/null +++ b/doc/javadoc/index-files/index-9.html @@ -0,0 +1,304 @@ + + + + + +O-Index + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
A C D E G H I N O P R S T U V W  + + +

O

+
+
onActivityCreated(Bundle) - Method in class de.mrapp.android.preference.activity.fragment.NavigationFragment
+
 
+
onActivityCreated(Bundle) - Method in class de.mrapp.android.preference.activity.PreferenceFragment
+
 
+
onBackPressed() - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
 
+
onBindViewHolder(PreferenceViewHolder, int) - Method in class de.mrapp.android.preference.activity.adapter.PreferenceAdapter
+
 
+
onCreate(Bundle) - Method in class de.mrapp.android.preference.activity.fragment.AbstractPreferenceFragment
+
 
+
onCreate(Bundle) - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
 
+
onCreate(Bundle) - Method in class de.mrapp.android.preference.activity.PreferenceFragment
+
 
+
onCreateAdapter(PreferenceScreen) - Method in class de.mrapp.android.preference.activity.fragment.AbstractPreferenceFragment
+
 
+
onCreateNavigation(PreferenceFragmentCompat) - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
+
The method, which is invoked on implementing subclasses, when the navigation is created.
+
+
onCreatePreferenceAdapter(PreferenceScreen) - Method in class de.mrapp.android.preference.activity.fragment.AbstractPreferenceFragment
+
+
The method, which is invoked in order to create the adapter, which is used to manage the + fragment's preferences.
+
+
onCreatePreferenceAdapter(PreferenceScreen) - Method in class de.mrapp.android.preference.activity.fragment.NavigationFragment
+
 
+
onCreatePreferences(Bundle, String) - Method in class de.mrapp.android.preference.activity.fragment.NavigationFragment
+
 
+
onCreateRecyclerView(LayoutInflater, ViewGroup, Bundle) - Method in class de.mrapp.android.preference.activity.fragment.NavigationFragment
+
 
+
onCreateView(LayoutInflater, ViewGroup, Bundle) - Method in class de.mrapp.android.preference.activity.fragment.AbstractPreferenceFragment
+
 
+
onCreateView(LayoutInflater, ViewGroup, Bundle) - Method in class de.mrapp.android.preference.activity.PreferenceFragment
+
 
+
onFinish(NavigationPreference, Fragment, Bundle) - Method in interface de.mrapp.android.preference.activity.WizardListener
+
+
The method, which is invoked, when the user wants to finish the last step of the wizard.
+
+
onNavigationAdapterCreated() - Method in interface de.mrapp.android.preference.activity.fragment.NavigationFragment.Callback
+
+
The method, which is invoked, when the adapter, which contains the navigation items, has + been created.
+
+
onNavigationAdapterCreated() - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
 
+
onNavigationFragmentCreated(PreferenceFragmentCompat) - Method in interface de.mrapp.android.preference.activity.fragment.NavigationFragment.Callback
+
+
The method, which is invoked, when the navigation fragment has been attached to its + activity.
+
+
onNavigationFragmentCreated(PreferenceFragmentCompat) - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
 
+
onNavigationPreferenceAdded(NavigationPreference) - Method in interface de.mrapp.android.preference.activity.adapter.NavigationPreferenceAdapter.Callback
+
+
The method, which is invoked, when a navigation preference has been added.
+
+
onNavigationPreferenceAdded(NavigationPreference) - Method in class de.mrapp.android.preference.activity.fragment.NavigationFragment
+
 
+
onNavigationPreferenceAdded(NavigationPreference) - Method in interface de.mrapp.android.preference.activity.NavigationListener
+
+
The method, which is invoked, when a navigation preference has been added.
+
+
onNavigationPreferenceAdded(NavigationPreference) - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
 
+
onNavigationPreferenceRemoved(NavigationPreference) - Method in interface de.mrapp.android.preference.activity.adapter.NavigationPreferenceAdapter.Callback
+
+
The method, which is invoked, when a navigation preference has been removed.
+
+
onNavigationPreferenceRemoved(NavigationPreference) - Method in class de.mrapp.android.preference.activity.fragment.NavigationFragment
+
 
+
onNavigationPreferenceRemoved(NavigationPreference) - Method in interface de.mrapp.android.preference.activity.NavigationListener
+
+
The method, which is invoked, when a navigation preference has been removed.
+
+
onNavigationPreferenceRemoved(NavigationPreference) - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
 
+
onNavigationPreferenceSelected(NavigationPreference, Bundle) - Method in interface de.mrapp.android.preference.activity.adapter.NavigationPreferenceAdapter.Callback
+
+
The method, which is invoked, when a navigation preference has been selected.
+
+
onNavigationPreferenceSelected(NavigationPreference, Bundle) - Method in class de.mrapp.android.preference.activity.fragment.NavigationFragment
+
 
+
onNavigationPreferenceSelected(NavigationPreference, Bundle) - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
 
+
onNavigationPreferenceUnselected() - Method in interface de.mrapp.android.preference.activity.adapter.NavigationPreferenceAdapter.Callback
+
+
The method, which is invoked, when a navigation preference has been unselected.
+
+
onNavigationPreferenceUnselected() - Method in class de.mrapp.android.preference.activity.fragment.NavigationFragment
+
 
+
onNavigationPreferenceUnselected() - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
 
+
onNextStep(NavigationPreference, Fragment, Bundle) - Method in interface de.mrapp.android.preference.activity.WizardListener
+
+
The method, which is invoked, when the user wants to navigate to the next step of the + wizard.
+
+
onOptionsItemSelected(MenuItem) - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
 
+
onPreferenceFragmentHidden(Fragment) - Method in interface de.mrapp.android.preference.activity.PreferenceFragmentListener
+
+
The method, which is invoked, when a previously shown preference fragment has been hidden.
+
+
onPreferenceFragmentShown(NavigationPreference, Fragment) - Method in interface de.mrapp.android.preference.activity.PreferenceFragmentListener
+
+
The method, which is invoked, when a preference fragment has been shown.
+
+
onPreviousStep(NavigationPreference, Fragment, Bundle) - Method in interface de.mrapp.android.preference.activity.WizardListener
+
+
The method, which is invoked, when the user wants to navigate to the previous step of the + wizard.
+
+
onRestoredDefaultValue(PreferenceFragment, Preference, Object, Object) - Method in interface de.mrapp.android.preference.activity.RestoreDefaultsListener
+
+
The method, which is invoked, when the default value of a specific preference has been + restored.
+
+
onRestoreDefaultValueRequested(PreferenceFragment, Preference, Object) - Method in interface de.mrapp.android.preference.activity.RestoreDefaultsListener
+
+
The method, which is invoked, when the default value of a specific preference, should be + restored.
+
+
onRestoreDefaultValuesRequested(PreferenceFragment) - Method in interface de.mrapp.android.preference.activity.RestoreDefaultsListener
+
+
The method, which is invoked, when the default values of the preferences, which belong to a + specific preference fragment, should be restored.
+
+
onRestoreInstanceState(Parcelable) - Method in class de.mrapp.android.preference.activity.NavigationPreference
+
 
+
onRestoreInstanceState(Bundle) - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
 
+
onSaveInstanceState() - Method in class de.mrapp.android.preference.activity.NavigationPreference
+
 
+
onSaveInstanceState(Bundle) - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
 
+
onScrolled(RecyclerView, int, int) - Method in class de.mrapp.android.preference.activity.animation.HideViewOnScrollAnimation
+
 
+
onScrollingDown(HideViewOnScrollAnimation, View, int) - Method in interface de.mrapp.android.preference.activity.animation.HideViewOnScrollAnimationListener
+
+
The method, which is invoked, when the list view, which is observed by the animation, is + scrolling downwards.
+
+
onScrollingUp(HideViewOnScrollAnimation, View, int) - Method in interface de.mrapp.android.preference.activity.animation.HideViewOnScrollAnimationListener
+
+
The method, which is invoked, when the list view, which is observed by the animation, is + scrolling upwards.
+
+
onSelectNavigationPreference(NavigationPreference) - Method in interface de.mrapp.android.preference.activity.adapter.NavigationPreferenceAdapter.Callback
+
+
The method, which is invoked, when a navigation preference is about to be selected.
+
+
onSelectNavigationPreference(NavigationPreference) - Method in class de.mrapp.android.preference.activity.fragment.NavigationFragment
+
 
+
onSelectNavigationPreference(NavigationPreference) - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
 
+
onShowFragment(NavigationPreference) - Method in class de.mrapp.android.preference.activity.adapter.NavigationPreferenceAdapter
+
 
+
onShowFragment(NavigationPreference) - Method in interface de.mrapp.android.preference.activity.NavigationPreference.Callback
+
+
The method, which is invoked, when the fragment, which is associated with a specific + navigation preference, should be shown.
+
+
onSkip(NavigationPreference, Fragment, Bundle) - Method in interface de.mrapp.android.preference.activity.WizardListener
+
+
The method, which is invoked, when the user wants to skip the wizard.
+
+
onVisualizePreference(Preference, PreferenceViewHolder) - Method in class de.mrapp.android.preference.activity.adapter.NavigationPreferenceAdapter
+
 
+
onVisualizePreference(Preference, PreferenceViewHolder) - Method in class de.mrapp.android.preference.activity.adapter.PreferenceAdapter
+
+
The method, which is invoked, when a specific preference is visualized.
+
+
overrideNavigationIcon(boolean) - Method in class de.mrapp.android.preference.activity.PreferenceActivity
+
+
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.
+
+
+A C D E G H I N O P R S T U V W 
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/javadoc/index.html b/doc/javadoc/index.html new file mode 100644 index 0000000..e4b3077 --- /dev/null +++ b/doc/javadoc/index.html @@ -0,0 +1,75 @@ + + + + + +Generated Documentation (Untitled) + + + + + + + + + +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<h2>Frame Alert</h2> +<p>This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. Link to <a href="overview-summary.html">Non-frame version</a>.</p> + + + diff --git a/doc/javadoc/overview-frame.html b/doc/javadoc/overview-frame.html new file mode 100644 index 0000000..3811d9f --- /dev/null +++ b/doc/javadoc/overview-frame.html @@ -0,0 +1,25 @@ + + + + + +Overview List + + + + + +
All Classes
+
+

Packages

+ +
+

 

+ + diff --git a/doc/javadoc/overview-summary.html b/doc/javadoc/overview-summary.html new file mode 100644 index 0000000..f60ff0c --- /dev/null +++ b/doc/javadoc/overview-summary.html @@ -0,0 +1,149 @@ + + + + + +Overview + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Packages 
PackageDescription
de.mrapp.android.preference.activity 
de.mrapp.android.preference.activity.adapter 
de.mrapp.android.preference.activity.animation 
de.mrapp.android.preference.activity.fragment 
de.mrapp.android.preference.activity.view 
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/javadoc/overview-tree.html b/doc/javadoc/overview-tree.html new file mode 100644 index 0000000..e0d5694 --- /dev/null +++ b/doc/javadoc/overview-tree.html @@ -0,0 +1,245 @@ + + + + + +Class Hierarchy + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For All Packages

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +

Enum Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/javadoc/package-list b/doc/javadoc/package-list new file mode 100644 index 0000000..7f717f6 --- /dev/null +++ b/doc/javadoc/package-list @@ -0,0 +1,5 @@ +de.mrapp.android.preference.activity +de.mrapp.android.preference.activity.adapter +de.mrapp.android.preference.activity.animation +de.mrapp.android.preference.activity.fragment +de.mrapp.android.preference.activity.view diff --git a/doc/javadoc/script.js b/doc/javadoc/script.js new file mode 100644 index 0000000..b346356 --- /dev/null +++ b/doc/javadoc/script.js @@ -0,0 +1,30 @@ +function show(type) +{ + count = 0; + for (var key in methods) { + var row = document.getElementById(key); + if ((methods[key] & type) != 0) { + row.style.display = ''; + row.className = (count++ % 2) ? rowColor : altColor; + } + else + row.style.display = 'none'; + } + updateTabs(type); +} + +function updateTabs(type) +{ + for (var value in tabs) { + var sNode = document.getElementById(tabs[value][0]); + var spanNode = sNode.firstChild; + if (value == type) { + sNode.className = activeTableTab; + spanNode.innerHTML = tabs[value][1]; + } + else { + sNode.className = tableTab; + spanNode.innerHTML = "" + tabs[value][1] + ""; + } + } +} diff --git a/doc/javadoc/stylesheet.css b/doc/javadoc/stylesheet.css new file mode 100644 index 0000000..98055b2 --- /dev/null +++ b/doc/javadoc/stylesheet.css @@ -0,0 +1,574 @@ +/* Javadoc style sheet */ +/* +Overall document style +*/ + +@import url('resources/fonts/dejavu.css'); + +body { + background-color:#ffffff; + color:#353833; + font-family:'DejaVu Sans', Arial, Helvetica, sans-serif; + font-size:14px; + margin:0; +} +a:link, a:visited { + text-decoration:none; + color:#4A6782; +} +a:hover, a:focus { + text-decoration:none; + color:#bb7a2a; +} +a:active { + text-decoration:none; + color:#4A6782; +} +a[name] { + color:#353833; +} +a[name]:hover { + text-decoration:none; + color:#353833; +} +pre { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; +} +h1 { + font-size:20px; +} +h2 { + font-size:18px; +} +h3 { + font-size:16px; + font-style:italic; +} +h4 { + font-size:13px; +} +h5 { + font-size:12px; +} +h6 { + font-size:11px; +} +ul { + list-style-type:disc; +} +code, tt { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; + margin-top:8px; + line-height:1.4em; +} +dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; +} +table tr td dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + vertical-align:top; + padding-top:4px; +} +sup { + font-size:8px; +} +/* +Document title and Copyright styles +*/ +.clear { + clear:both; + height:0px; + overflow:hidden; +} +.aboutLanguage { + float:right; + padding:0px 21px; + font-size:11px; + z-index:200; + margin-top:-9px; +} +.legalCopy { + margin-left:.5em; +} +.bar a, .bar a:link, .bar a:visited, .bar a:active { + color:#FFFFFF; + text-decoration:none; +} +.bar a:hover, .bar a:focus { + color:#bb7a2a; +} +.tab { + background-color:#0066FF; + color:#ffffff; + padding:8px; + width:5em; + font-weight:bold; +} +/* +Navigation bar styles +*/ +.bar { + background-color:#4D7A97; + color:#FFFFFF; + padding:.8em .5em .4em .8em; + height:auto;/*height:1.8em;*/ + font-size:11px; + margin:0; +} +.topNav { + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.bottomNav { + margin-top:10px; + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.subNav { + background-color:#dee3e9; + float:left; + width:100%; + overflow:hidden; + font-size:12px; +} +.subNav div { + clear:left; + float:left; + padding:0 0 5px 6px; + text-transform:uppercase; +} +ul.navList, ul.subNavList { + float:left; + margin:0 25px 0 0; + padding:0; +} +ul.navList li{ + list-style:none; + float:left; + padding: 5px 6px; + text-transform:uppercase; +} +ul.subNavList li{ + list-style:none; + float:left; +} +.topNav a:link, .topNav a:active, .topNav a:visited, .bottomNav a:link, .bottomNav a:active, .bottomNav a:visited { + color:#FFFFFF; + text-decoration:none; + text-transform:uppercase; +} +.topNav a:hover, .bottomNav a:hover { + text-decoration:none; + color:#bb7a2a; + text-transform:uppercase; +} +.navBarCell1Rev { + background-color:#F8981D; + color:#253441; + margin: auto 5px; +} +.skipNav { + position:absolute; + top:auto; + left:-9999px; + overflow:hidden; +} +/* +Page header and footer styles +*/ +.header, .footer { + clear:both; + margin:0 20px; + padding:5px 0 0 0; +} +.indexHeader { + margin:10px; + position:relative; +} +.indexHeader span{ + margin-right:15px; +} +.indexHeader h1 { + font-size:13px; +} +.title { + color:#2c4557; + margin:10px 0; +} +.subTitle { + margin:5px 0 0 0; +} +.header ul { + margin:0 0 15px 0; + padding:0; +} +.footer ul { + margin:20px 0 5px 0; +} +.header ul li, .footer ul li { + list-style:none; + font-size:13px; +} +/* +Heading styles +*/ +div.details ul.blockList ul.blockList ul.blockList li.blockList h4, div.details ul.blockList ul.blockList ul.blockListLast li.blockList h4 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList ul.blockList li.blockList h3 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList li.blockList h3 { + padding:0; + margin:15px 0; +} +ul.blockList li.blockList h2 { + padding:0px 0 20px 0; +} +/* +Page layout container styles +*/ +.contentContainer, .sourceContainer, .classUseContainer, .serializedFormContainer, .constantValuesContainer { + clear:both; + padding:10px 20px; + position:relative; +} +.indexContainer { + margin:10px; + position:relative; + font-size:12px; +} +.indexContainer h2 { + font-size:13px; + padding:0 0 3px 0; +} +.indexContainer ul { + margin:0; + padding:0; +} +.indexContainer ul li { + list-style:none; + padding-top:2px; +} +.contentContainer .description dl dt, .contentContainer .details dl dt, .serializedFormContainer dl dt { + font-size:12px; + font-weight:bold; + margin:10px 0 0 0; + color:#4E4E4E; +} +.contentContainer .description dl dd, .contentContainer .details dl dd, .serializedFormContainer dl dd { + margin:5px 0 10px 0px; + font-size:14px; + font-family:'DejaVu Sans Mono',monospace; +} +.serializedFormContainer dl.nameValue dt { + margin-left:1px; + font-size:1.1em; + display:inline; + font-weight:bold; +} +.serializedFormContainer dl.nameValue dd { + margin:0 0 0 1px; + font-size:1.1em; + display:inline; +} +/* +List styles +*/ +ul.horizontal li { + display:inline; + font-size:0.9em; +} +ul.inheritance { + margin:0; + padding:0; +} +ul.inheritance li { + display:inline; + list-style:none; +} +ul.inheritance li ul.inheritance { + margin-left:15px; + padding-left:15px; + padding-top:1px; +} +ul.blockList, ul.blockListLast { + margin:10px 0 10px 0; + padding:0; +} +ul.blockList li.blockList, ul.blockListLast li.blockList { + list-style:none; + margin-bottom:15px; + line-height:1.4; +} +ul.blockList ul.blockList li.blockList, ul.blockList ul.blockListLast li.blockList { + padding:0px 20px 5px 10px; + border:1px solid #ededed; + background-color:#f8f8f8; +} +ul.blockList ul.blockList ul.blockList li.blockList, ul.blockList ul.blockList ul.blockListLast li.blockList { + padding:0 0 5px 8px; + background-color:#ffffff; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockList { + margin-left:0; + padding-left:0; + padding-bottom:15px; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockListLast { + list-style:none; + border-bottom:none; + padding-bottom:0; +} +table tr td dl, table tr td dl dt, table tr td dl dd { + margin-top:0; + margin-bottom:1px; +} +/* +Table styles +*/ +.overviewSummary, .memberSummary, .typeSummary, .useSummary, .constantsSummary, .deprecatedSummary { + width:100%; + border-left:1px solid #EEE; + border-right:1px solid #EEE; + border-bottom:1px solid #EEE; +} +.overviewSummary, .memberSummary { + padding:0px; +} +.overviewSummary caption, .memberSummary caption, .typeSummary caption, +.useSummary caption, .constantsSummary caption, .deprecatedSummary caption { + position:relative; + text-align:left; + background-repeat:no-repeat; + color:#253441; + font-weight:bold; + clear:none; + overflow:hidden; + padding:0px; + padding-top:10px; + padding-left:1px; + margin:0px; + white-space:pre; +} +.overviewSummary caption a:link, .memberSummary caption a:link, .typeSummary caption a:link, +.useSummary caption a:link, .constantsSummary caption a:link, .deprecatedSummary caption a:link, +.overviewSummary caption a:hover, .memberSummary caption a:hover, .typeSummary caption a:hover, +.useSummary caption a:hover, .constantsSummary caption a:hover, .deprecatedSummary caption a:hover, +.overviewSummary caption a:active, .memberSummary caption a:active, .typeSummary caption a:active, +.useSummary caption a:active, .constantsSummary caption a:active, .deprecatedSummary caption a:active, +.overviewSummary caption a:visited, .memberSummary caption a:visited, .typeSummary caption a:visited, +.useSummary caption a:visited, .constantsSummary caption a:visited, .deprecatedSummary caption a:visited { + color:#FFFFFF; +} +.overviewSummary caption span, .memberSummary caption span, .typeSummary caption span, +.useSummary caption span, .constantsSummary caption span, .deprecatedSummary caption span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + padding-bottom:7px; + display:inline-block; + float:left; + background-color:#F8981D; + border: none; + height:16px; +} +.memberSummary caption span.activeTableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#F8981D; + height:16px; +} +.memberSummary caption span.tableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#4D7A97; + height:16px; +} +.memberSummary caption span.tableTab, .memberSummary caption span.activeTableTab { + padding-top:0px; + padding-left:0px; + padding-right:0px; + background-image:none; + float:none; + display:inline; +} +.overviewSummary .tabEnd, .memberSummary .tabEnd, .typeSummary .tabEnd, +.useSummary .tabEnd, .constantsSummary .tabEnd, .deprecatedSummary .tabEnd { + display:none; + width:5px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .activeTableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .tableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + background-color:#4D7A97; + float:left; + +} +.overviewSummary td, .memberSummary td, .typeSummary td, +.useSummary td, .constantsSummary td, .deprecatedSummary td { + text-align:left; + padding:0px 0px 12px 10px; +} +th.colOne, th.colFirst, th.colLast, .useSummary th, .constantsSummary th, +td.colOne, td.colFirst, td.colLast, .useSummary td, .constantsSummary td{ + vertical-align:top; + padding-right:0px; + padding-top:8px; + padding-bottom:3px; +} +th.colFirst, th.colLast, th.colOne, .constantsSummary th { + background:#dee3e9; + text-align:left; + padding:8px 3px 3px 7px; +} +td.colFirst, th.colFirst { + white-space:nowrap; + font-size:13px; +} +td.colLast, th.colLast { + font-size:13px; +} +td.colOne, th.colOne { + font-size:13px; +} +.overviewSummary td.colFirst, .overviewSummary th.colFirst, +.useSummary td.colFirst, .useSummary th.colFirst, +.overviewSummary td.colOne, .overviewSummary th.colOne, +.memberSummary td.colFirst, .memberSummary th.colFirst, +.memberSummary td.colOne, .memberSummary th.colOne, +.typeSummary td.colFirst{ + width:25%; + vertical-align:top; +} +td.colOne a:link, td.colOne a:active, td.colOne a:visited, td.colOne a:hover, td.colFirst a:link, td.colFirst a:active, td.colFirst a:visited, td.colFirst a:hover, td.colLast a:link, td.colLast a:active, td.colLast a:visited, td.colLast a:hover, .constantValuesContainer td a:link, .constantValuesContainer td a:active, .constantValuesContainer td a:visited, .constantValuesContainer td a:hover { + font-weight:bold; +} +.tableSubHeadingColor { + background-color:#EEEEFF; +} +.altColor { + background-color:#FFFFFF; +} +.rowColor { + background-color:#EEEEEF; +} +/* +Content styles +*/ +.description pre { + margin-top:0; +} +.deprecatedContent { + margin:0; + padding:10px 0; +} +.docSummary { + padding:0; +} + +ul.blockList ul.blockList ul.blockList li.blockList h3 { + font-style:normal; +} + +div.block { + font-size:14px; + font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; +} + +td.colLast div { + padding-top:0px; +} + + +td.colLast a { + padding-bottom:3px; +} +/* +Formatting effect styles +*/ +.sourceLineNo { + color:green; + padding:0 30px 0 0; +} +h1.hidden { + visibility:hidden; + overflow:hidden; + font-size:10px; +} +.block { + display:block; + margin:3px 10px 2px 0px; + color:#474747; +} +.deprecatedLabel, .descfrmTypeLabel, .memberNameLabel, .memberNameLink, +.overrideSpecifyLabel, .packageHierarchyLabel, .paramLabel, .returnLabel, +.seeLabel, .simpleTagLabel, .throwsLabel, .typeNameLabel, .typeNameLink { + font-weight:bold; +} +.deprecationComment, .emphasizedPhrase, .interfaceName { + font-style:italic; +} + +div.block div.block span.deprecationComment, div.block div.block span.emphasizedPhrase, +div.block div.block span.interfaceName { + font-style:normal; +} + +div.contentContainer ul.blockList li.blockList h2{ + padding-bottom:0px; +}