B4A Library Preferences - Material Design Preferences

corwin42 · Jan 22, 2017

This library provides a framework to create nice looking Material Design Preferences down to API9. It uses this GitHub project to fix some bugs in the android support preferences stuff. It also adds some nice features like simple icon tinting, simple menu list preferences and a color picker.

For a guide on how to implement settings for Material Design read this.

Installation:

Extract all of the PreferencesLibX_XX.zip file to your additional libraries folder. These are .xml, .jar, 4 .aar files.
Requires AppCompat library.
Requires B4A 6.31+

minimum SDK Version: 14
Needs support library 27

If you are updating you can delete the old library aar files.

Your Support:

Creating libraries and wrappers for existing library projects is a lot of work. The use of this library is totally free and you even don't need to mention in your app that you use it.

But if you use this library in your projects and you think it is useful to you please consider to make a donation:

Thanks very much for your support.

Usage:

You need to use AppCompat Library together with this library.
Don't forget to add the Preference library to your project.

1. Enhance your theme in manifest editor
Add a preferenceTheme item and the two items for the IconTint:

B4X:

CreateResource(values, theme.xml,
<resources>
    <style name="MyAppTheme" parent="@style/Theme.AppCompat.Light.DarkActionBar">
        <item name="colorPrimary">#0098FF</item>
        <item name="colorPrimaryDark">#007CF5</item>
        <item name="colorAccent">#FF5522</item>
        <item name="windowNoTitle">true</item>
        <item name="windowActionBar">false</item>
        <item name="preferenceTheme">@style/PreferenceThemeOverlay.Material</item>
        <item name="asp_preferenceIconTint">?colorAccent</item>
        <item name="asp_preferenceDialogIconTint">?asp_preferenceIconTint</item>
        <item name="windowActionModeOverlay">true</item>
    </style>
</resources>
)

2. Extend from AppCompatPreferenceActivity

B4X:

#Extends: de.amberhome.preferences.AppCompatPreferenceActivity

3. Add PreferenceView to your Layout (with designer or by code)

4. Load the Layout in Activity_Create() as normal

5. Create your Preference elements in PreferenceView_Ready() event.

See the example for detailed usage.

The example has minSdkVersion set to 14. This is because the MaterialDateTimePicker needs this. The Preference library itself will work with a minimal SDK version of 9.

The example projects additionally needs MaterialDateTimePicker, XMLLayoutBuilder and DateUtils libraries.

Reference:

Preferences
Author: Markus Stipp
Version: 1.11

CheckBoxPreference
Events:

PreferenceChanged (Preference As Preference, NewValue As Object)

PreferenceClicked (Preference As Preference)

Methods:

Initialize (PreferenceView As PreferenceViewWrapper, EventName As String, Key As String, DefaultValue As Object)
Initializes the object

IsInitialized As Boolean

Properties:

Checked As Boolean

DefaultValue As Object [write only]

Dependency As String

DisableDependentsState As Boolean

Enabled As Boolean

Icon As Drawable

IconPaddingEnabled As Boolean [write only]

IconTintEnabled As Boolean [write only]

Intent As Intent

Key As String

Order As Int

Persistent As Boolean

Selectable As Boolean

Summary As String

SummaryOffText As CharSequence

SummaryOnText As CharSequence

SummaryTextColor As Int [write only]

Title As String

TitleTextColor As Int [write only]

Visible As Boolean

ColorPreference
Events:

PreferenceChanged (Preference As Preference, NewValue As Object)

PreferenceClicked (Preference As Preference)

Methods:

GetNameForColor (Color As Int) As CharSequence

Initialize (PreferenceView As PreferenceViewWrapper, EventName As String, Key As String, DefaultValue As Object)
Initializes the object

IsInitialized As Boolean

Properties:

Color As Int

ColorNames()() As CharSequence

ColorValues()() As Int

ColumnCount As Int

DefaultValue As Object [write only]

Dependency As String

DialogIcon As Drawable

DialogIconTintEnabled As Boolean [write only]

DialogTitle As CharSequence

Enabled As Boolean

Icon As Drawable

IconPaddingEnabled As Boolean [write only]

IconTintEnabled As Boolean [write only]

Intent As Intent

Key As String

NegativeButtonText As CharSequence

