Annotation helpers for PreferenceActivity and PreferenceFragment #1162

WonderCsabo · 2014-09-24T11:03:24Z

This PR is a WIP, and related to #7.

I decided to use resource IDs instead of plain string preference keys in the annotations, since this is the suggested way (if you use a string resource as a key, you can use it both in java and xml). Also the implementation is easier, since we can rely on existing concepts.

The implementation is basically the same as View injection/listener. Currently there is some code duplication, but i am not sure we should remove that, because it would really obfuscate the intent of the code. But i gladly accept suggestions on that.

@yDelouis, @DayS, @dodgex i would appreciate your feedback.

dodgex · 2014-09-24T11:41:24Z

...annotations/src/main/java/org/androidannotations/holder/EComponentWithViewSupportHolder.java

+	public JInvocation findPreferenceByKey(JFieldRef idRef) {
+		JInvocation getString = invoke(_this(), "getString").arg(idRef);
+		JInvocation findPreferenceByKey = invoke(_this(), "findPreference");
+		findPreferenceByKey.arg(getString);


i would return on this line. not sure how to explain why, but it feels more clean for me.

dodgex · 2014-09-24T11:47:00Z

from a quick read it looks ok so far.

WonderCsabo · 2014-09-24T21:32:43Z

Functionality is done. Tests and javadoc is for the next day...
Until that, please take a look at it, guys.

dodgex · 2014-09-25T06:07:56Z

...ions/androidannotations/src/main/java/org/androidannotations/handler/AnnotationHandlers.java


 		add(new IgnoredWhenDetachedHandler(processingEnvironment));
 		/* After injection methods must be after injections */
 		add(new AfterInjectHandler(processingEnvironment));
 		add(new AfterExtrasHandler(processingEnvironment));
 		add(new AfterViewsHandler(processingEnvironment));
+		add(new AfterPreferencesHandler(processingEnvironment));


just a note that we keep in mind to update the wiki #1157

WonderCsabo · 2014-09-25T13:12:58Z

I updated PreferenceScreenHandler, because in case of Fragments addPreferencesFromResource cannot be called in init body. The reason for that is in that case, addPreferencesFromResource must be called after super.onCreate().

And another thing: @PreferenceHeaders automatically adds the headers, but from API 19 and up, another method also must be overriden. We could generate the method from the header xml, but i am not sure to do it, since this is a security feature.

WonderCsabo · 2014-09-25T17:29:54Z

...androidannotations/src/main/java/org/androidannotations/handler/PreferenceChangeHandler.java

+			if (variableElement.asType().toString().equals(CanonicalNameConstants.PREFERENCE)) {
+				call.arg(preferenceParam);
+			} else if (variableElement.asType().toString().equals(CanonicalNameConstants.OBJECT)) {
+				call.arg(newValueParam);


I am just trying this PR in a real app. I think we could further help the user, if we not just allow Object here, but any type which can be a preference. So the client do not have to cast the parameter, we could do that instead of him.
For the built-in Android Preference classes, these types can be in the newValue parameter:

String (EditTextPreference, ListPreference, RingtonePreference)

Set (MultiSelectListPreference)

Boolean (CheckBoxPreference, RingtonePreference)

I implemented this.

WonderCsabo · 2014-09-30T10:35:06Z

@yDelouis, if you can take a quick look at this, i will start tests and javadoc if you find this ok.

yDelouis · 2014-10-04T14:39:10Z

...androidannotations/src/main/java/org/androidannotations/handler/PreferenceChangeHandler.java

+		for (VariableElement variableElement : userParameters) {
+			if (variableElement.asType().toString().equals(CanonicalNameConstants.PREFERENCE)) {
+				call.arg(preferenceParam);
+			} else {


Why don't you use else if ? It would remove one level of indentation.

Good question.

WonderCsabo · 2014-10-05T17:12:08Z

Rebased onto develop.

WonderCsabo · 2014-10-29T18:05:15Z

I rebased onto develop again.

@yDelouis can you just review this quickly? If it is basically OK, i'll write tests and JavaDoc.

dodgex · 2014-11-20T14:19:09Z

i had some time to read through the changes. i haven't found anything bad. but i had no chance yet to test it in an app. but you started this as you need it in your app, so i think that you are testing it that way. :P

WonderCsabo · 2014-11-20T14:21:52Z

Thanks!
Yes, this is already working in my current project, this still needs a CR.
But i think i'll write the JavaDocs, because that may not change.

dodgex · 2014-11-20T14:27:29Z

What does CR mean?

WonderCsabo · 2014-11-20T14:40:10Z

Code review.

WonderCsabo · 2014-11-21T18:36:42Z

I added JavaDocs and tests.

So now it can be used for other types of listeners then View listeners. For View listeners, a new subclass, AbstractViewListenerHandler is created.

Annotation helpers for PreferenceActivity and PreferenceFragment

yDelouis · 2015-04-25T16:15:57Z

It's okay.
Thanks for having applied the requested modifications.

dodgex · 2015-04-30T05:21:02Z

duh. i just found that this PR got merged and wanted to update the pref branch in my app and while testing i found a little problem. while this might be working as intended, we may want to reconsider this.

case: i have some @PreferenceChange annotated methods. here i update e.g. the summary based on the new value. but now i realized that this annotation uses preference.setOnPreferenceChangeListener() to trigger the method what brings me to my problem, this callback is called on change, but BEFORE the change is persisted

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

i think it would be nice to have both. a callback before and one after. before using these annotations i used getPreferenceScreen().getSharedPreferences().registerOnSharedPreferenceChangeListener(this); and implemented OnSharedPreferenceChangeListener.

i have another feature branch where i need the post change callback even more as i need to do some logic and fire some events.

WonderCsabo · 2015-04-30T07:24:32Z

@dodgex i used this listener intentionally. This gives a chance to act before the value is persisted. The value will be persisted after it anyway. So why would you need OnSharedPreferenceChangeListener? If the preference is not registered after @PreferenceChange, you have bigger problems, and that should never happen actually.

dodgex · 2015-04-30T07:32:03Z

in one of my listener i update the summary based on the new value and in another one i even update another preference and fire an event with the new pref value.

WonderCsabo · 2015-04-30T07:34:01Z

Can you give more detail? I really do not understand why you cannot use current @PreferenceChange for that.

dodgex · 2015-04-30T07:44:23Z

currently i do something like this

ListPreference pref = (ListPreference) findPreference(key);
if (pref != null) {
    pref.setSummary(pref.getEntry());
}

where findPreference(key) could be replaced by the Preference param of the annotated method. the problem is, that getEntry() returns the previous value not the new one. so if i e.g. have "world" selected and change the selection to "hello" i would still get "world" as summary. and then if i change it again (to something else) i would get "hello" as summary and not the new one.

WonderCsabo · 2015-04-30T07:49:24Z

@PreferenceChange is passing you the new value.

dodgex · 2015-04-30T07:51:51Z

Argh! Damn. :/ @dodgex RTFM!

@WonderCsabo Thank you. Nice Work! 👍

WonderCsabo force-pushed the 7_preferenceScreen branch from 52c28f6 to b48c0a0 Compare September 24, 2014 11:07

dodgex reviewed Sep 24, 2014
View reviewed changes

WonderCsabo force-pushed the 7_preferenceScreen branch 3 times, most recently from 79fec41 to 11e8d24 Compare September 24, 2014 21:27

dodgex reviewed Sep 25, 2014
View reviewed changes

WonderCsabo force-pushed the 7_preferenceScreen branch 2 times, most recently from a57af5e to 7946a5a Compare September 25, 2014 13:09

WonderCsabo reviewed Sep 25, 2014
View reviewed changes

WonderCsabo force-pushed the 7_preferenceScreen branch 4 times, most recently from 1996920 to 0ab7830 Compare September 25, 2014 20:52

yDelouis force-pushed the develop branch from c478f13 to 2773a13 Compare October 3, 2014 15:18

yDelouis reviewed Oct 4, 2014
View reviewed changes

WonderCsabo force-pushed the 7_preferenceScreen branch from 0ab7830 to 888dfa2 Compare October 5, 2014 17:11

WonderCsabo force-pushed the 7_preferenceScreen branch from 888dfa2 to 2bd6dfe Compare October 29, 2014 18:02

WonderCsabo force-pushed the 7_preferenceScreen branch from ec0559f to a33fa99 Compare November 21, 2014 18:35

WonderCsabo added 12 commits April 17, 2015 09:59

Add @PreferenceChange

54dbcbe

Refactor AbstractListenerHandler

9e73bc6

So now it can be used for other types of listeners then View listeners. For View listeners, a new subclass, AbstractViewListenerHandler is created.

Implement PreferenceChangeHandler

fc08a40

Add @PreferenceClick

38eb04f

Implement PreferenceClickHandler

81cef78

Add @AfterPreferences

b9b9b70

Implement AfterPreferencesHandler

cc84769

Add @PreferenceHeaders

f692e93

Implement PreferenceHeadersHandler

8ac3e84

Allow more then 100 methods in ValitorHelper with Checkstyle

2f2e544

Add JavaDoc for new @PreferenceXXX annotations

502a555

Add tests for @PreferenceXXX annotations

2064edf

WonderCsabo force-pushed the 7_preferenceScreen branch from 9525b8b to 2064edf Compare April 17, 2015 08:00

yDelouis added a commit that referenced this pull request Apr 25, 2015

Merge pull request #1162 from WonderCsabo/7_preferenceScreen

128a851

Annotation helpers for PreferenceActivity and PreferenceFragment

yDelouis merged commit 128a851 into androidannotations:develop Apr 25, 2015

yDelouis added this to the 3.3 milestone Apr 25, 2015

WonderCsabo added the WikiUpdateNeeded label Apr 28, 2015

WonderCsabo deleted the 7_preferenceScreen branch April 28, 2015 21:31

WonderCsabo removed the WikiUpdateNeeded label May 3, 2015

WonderCsabo restored the 7_preferenceScreen branch May 9, 2015 10:51

WonderCsabo deleted the 7_preferenceScreen branch May 9, 2015 10:52

slandelle unassigned yDelouis Oct 9, 2016

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Annotation helpers for PreferenceActivity and PreferenceFragment #1162

Annotation helpers for PreferenceActivity and PreferenceFragment #1162

WonderCsabo commented Sep 24, 2014

dodgex Sep 24, 2014

WonderCsabo Sep 24, 2014

dodgex commented Sep 24, 2014

WonderCsabo commented Sep 24, 2014

dodgex Sep 25, 2014

WonderCsabo commented Sep 25, 2014

WonderCsabo Sep 25, 2014

WonderCsabo Sep 25, 2014

WonderCsabo commented Sep 30, 2014

yDelouis Oct 4, 2014

WonderCsabo Oct 4, 2014

WonderCsabo Oct 5, 2014

WonderCsabo commented Oct 5, 2014

WonderCsabo commented Oct 29, 2014

dodgex commented Nov 20, 2014

WonderCsabo commented Nov 20, 2014

dodgex commented Nov 20, 2014

WonderCsabo commented Nov 20, 2014

WonderCsabo commented Nov 21, 2014

yDelouis commented Apr 25, 2015

dodgex commented Apr 30, 2015

WonderCsabo commented Apr 30, 2015

dodgex commented Apr 30, 2015

WonderCsabo commented Apr 30, 2015

dodgex commented Apr 30, 2015

WonderCsabo commented Apr 30, 2015

dodgex commented Apr 30, 2015

Annotation helpers for PreferenceActivity and PreferenceFragment #1162

Annotation helpers for PreferenceActivity and PreferenceFragment #1162

Conversation

WonderCsabo commented Sep 24, 2014

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dodgex commented Sep 24, 2014

WonderCsabo commented Sep 24, 2014

Choose a reason for hiding this comment

WonderCsabo commented Sep 25, 2014

Choose a reason for hiding this comment

Choose a reason for hiding this comment

WonderCsabo commented Sep 30, 2014

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

WonderCsabo commented Oct 5, 2014

WonderCsabo commented Oct 29, 2014

dodgex commented Nov 20, 2014

WonderCsabo commented Nov 20, 2014

dodgex commented Nov 20, 2014

WonderCsabo commented Nov 20, 2014

WonderCsabo commented Nov 21, 2014

yDelouis commented Apr 25, 2015

dodgex commented Apr 30, 2015

WonderCsabo commented Apr 30, 2015

dodgex commented Apr 30, 2015

WonderCsabo commented Apr 30, 2015

dodgex commented Apr 30, 2015

WonderCsabo commented Apr 30, 2015

dodgex commented Apr 30, 2015