de.mrapp.android.preference

Class SwitchPreference

java.lang.Object

androidx.preference.Preference

de.mrapp.android.preference.Preference

de.mrapp.android.preference.AbstractTwoStatePreference

de.mrapp.android.preference.AbstractCompoundButtonPreference

de.mrapp.android.preference.SwitchPreference

All Implemented Interfaces:

android.widget.Checkable

public class SwitchPreference
extends AbstractCompoundButtonPreference

A preference, which provides a two-state toggleable option using a SwitchCompat widget.

Since:

1.4.0

Nested Class Summary

Nested classes/interfaces inherited from class de.mrapp.android.preference.AbstractTwoStatePreference

AbstractTwoStatePreference.SavedState

Constructor Summary

Constructors

Constructor and Description
SwitchPreference(android.content.Context context) Creates a new preference, which provides a two-state toggleable option using a SwitchCompat widget.
SwitchPreference(android.content.Context context, android.util.AttributeSet attributeSet) Creates a new preference, which provides a two-state toggleable option using a SwitchCompat widget.
SwitchPreference(android.content.Context context, android.util.AttributeSet attributeSet, int defaultStyle) Creates a new preference, which provides a two-state toggleable option using a SwitchCompat widget.
SwitchPreference(android.content.Context context, android.util.AttributeSet attributeSet, int defaultStyle, int defaultStyleResource) Creates a new preference, which provides a two-state toggleable option using a SwitchCompat widget.

Method Summary

Modifier and Type	Method and Description
java.lang.CharSequence	getSwitchTextOff() Returns the text, which is displayed on the preference's switch, when it is not checked.
java.lang.CharSequence	getSwitchTextOn() Returns the text, which is displayed on the preference's switch, when it is checked.
void	onBindViewHolder(PreferenceViewHolder holder)
void	setSwitchTextOff(java.lang.CharSequence switchTextOff) Sets the text, which should be displayed on the preference's switch, when it is not checked.
void	setSwitchTextOff(int resourceId) Sets the text, which should be displayed on the preference's switch, when it is not checked.
void	setSwitchTextOn(java.lang.CharSequence switchTextOn) Sets the text, which should be displayed on the preference's switch, when it is checked.
void	setSwitchTextOn(int resourceId) Sets the text, which should be displayed on the preference's switch, when it is checked.

Methods inherited from class de.mrapp.android.preference.AbstractCompoundButtonPreference

onCheckedChanged

Methods inherited from class de.mrapp.android.preference.AbstractTwoStatePreference

getDisableDependentsState, getSummary, getSummaryOff, getSummaryOn, isChecked, onClick, onGetDefaultValue, onRestoreInstanceState, onSaveInstanceState, onSetInitialValue, performClick, setChecked, setDisableDependentsState, setSummaryOff, setSummaryOff, setSummaryOn, setSummaryOn, shouldDisableDependents, toggle

Methods inherited from class de.mrapp.android.preference.Preference

getIconTintList, getIconTintMode, setIcon, setIconTint, setIconTintList, setIconTintMode

Methods inherited from class java.lang.Object

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

Constructor Detail

SwitchPreference

public SwitchPreference(android.content.Context context)

Creates a new preference, which provides a two-state toggleable option using a SwitchCompat widget.

Parameters:

context - The context, which should be used by the preference, as an instance of the class Context. The context may not be null

SwitchPreference

public SwitchPreference(android.content.Context context,
                        android.util.AttributeSet attributeSet)

Creates a new preference, which provides a two-state toggleable option using a SwitchCompat widget.

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

SwitchPreference

public SwitchPreference(android.content.Context context,
                        android.util.AttributeSet attributeSet,
                        int defaultStyle)

Creates a new preference, which provides a two-state toggleable option using a SwitchCompat widget.

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

SwitchPreference

public SwitchPreference(android.content.Context context,
                        android.util.AttributeSet attributeSet,
                        int defaultStyle,
                        int defaultStyleResource)

Creates a new preference, which provides a two-state toggleable option using a SwitchCompat widget.

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

getSwitchTextOn

public final java.lang.CharSequence getSwitchTextOn()

Returns the text, which is displayed on the preference's switch, when it is checked.

Returns:

The text, which is displayed on the preference's switch, when it is checked, as an instance of the type CharSequence or null, if no dedicated text is displayed when the preference's switch is checked

setSwitchTextOn

public final void setSwitchTextOn(java.lang.CharSequence switchTextOn)

Sets the text, which should be displayed on the preference's switch, when it is checked. The text should be very short - one word if possible.

Parameters:

switchTextOn - The text, which should be set, as an instance of the type CharSequence or null, if no dedicated text should be displayed when the preference's switch is checked

setSwitchTextOn

public final void setSwitchTextOn(int resourceId)

Sets the text, which should be displayed on the preference's switch, when it is checked. The text should be very short - one word if possible.

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

getSwitchTextOff

public final java.lang.CharSequence getSwitchTextOff()

Returns the text, which is displayed on the preference's switch, when it is not checked.

Returns:

The text, which is displayed on the preference's switch, when it is not checked, as an instance of the type CharSequence or null, if no dedicated text is displayed when the preference's switch is not checked

setSwitchTextOff

public final void setSwitchTextOff(java.lang.CharSequence switchTextOff)

Sets the text, which should be displayed on the preference's switch, when it is not checked. The text should be very short - one word if possible.

Parameters:

switchTextOff - The text, which should be set, as an instance of the type CharSequence or null, if no dedicated text should be displayed when the preference's switch is not checked

setSwitchTextOff

public final void setSwitchTextOff(int resourceId)

Sets the text, which should be displayed on the preference's switch, when it is not checked. The text should be very short - one word if possible.

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

onBindViewHolder

public void onBindViewHolder(PreferenceViewHolder holder)

Overrides:

onBindViewHolder in class AbstractCompoundButtonPreference