Order As Int

Persistent As Boolean

PositiveButtonText As CharSequence

Selectable As Boolean

Summary As String

SummaryTextColor As Int [write only]

SwatchSize As Int

Title As String

TitleTextColor As Int [write only]

Visible As Boolean

EditTextPreference
Events:

EditTextCreated (Edit As EditText)

PreferenceChanged (Preference As Preference, NewValue As Object)

PreferenceClicked (Preference As Preference)

Methods:

Initialize (PreferenceView As PreferenceViewWrapper, EventName As String, Key As String, DefaultValue As Object)
Initializes the object

IsInitialized As Boolean

Properties:

DefaultValue As Object [write only]

Dependency As String

DialogIcon As Drawable

DialogIconTintEnabled As Boolean [write only]

DialogMessage As CharSequence

DialogTitle As CharSequence

Enabled As Boolean

Icon As Drawable

IconPaddingEnabled As Boolean [write only]

IconTintEnabled As Boolean [write only]

Intent As Intent

Key As String

NegativeButtonText As CharSequence

Order As Int

Persistent As Boolean

PositiveButtonText As CharSequence

Selectable As Boolean

Summary As String

SummaryTextColor As Int [write only]

Text As String

Title As String

TitleTextColor As Int [write only]

Visible As Boolean

ListPreference
Events:

PreferenceChanged (Preference As Preference, NewValue As Object)

PreferenceClicked (Preference As Preference)

Fields:

MENU_MODE_DIALOG As Int

MENU_MODE_SIMPLE_ADAPTIVE As Int

MENU_MODE_SIMPLE_DIALOG As Int

MENU_MODE_SIMPLE_MENU As Int

Methods:

Initialize (PreferenceView As PreferenceViewWrapper, EventName As String, Key As String, DefaultValue As Object)
Initializes the object

IsInitialized As Boolean

Properties:

DefaultValue As Object [write only]

Dependency As String

DialogIcon As Drawable

DialogIconTintEnabled As Boolean [write only]

DialogTitle As CharSequence

Enabled As Boolean

Entries As Map

Icon As Drawable

IconPaddingEnabled As Boolean [write only]

IconTintEnabled As Boolean [write only]

Intent As Intent

Key As String

MenuMode As Int

NegativeButtonText As CharSequence

Order As Int

Persistent As Boolean

PositiveButtonText As CharSequence

Selectable As Boolean

SimpleMenuPreferredWidthUnit As Float

Summary As String

SummaryTextColor As Int [write only]

Title As String

TitleTextColor As Int [write only]

Value As String

Visible As Boolean

MultiSelectListPreference
Events:

PreferenceChanged (Preference As Preference, NewValue As List)

PreferenceClicked (Preference As Preference)

Methods:

Initialize (PreferenceView As PreferenceViewWrapper, EventName As String, Key As String, DefaultValue As List)
Initializes the object

IsInitialized As Boolean

Properties:

DefaultValue As Object [write only]

Dependency As String

DialogIcon As Drawable

DialogIconTintEnabled As Boolean [write only]

DialogTitle As CharSequence

Enabled As Boolean

Entries As Map

Icon As Drawable

Intent As Intent

Key As String

NegativeButtonText As CharSequence

Order As Int

Persistent As Boolean

PositiveButtonText As CharSequence

Selectable As Boolean

SelectedItems() As Boolean [read only]

Summary As String

Title As String

Values As List

Visible As Boolean

Preference
Events:

PreferenceChanged (Preference As Preference, NewValue As Object)

PreferenceClicked (Preference As Preference)

Methods:

Initialize (PreferenceView As PreferenceViewWrapper, EventName As String, Key As String, DefaultValue As Object)
Initializes the object

IsInitialized As Boolean

Properties:

DefaultValue As Object [write only]

Dependency As String

Enabled As Boolean

Icon As Drawable

Intent As Intent

Key As String

Order As Int

Persistent As Boolean

Selectable As Boolean

Summary As String

Title As String

Visible As Boolean

PreferenceCategory
Events:

PreferenceChanged (Preference As Preference, NewValue As Object)

PreferenceClicked (Preference As Preference)

Methods:

AddCategory (EventName As String, Key As String, Title As String) As PreferenceCategoryWrapper

