Boolean callChangeListener(newValue: Any!)

Call this method after the user changes the preference, but before the internal state is set. This allows the client to ignore the user value.

Int compareTo(other: Preference!)

Compares Preference objects based on order (if set), otherwise alphabetically on the titles.

Preference! findPreferenceInHierarchy(key: String!)

Finds a Preference in this hierarchy (the whole thing, even above/below your PreferenceScreen screen break) with the given key.

This only functions after we have been attached to a hierarchy.

Context! getContext()

Returns the android.content.Context of this Preference. Each Preference in a Preference hierarchy can be from different Context (for example, if multiple activities provide preferences into a single PreferenceActivity). This Context will be used to save the Preference values.

String! getDependency()

Returns the key of the dependency on this Preference.

SharedPreferences.Editor! getEditor()

Returns an SharedPreferences.Editor where this Preference can save its value(s). Usually it's easier to use one of the helper save methods: persistBoolean(boolean), persistFloat(float), persistInt(int), persistLong(long), persistString(String). To read values, see getSharedPreferences(). If shouldCommit() returns true, it is this Preference's responsibility to commit.

In some cases, writes to this will not be committed right away and hence not show up in the SharedPreferences, this is intended behavior to improve performance.

Bundle! getExtras()

Return the extras Bundle object associated with this preference, creating a new Bundle if there currently isn't one. You can use this to get and set individual extra key/value pairs.

String! getFragment()

Return the fragment class name associated with this Preference.

Drawable! getIcon()

Returns the icon of this Preference.

Intent! getIntent()

Return the Intent associated with this Preference.

String! getKey()

Gets the key for this Preference, which is also the key used for storing values into SharedPreferences or PreferenceDataStore.

Int getLayoutResource()

Gets the layout resource that will be shown as the View for this Preference.

Preference.OnPreferenceChangeListener! getOnPreferenceChangeListener()

Returns the callback to be invoked when this Preference is changed by the user (but before the internal state has been updated).

Preference.OnPreferenceClickListener! getOnPreferenceClickListener()

Returns the callback to be invoked when this Preference is clicked.

Int getOrder()

Gets the order of this Preference with respect to other Preference objects on the same level.

PreferenceGroup? getParent()

Returns the PreferenceGroup which is this Preference assigned to or null if this preference is not assigned to any group or is a root Preference.

Boolean getPersistedBoolean(defaultReturnValue: Boolean)

Attempts to get a persisted boolean if this Preference is persistent.

Float getPersistedFloat(defaultReturnValue: Float)

Attempts to get a persisted float if this Preference is persistent.

Int getPersistedInt(defaultReturnValue: Int)

Attempts to get a persisted int if this Preference is persistent.

Long getPersistedLong(defaultReturnValue: Long)

Attempts to get a persisted long if this Preference is persistent.

String! getPersistedString(defaultReturnValue: String!)

Attempts to get a persisted String if this Preference is persistent.

MutableSet<String!>! getPersistedStringSet(defaultReturnValue: MutableSet<String!>!)

Attempts to get a persisted set of Strings if this Preference is persistent.

PreferenceDataStore? getPreferenceDataStore()

Returns PreferenceDataStore used by this Preference. Returns null if android.content.SharedPreferences is used instead.

By default preferences always use android.content.SharedPreferences. To make this preference to use the PreferenceDataStore you need to assign your implementation to the Preference itself via setPreferenceDataStore(PreferenceDataStore) or to its PreferenceManager via PreferenceManager.setPreferenceDataStore(PreferenceDataStore).

PreferenceManager! getPreferenceManager()

Gets the PreferenceManager that manages this Preference object's tree.

SharedPreferences! getSharedPreferences()

Returns the SharedPreferences where this Preference can read its value(s). Usually, it's easier to use one of the helper read methods: getPersistedBoolean(boolean), getPersistedFloat(float), getPersistedInt(int), getPersistedLong(long), getPersistedString(String). To save values, see getEditor().

In some cases, writes to the getEditor() will not be committed right away and hence not show up in the returned SharedPreferences, this is intended behavior to improve performance.

Boolean getShouldDisableView()

Checks whether this Preference should disable its view when it's action is disabled.

CharSequence! getSummary()

