Android
android.preference
public abstract class

android.preference.PreferenceGroup

java.lang.Object
android.preference.Preference Comparable<T>
android.preference.PreferenceGroup

The PreferenceGroup class is a container for multiple Preferences. It is a base class for Preference that are parents, such as PreferenceCategory and PreferenceScreen.

Known Direct Subclasses

Summary

XML Attributes

Attribute name Related methods  
android:orderingFromXml   Whether to order the Preference under this group as they appear in the XML file. 
XML Attributes inherited from class android.preference.Preference
Constants inherited from class android.preference.Preference

Public Constructors

            PreferenceGroup(Context context, AttributeSet attrs, int defStyle)
            PreferenceGroup(Context context, AttributeSet attrs)

Public Methods

          void  addItemFromInflater(Preference preference)
Called by the inflater to add an item to this group.
          void  addItemFromInflater(T child)
          boolean  addPreference(Preference preference)
Adds a Preference at the correct position based on the preference's order.
          Preference  findPreference(CharSequence key)
Finds a Preference based on its key.
          Preference  getPreference(int index)
Returns the Preference at a particular index.
          int  getPreferenceCount()
Returns the number of children Preferences.
          boolean  isOrderingAsAdded()
Whether this group is ordering preferences in the order they are added.
          void  removeAll()
Removes all Preferences from this group.
          boolean  removePreference(Preference preference)
Removes a Preference from this group.
          void  setEnabled(boolean enabled)
Sets whether this preference is enabled.
          void  setOrderingAsAdded(boolean orderingAsAdded)
Whether to order the Preference children of this group as they are added.

Protected Methods

          void  dispatchRestoreInstanceState(Bundle container)
Called by restoreHierarchyState(Bundle) to retrieve the icicles for this preference and its children.
          void  dispatchSaveInstanceState(Bundle container)
Called by saveHierarchyState(Bundle) to store the icicles for this preference and its children.
          boolean  isOnSameScreenAsChildren()
Whether this preference group should be shown on the same screen as its contained preferences.
          void  onAttachedToActivity()
Called when the preference hierarchy has been attached to the PreferenceActivity.
          boolean  onPrepareAddPreference(Preference preference)
Prepares a Preference to be added to the group.
          void  onPrepareForRemoval()
Called when this Preference is being removed from the hierarchy.
Methods inherited from class android.preference.Preference
Methods inherited from class java.lang.Object
Methods inherited from interface java.lang.Comparable

Details

XML Attributes

android:orderingFromXml

Whether to order the Preference under this group as they appear in the XML file. If this is false, the ordering will follow the Preference order attribute and default to alphabetic for those without the order attribute.

Must be a boolean value, either "true" or "false".

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol orderingFromXml.

Related Methods

Public Constructors

public PreferenceGroup(Context context, AttributeSet attrs, int defStyle)

public PreferenceGroup(Context context, AttributeSet attrs)

Public Methods

public void addItemFromInflater(Preference preference)

Called by the inflater to add an item to this group.

public void addItemFromInflater(T child)

public boolean addPreference(Preference preference)

Adds a Preference at the correct position based on the preference's order.

Parameters

preference The preference to add.

Returns

  • Whether the preference is now in this group.

public Preference findPreference(CharSequence key)

Finds a Preference based on its key. If two Preference share the same key (not recommended), the first to appear will be returned (to retrieve the other preference with the same key, call this method on the first preference). If this preference has the key, it will not be returned.

This will recursively search for the preference into children that are also PreferenceGroups.

Parameters

key The key of the preference to retrieve.

Returns

public Preference getPreference(int index)

Returns the Preference at a particular index.

Parameters

index The index of the Preference to retrieve.

Returns

public int getPreferenceCount()

Returns the number of children Preferences.

Returns

  • The number of preference children in this group.

public boolean isOrderingAsAdded()

Whether this group is ordering preferences in the order they are added.

Returns

  • Whether this group orders based on the order the children are added.

public void removeAll()

Removes all Preferences from this group.

public boolean removePreference(Preference preference)

Removes a Preference from this group.

Parameters

preference The preference to remove.

Returns

  • Whether the preference was found and removed.

public void setEnabled(boolean enabled)

Sets whether this preference is enabled. If disabled, the preference will not handle clicks.

Parameters

enabled Whether the preference is enabled.

public void setOrderingAsAdded(boolean orderingAsAdded)

Whether to order the Preference children of this group as they are added. If this is false, the ordering will follow each Preference order and default to alphabetic for those without an order.

If this is called after preferences are added, they will not be re-ordered in the order they were added, hence call this method early on.

Parameters

orderingAsAdded Whether to order according to the order added.

See Also

Protected Methods

protected void dispatchRestoreInstanceState(Bundle container)

Called by restoreHierarchyState(Bundle) to retrieve the icicles for this preference and its children. May be overridden to modify how restoreing happens to a preference's children; for example, some preferences may want to not store icicles for their children.

Parameters

container The Bundle which holds previously frozen icicles.

protected void dispatchSaveInstanceState(Bundle container)

Called by saveHierarchyState(Bundle) to store the icicles for this preference and its children. May be overridden to modify how freezing happens to a preference's children; for example, some preferences may want to not store icicles for their children.

Parameters

container The Bundle in which to save the preference's icicles.

protected boolean isOnSameScreenAsChildren()

Whether this preference group should be shown on the same screen as its contained preferences.

Returns

  • True if the contained preferences should be shown on the same screen as this preference.

protected void onAttachedToActivity()

Called when the preference hierarchy has been attached to the PreferenceActivity. This can also be called when this Preference has been attached to a group that was already attached to the PreferenceActivity.

protected boolean onPrepareAddPreference(Preference preference)

Prepares a Preference to be added to the group.

Parameters

preference The preference to add.

Returns

  • Whether to allow adding the preference (true), or not (false).

protected void onPrepareForRemoval()

Called when this Preference is being removed from the hierarchy. You should remove any references to this Preference that you know about. Make sure to call through to the superclass implementation.
Copyright 2007 Google Inc. Build 0.9_r1-98467 - 14 Aug 2008 18:48