AddCheckBoxPreference (EventName As String, Key As String, Title As String, SummaryOn As String, SummaryOff As String, Default As Boolean) As CheckBoxPreferenceWrapper

AddColorPreference (EventName As String, Key As String, Title As String, Summary As String, Default As Int, Colors() As Int, Names() As String) As ColorPreferenceWrapper

AddEditTextPreference (EventName As String, Key As String, Title As String, Summary As String, Default As String) As EditTextPreferenceWrapper

AddListPreference (EventName As String, Key As String, Title As String, Summary As String, Default As String, Values() As String, Texts() As String) As ListPreferenceWrapper

AddMultiSelectListPreference (EventName As String, Key As String, Title As String, Summary As String, Default As List, Values() As String, Texts() As String) As MultiSelectListPreferenceWrapper

AddPreference (Pref As Preference) As Boolean

AddSeekBarDialogPreference (EventName As String, Key As String, Title As String, Summary As String, Default As Int, Min As Int, Max As Int) As SeekBarDialogPreferenceWrapper

AddSeekBarPreference (EventName As String, Key As String, Title As String, Summary As String, Default As Int, Min As Int, Max As Int) As SeekBarPreferenceWrapper

AddSimplePreference (EventName As String, Key As String, Title As String, Summary As String, Default As String) As SimplePreferenceWrapper

AddSwitchPreference (EventName As String, Key As String, Title As String, SummaryOn As String, SummaryOff As String, Default As Boolean) As SwitchPreferenceWrapper

FindPreference (Key As String) As Preference

GetPreference (Index As Int) As Preference

Initialize (PreferenceView As PreferenceViewWrapper, EventName As String, Key As String, DefaultValue As Object)
Initializes the object

IsInitialized As Boolean

RemoveAll

RemovePreference (Pref As Preference)

Properties:

DefaultValue As Object [write only]

Dependency As String

Enabled As Boolean

Icon As Drawable

IconPaddingEnabled As Boolean [write only]

IconTintEnabled As Boolean [write only]

Intent As Intent

Key As String

Order As Int

Persistent As Boolean

PreferenceCount As Int [read only]

Selectable As Boolean

Summary As String

SummaryTextColor As Int [write only]

Title As String

TitleTextColor As Int [write only]

Visible As Boolean

PreferenceManager
Methods:

ClearAll
Clears all stored entries.

GetAll As Map
Returns a Map with all the Keys and Values. Note that changes to this map will not affect the stored values.

GetBoolean (Key As String) As Boolean
Returns the Boolean value mapped to the given key. Returns False if the key is not found.

GetBoolean2 (Key As String, Default As Boolean) As Boolean
Returns the Boolean value mapped to the given key. Returns the default value if the key is not found.

GetInt (Key As String) As Int

GetInt2 (Key As String, Default As Int) As Int

GetList (Key As String) As List

GetList2 (Key As String, Default As List) As List

GetLong (Key As String) As Long
Returns the Long value mapped to the given key. Returns -1 if the key is not found.

GetLong2 (Key As String, Default As Long) As Long
Returns the Long value mapped to the given key. Returns the default value if the key is not found.

GetString (Key As String) As String
Returns the String value mapped to the given key. Returns an empty string if the key is not found.

GetString2 (Key As String, Default As String) As String
Return the String value mapped to the given key. Returns the default value if the key is not found.

GetUpdatedKeys As List
Returns a list with the keys that were updated since the last call to GetUpdatedKeys.
Note that the updated keys may include keys with unchanged values.

SetBoolean (Key As String, Value As Boolean)
Maps the given key to the given Boolean value.

SetInt (Key As String, Value As Int)

SetList (Key As String, Values As List)
Maps the given key to the given List.

SetLong (Key As String, Value As Long)
Maps the given key to the given Long value.

SetString (Key As String, Value As String)
Maps the given key to the given String value.

PreferenceView
Events:

Ready (Preference As PreferenceView)

Methods:

AddCategory (EventName As String, Key As String, Title As String) As PreferenceCategoryWrapper

AddCheckBoxPreference (EventName As String, Key As String, Title As String, SummaryOn As String, SummaryOff As String, Default As Boolean) As CheckBoxPreferenceWrapper