Returns the summary of this Preference.

CharSequence! getTitle()

Returns the title of this Preference.

Int getTitleRes()

Returns the title resource ID of this Preference. If the title did not come from a resource, 0 is returned.

View! getView(convertView: View!, parent: ViewGroup!)

Gets the View that will be shown in the PreferenceActivity.

Int getWidgetLayoutResource()

Gets the layout resource for the controllable widget portion of this Preference.

Boolean hasKey()

Checks whether this Preference has a valid key.

Boolean isEnabled()

Checks whether this Preference should be enabled in the list.

Boolean isIconSpaceReserved()

Gets whether the space this preference icon view is reserved.

Boolean isPersistent()

Checks whether this Preference is persistent. If it is, it stores its value(s) into the persistent SharedPreferences storage by default or into PreferenceDataStore if assigned.

Boolean isRecycleEnabled()

Checks whether this Preference has enabled to have its view recycled when used in the list view.

Boolean isSelectable()

Checks whether this Preference should be selectable in the list.

Boolean isSingleLineTitle()

Gets whether the title of this preference is constrained to a single line.

Unit notifyChanged()

Should be called when the data of this Preference has changed.

Unit notifyDependencyChange(disableDependents: Boolean)

Notifies any listening dependents of a change that affects the dependency.

Unit notifyHierarchyChanged()

Should be called when a Preference has been added/removed from this group, or the ordering should be re-evaluated.

Unit 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.

Unit onAttachedToHierarchy(preferenceManager: PreferenceManager!)

Called when this Preference has been attached to a Preference hierarchy. Make sure to call the super implementation.

Unit onBindView(view: View!)

Binds the created View to the data for this Preference.

This is a good place to grab references to custom Views in the layout and set properties on them.

Make sure to call through to the superclass's implementation.
If you override this method you must call through to the superclass implementation.

View! onCreateView(parent: ViewGroup!)

