EditTextPreference.SimpleSummaryProvider

Artifact: androidx.preference:preference

View Source

Added in 1.1.0

---

Kotlin |Java

class EditTextPreference.SimpleSummaryProvider : Preference.SummaryProvider

---

A simple androidx.preference.Preference.SummaryProvider implementation for an EditTextPreference. If no value has been set, the summary displayed will be 'Not set', otherwise the summary displayed will be the value set for this preference.

Summary

Public functions
java-static EditTextPreference.SimpleSummaryProvider	getInstance() Retrieve a singleton instance of this simple androidx.preference.Preference.SummaryProvider implementation.
CharSequence?	provideSummary(preference: EditTextPreference) Called whenever getSummary is called on this preference.

Public functions

getInstance

Added in 1.1.0

java-static fun getInstance(): EditTextPreference.SimpleSummaryProvider

Retrieve a singleton instance of this simple androidx.preference.Preference.SummaryProvider implementation.

Returns
EditTextPreference.SimpleSummaryProvider	a singleton instance of this simple androidx.preference.Preference.SummaryProvider implementation

provideSummary

Added in 1.1.0

fun provideSummary(preference: EditTextPreference): CharSequence?

Called whenever getSummary is called on this preference.

Parameters
preference: EditTextPreference	This preference

Returns
CharSequence?	A CharSequence that will be displayed as the summary for this preference