AddColorPreference (EventName As String, Key As String, Title As String, Summary As String, Default As Int, Colors() As Int, Names() As String) As ColorPreferenceWrapper

AddEditTextPreference (EventName As String, Key As String, Title As String, Summary As String, Default As String) As EditTextPreferenceWrapper

AddListPreference (EventName As String, Key As String, Title As String, Summary As String, Default As String, Values() As String, Texts() As String) As ListPreferenceWrapper

AddMultiSelectListPreference (EventName As String, Key As String, Title As String, Summary As String, Default As List, Values() As String, Texts() As String) As MultiSelectListPreferenceWrapper

AddPreference (Pref As Preference)

AddSeekBarDialogPreference (EventName As String, Key As String, Title As String, Summary As String, Default As Int, Min As Int, Max As Int) As SeekBarDialogPreferenceWrapper

AddSeekBarPreference (EventName As String, Key As String, Title As String, Summary As String, Default As Int, Min As Int, Max As Int) As SeekBarPreferenceWrapper

AddSimplePreference (EventName As String, Key As String, Title As String, Summary As String, Default As String) As SimplePreferenceWrapper

AddSwitchPreference (EventName As String, Key As String, Title As String, SummaryOn As String, SummaryOff As String, Default As Boolean) As SwitchPreferenceWrapper

DesignerCreateView (base As PanelWrapper, lw As LabelWrapper, props As Map)

Initialize (EventName As String, Parent As ViewGroup)

SeekBarDialogPreference

Events:

PreferenceChanged (Preference As Preference, NewValue As Object)

PreferenceClicked (Preference As Preference)

Methods:

Initialize (PreferenceView As PreferenceViewWrapper, EventName As String, Key As String, DefaultValue As Object)
Initializes the object

IsInitialized As Boolean

Properties:

DefaultValue As Object [write only]

Dependency As String

DialogIcon As Drawable

DialogIconTintEnabled As Boolean [write only]

DialogMessage As CharSequence

DialogTitle As CharSequence

Enabled As Boolean

Icon As Drawable

IconPaddingEnabled As Boolean [write only]

IconTintEnabled As Boolean [write only]

Intent As Intent

Key As String

Max As Int

Min As Int

NegativeButtonText As CharSequence

Order As Int

Persistent As Boolean

PositiveButtonText As CharSequence

Progress As Int

Selectable As Boolean

Summary As String

SummaryTextColor As Int [write only]

Title As String

TitleTextColor As Int [write only]

Visible As Boolean

SeekBarPreference
Events:

PreferenceChanged (Preference As Preference, NewValue As Object)

PreferenceClicked (Preference As Preference)

ProgressChanged (Progress As Int, UserChanged As Boolean)

Methods:

Initialize (PreferenceView As PreferenceViewWrapper, EventName As String, Key As String, DefaultValue As Object)
Initializes the object

IsInitialized As Boolean

Properties:

Adjustable As Boolean

DefaultValue As Object [write only]

Dependency As String

Enabled As Boolean

Icon As Drawable

IconPaddingEnabled As Boolean [write only]

IconTintEnabled As Boolean [write only]

Info As CharSequence

Intent As Intent

Key As String

Max As Int

Min As Int

Order As Int

Persistent As Boolean

SeekBarIncrement As Int

Selectable As Boolean

ShowValue As Boolean

Summary As String

SummaryTextColor As Int [write only]

Title As String

TitleTextColor As Int [write only]

Value As Int

Visible As Boolean

SimplePreference
Events:

PreferenceChanged (Preference As Preference, NewValue As Object)

PreferenceClicked (Preference As Preference)

PreferenceLongClicked (Preference As Preference))

Methods:

Initialize (PreferenceView As PreferenceViewWrapper, EventName As String, Key As String, DefaultValue As Object)
Initializes the object

IsInitialized As Boolean

Properties:

DefaultValue As Object [write only]

Dependency As String

Enabled As Boolean

Icon As Drawable

IconPaddingEnabled As Boolean [write only]

IconTintEnabled As Boolean [write only]

Intent As Intent

Key As String

Order As Int

Persistent As Boolean

Selectable As Boolean

Summary As String

SummaryTextColor As Int [write only]

Title As String

TitleTextColor As Int [write only]

Visible As Boolean

SwitchPreference
Events:

PreferenceChanged (Preference As Preference, NewValue As Object)

PreferenceClicked (Preference As Preference)

Methods:

Initialize (PreferenceView As PreferenceViewWrapper, EventName As String, Key As String, DefaultValue As Object)
Initializes the object

IsInitialized As Boolean

Properties:

Checked As Boolean

DefaultValue As Object [write only]

Dependency As String

DisableDependentsState As Boolean

Enabled As Boolean

Icon As Drawable

IconPaddingEnabled As Boolean [write only]

IconTintEnabled As Boolean [write only]

Intent As Intent

Key As String

Order As Int

Persistent As Boolean

Selectable As Boolean

Summary As String

SummaryOffText As CharSequence

SummaryOnText As CharSequence

SummaryTextColor As Int [write only]

Title As String

TitleTextColor As Int [write only]

Visible As Boolean

History:
V1.00:

Initial version

V1.01:

Fix: Change packagename to anywheresoftware.b4a.orbjects to reduce resource fields

V1.10:

New: MultiSelectListPreference

V1.11

Fix: Removed DialogMessage property from dialogs with lists (not supported)
Fix: Added missing properties to MultiSelectPreference

V1.12

Fix: PreferenceCategory.AddMultiSelectListPreference() should work now
Fix: AddPreference() should work with all preferences
New: Added RemoveKey() to PreferenceManager
Fix: Remove internal resource files

V1.14

Fix: Fix crash on screen rotation
Fix: Updated to support-preferences library 1.2.7 (fixes crash with ringtone manager on Samsung devices, fixes memory leak)
New: Better support for CharSequences

V2.00

Fix: Updated to support-preferences library 2.2.0 (fixes crashes with support libraries 27)

V3.00

Fix: Should work with androidx support libraries.
Fix: Updated to support-prefernces library 3.0.0dev
Attention: Removed RingtonePreference since it is not supported by androidx support library anymore!

ToDo:

Currently there is nearly no popup help.

corwin42 · Jan 27, 2017

wimpie3 said:
@corwin42 - thanks for you work! This is exactly what I needed for my app. If you get MultiSelectListPreference working, you can expect a donation

Like this?

wimpie3 · Jan 27, 2017

OK, where can I download the latest version?

corwin42 · Jan 27, 2017

It will be released soon.

corwin42 · Jan 27, 2017

wimpie3 said:
OK, where can I download the latest version?

See the first post.

wimpie3 · Jan 27, 2017

Seems like when you use AddListPreference and set DialogMessage to show a text above the list items, the items are gone and only the message is shown. Could be like that in the original library, not sure.

wimpie3 · Jan 27, 2017