Creates the View to be shown for this Preference in the PreferenceActivity. The default behavior is to inflate the main layout of this Preference (see setLayoutResource(int). If changing this behavior, please specify a ViewGroup with ID android.R.id#widget_frame.

Make sure to call through to the superclass's implementation.
If you override this method you must call through to the superclass implementation.

Unit onDependencyChanged(dependency: Preference!, disableDependent: Boolean)

Called when the dependency changes.

Unit onParentChanged(parent: Preference!, disableChild: Boolean)

Called when the implicit parent dependency changes.

Unit 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.
If you override this method you must call through to the superclass implementation.

Bundle! peekExtras()

Return the extras Bundle object associated with this preference, returning null if there is not currently one.

Boolean persistBoolean(value: Boolean)

Attempts to persist a boolean if this Preference is persistent.

Boolean persistFloat(value: Float)

Attempts to persist a long if this Preference is persistent.

Boolean persistInt(value: Int)

Attempts to persist an int if this Preference is persistent.

Boolean persistLong(value: Long)

Attempts to persist a long if this Preference is persistent.

Boolean persistString(value: String!)

Attempts to persist a String if this Preference is persistent.

Boolean persistStringSet(values: MutableSet<String!>!)

Attempts to persist a set of Strings if this Preference is persistent.

Unit restoreHierarchyState(container: Bundle!)

Restore this Preference hierarchy's previously saved state from the given container.

Unit saveHierarchyState(container: Bundle!)

Store this Preference hierarchy's frozen state into the given container.

Unit setDefaultValue(defaultValue: Any!)

Sets the default value for this Preference, which will be set either if persistence is off or persistence is on and the preference is not found in the persistent storage.

Unit setDependency(dependencyKey: String!)

Sets the key of a Preference that this Preference will depend on. If that Preference is not set or is off, this Preference will be disabled.

Unit setEnabled(enabled: Boolean)

Sets whether this Preference is enabled. If disabled, it will not handle clicks.

Unit setFragment(fragment: String!)

Sets the class name of a fragment to be shown when this Preference is clicked.

Unit setIcon(icon: Drawable!)

Sets the icon for this Preference with a Drawable. This icon will be placed into the ID android.R.id#icon within the View created by onCreateView(ViewGroup).

Unit setIcon(iconResId: Int)

Sets the icon for this Preference with a resource ID.

Unit setIconSpaceReserved(iconSpaceReserved: Boolean)

Sets whether to reserve the space of this Preference icon view when no icon is provided.

Unit setIntent(intent: Intent!)

Sets an Intent to be used for Context.startActivity(Intent) when this Preference is clicked.

Unit setKey(key: String!)

Sets the key for this Preference, which is used as a key to the SharedPreferences or PreferenceDataStore. This should be unique for the package.

Unit setLayoutResource(layoutResId: Int)

Sets the layout resource that is inflated as the View to be shown for this Preference. In most cases, the default layout is sufficient for custom Preference objects and only the widget layout needs to be changed.

This layout should contain a ViewGroup with ID android.R.id#widget_frame to be the parent of the specific widget for this Preference. It should similarly contain android.R.id#title and android.R.id#summary.

Unit setOnPreferenceChangeListener(onPreferenceChangeListener: Preference.OnPreferenceChangeListener!)

Sets the callback to be invoked when this Preference is changed by the user (but before the internal state has been updated).

Unit setOnPreferenceClickListener(onPreferenceClickListener: Preference.OnPreferenceClickListener!)

Sets the callback to be invoked when this Preference is clicked.

Unit setOrder(order: Int)

Sets the order of this Preference with respect to other Preference objects on the same level. If this is not specified, the default behavior is to sort alphabetically. The PreferenceGroup.setOrderingAsAdded(boolean) can be used to order Preference objects based on the order they appear in the XML.

Unit setPersistent(persistent: Boolean)

Sets whether this Preference is persistent. When persistent, it stores its value(s) into the persistent SharedPreferences storage by default or into PreferenceDataStore if assigned.

Unit setPreferenceDataStore(dataStore: PreferenceDataStore!)

Sets a PreferenceDataStore to be used by this Preference instead of using android.content.SharedPreferences.

The data store will remain assigned even if the Preference is moved around the preference hierarchy. It will also override a data store propagated from the PreferenceManager that owns this Preference.

Unit setRecycleEnabled(enabled: Boolean)

Sets whether this Preference has enabled to have its view recycled when used in the list view. By default the recycling is enabled.

The value can be changed only before this preference is added to the preference hierarchy.

If view recycling is not allowed then each time the list view populates this preference the getView(View,ViewGroup) method receives a null convert view and needs to recreate the view. Otherwise view gets recycled and only onBindView(View) gets called.
If you override this method you must call through to the superclass implementation.

Unit setSelectable(selectable: Boolean)

Sets whether this Preference is selectable.

Unit setShouldDisableView(shouldDisableView: Boolean)

Sets whether this Preference should disable its view when it gets disabled.

For example, set this and setEnabled(boolean) to false for preferences that are only displaying information and 1) should not be clickable 2) should not have the view set to the disabled state.

Unit setSingleLineTitle(singleLineTitle: Boolean)

Sets whether to constrain the title of this Preference to a single line instead of letting it wrap onto multiple lines.

Unit setSummary(summaryResId: Int)

Sets the summary for this Preference with a resource ID.

Unit setSummary(summary: CharSequence!)

Sets the summary for this Preference with a CharSequence.

Unit setTitle(titleResId: Int)

Sets the title for this Preference with a resource ID.

Unit setTitle(title: CharSequence!)

Sets the title for this Preference with a CharSequence. This title will be placed into the ID android.R.id#title within the View created by onCreateView(ViewGroup).

Unit setWidgetLayoutResource(widgetLayoutResId: Int)

Sets the layout for the controllable widget portion of this Preference. This is inflated into the main layout. For example, a CheckBoxPreference would specify a custom layout (consisting of just the CheckBox) here, instead of creating its own main layout.

Boolean shouldCommit()

Returns whether the Preference should commit its saved value(s) in getEditor(). This may return false in situations where batch committing is being done (by the manager) to improve performance.

If this preference is using PreferenceDataStore this value is irrelevant.

Boolean shouldPersist()

Checks whether, at the given time this method is called, this Preference should store/restore its value(s) into the SharedPreferences or into PreferenceDataStore if assigned. This, at minimum, checks whether this Preference is persistent and it currently has a key. Before you save/restore from the storage, check this first.

String toString()

Returns a string representation of the object.