@corwin42 Thanks for the update. Unfortunately MultiSelectListPreference is missing some attributes like PositiveButtonText and NegativeButtonText (a must have for multilingual apps... AddListPreference has them, so again, I'm not sure if you left them out or if they are missing in the original library as well.

(edit: missing button texts on AddEditTextPreference as well)

corwin42 · Jan 27, 2017

wimpie3 said:
Seems like when you use AddListPreference and set DialogMessage to show a text above the list items, the items are gone and only the message is shown. Could be like that in the original library, not sure.

From the setDialogMessage() documentation:

Sets the message of the dialog. This will be shown on subsequent dialogs.

This message forms the content View of the dialog and conflicts with list-based dialogs, for example.

So this will not work with List based dialogs. I will remove the DialogMessage property from the list based preferences.

corwin42 · Jan 27, 2017

wimpie3 said:
@corwin42 Thanks for the update. Unfortunately MultiSelectListPreference is missing some attributes like PositiveButtonText and NegativeButtonText (a must have for multilingual apps... AddListPreference has them, so again, I'm not sure if you left them out or if they are missing in the original library as well.

Oops, I forgot the dialog methods in the wrapper for MultiSelectListPreference. I will add them.

Be aware that the default texts like "OK" and "'CANCEL" are localized by default.

(edit: missing button texts on AddEditTextPreference as well)

EditTextPreference has them. The AddXXXPreference methods only have the base parameters. If you need to set more you have to modify the preference after creation:

B4X:

    Dim etp As EditTextPreference
etp = PrefsView.AddEditTextPreference("Edit", "edittext1", "Sample EditText item", "Summary for the EditText", "123")
etp.NegativeButtonText="No way"
etp.DialogMessage="This is a message in the dialog"

Edit: If you find anything else that is missing, please post it. I will release a new version with the missing stuff later today.

wimpie3 · Jan 27, 2017

@corwin42 Thanks! Now waiting for the updated library...

(edit: no more remarks for now)

corwin42 · Jan 27, 2017

wimpie3 said:
@corwin42 Thanks! Now waiting for the updated library...

(edit: no more remarks for now)

Released in the first post. Hopefully all is working.

wimpie3 · Jan 30, 2017

corwin42 said:
Released in the first post. Hopefully all is working.

MultiSelectListPreference is giving problems on early API's. I've targeted to API 10 and the app is crashing (API25=no problem).

corwin42 · Jan 30, 2017

wimpie3 said:
MultiSelectListPreference is giving problems on early API's. I've targeted to API 10 and the app is crashing (API25=no problem).

Works as expected here (tested with emulator API 10). Do you have an error stack?

wimpie3 · Jan 31, 2017

The code I use is:

B4X:

Dim pv As MultiSelectListPreference
pv=cat1.AddMultiSelectListPreference("Multi", "multilist", "MultiSelectList Preference", "Select multiple Entries", Array As String("May"), Months, Months)

Crash log says:

B4X:

java.lang.ClassCastException: anywheresoftware.b4a.objects.collections.List cannot be cast to java.util.Set
    at net.xpece.android.support.preference.MultiSelectListPreference.onSetInitialValue(MultiSelectListPreference.java:195)

corwin42 · Jan 31, 2017

wimpie3 said:

The code I use is:

B4X:

Dim pv As MultiSelectListPreference
pv=cat1.AddMultiSelectListPreference("Multi", "multilist", "MultiSelectList Preference", "Select multiple Entries", Array As String("May"), Months, Months)

Crash log says:

B4X:

java.lang.ClassCastException: anywheresoftware.b4a.objects.collections.List cannot be cast to java.util.Set
    at net.xpece.android.support.preference.MultiSelectListPreference.onSetInitialValue(MultiSelectListPreference.java:195)

I see. Has nothing to do with API version. This is a bug in AddMultiSelectListPreference of the CategoryPreference.
I will fix it.

wimpie3 · Jan 31, 2017

@corwin42 Thanks... I have encountered another problem in the mean time.

B4X:

Dim sd_textarea As EditTextPreference
sd_textarea.Initialize(PrefsView,"sd_textarea","fieldName","defaultvalue")
PrefsView.AddPreference(sd_textarea)

This gives the following error:
java.lang.IllegalArgumentException: method de.amberhome.preferences.PreferenceViewWrapper.AddPreference argument 1 has type net.xpece.android.support.preference.Preference, got net.xpece.android.support.preference.EditTextPreference

Does this mean EditTextPreferences cannot be created by using Initialize?

corwin42 · Feb 1, 2017

wimpie3 said:
@corwin42Does this mean EditTextPreferences cannot be created by using Initialize?

I will check it. It should work.

corwin42 · Feb 1, 2017

Updated the library to V1.12 in the first post. It should fix all known problems and adds the possibility to remove a single key from the preferences.

johndb · Feb 13, 2017

Thank you again for this excellent library @corwin42. Is there any way to decrease the vertical spacing between the preferences and section labels?

corwin42 · Feb 14, 2017

Unfortunately not. I haven't found a way to change the margin.

wimpie3 · Feb 22, 2017

I have noticed something strange in MultiSelectListPreference. The first checkbox is shown immediately, but the others only after a small delay. Did you see this behaviour as well? So with three checkboxes you immediately see the first checkbox, but the second and third only appear after a (short!) waiting period. If ONLY the second and the third checkbox are selected and NOT the first one, the delay is still visible on those.

B4A Library Preferences - Material Design Preferences

Attachments

Expert

Well-Known Member

Expert

Expert

Well-Known Member

Well-Known Member

Expert

Expert

Well-Known Member

Expert

Well-Known Member

Expert

Well-Known Member

Expert

Well-Known Member

Expert

Expert

Active Member

Expert

Well-Known Member

Similar Threads

Privacy & Transparency

Privacy & Transparency