aboutsummaryrefslogtreecommitdiffstats
path: root/main/src/cgeo/geocaching/sorting/SortActionProvider.java
blob: 62519849b0db185912ffcde125d6dbdb583443e0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
package cgeo.geocaching.sorting;

import cgeo.geocaching.R;
import cgeo.geocaching.utils.Log;

import org.eclipse.jdt.annotation.NonNull;

import rx.functions.Action1;

import android.content.Context;
import android.support.v4.view.ActionProvider;
import android.view.MenuItem;
import android.view.MenuItem.OnMenuItemClickListener;
import android.view.SubMenu;
import android.view.View;

import java.util.ArrayList;
import java.util.Collections;
import java.util.Comparator;

/**
 * Provides a sub menu for sorting caches. Register your listener in the onCreateOptionsMenu of the containing activity.
 *
 */
public class SortActionProvider extends ActionProvider implements OnMenuItemClickListener {

    private static final int MENU_GROUP = 1;
    private final Context mContext;
    private final ArrayList<ComparatorEntry> registry = new ArrayList<>(20);
    /**
     * Callback triggered on selecting a new sort order.
     */
    private Action1<CacheComparator> onClickListener;
    /**
     * Currently selected filter. Used for radio button indication.
     */
    private CacheComparator selection;

    private static final class ComparatorEntry {
        private final String name;
        private final Class<? extends CacheComparator> cacheComparator;

        public ComparatorEntry(final String name, final Class<? extends CacheComparator> cacheComparator) {
            this.name = name;
            this.cacheComparator = cacheComparator;
        }

        @Override
        public String toString() {
            return name;
        }
    }

    public SortActionProvider(final Context context) {
        super(context);
        mContext = context;
        registerComparators();
    }

    private void register(final int resourceId, final Class<? extends CacheComparator> comparatorClass) {
        registry.add(new ComparatorEntry(mContext.getString(resourceId), comparatorClass));
    }

    private void registerComparators() {
        register(R.string.caches_sort_distance, DistanceComparator.class);
        register(R.string.caches_sort_date_hidden, DateComparator.class);
        register(R.string.caches_sort_difficulty, DifficultyComparator.class);
        register(R.string.caches_sort_finds, FindsComparator.class);
        register(R.string.caches_sort_geocode, GeocodeComparator.class);
        register(R.string.caches_sort_inventory, InventoryComparator.class);
        register(R.string.caches_sort_name, NameComparator.class);
        register(R.string.caches_sort_favorites, PopularityComparator.class);
        register(R.string.caches_sort_favorites_ratio, PopularityRatioComparator.class);
        register(R.string.caches_sort_rating, RatingComparator.class);
        register(R.string.caches_sort_size, SizeComparator.class);
        register(R.string.caches_sort_state, StateComparator.class);
        register(R.string.caches_sort_storage, StorageTimeComparator.class);
        register(R.string.caches_sort_terrain, TerrainComparator.class);
        register(R.string.caches_sort_date_logged, VisitComparator.class);
        register(R.string.caches_sort_vote, VoteComparator.class);

        // sort the menu labels alphabetically for easier reading
        Collections.sort(registry, new Comparator<ComparatorEntry>() {

            @Override
            public int compare(final ComparatorEntry lhs, final ComparatorEntry rhs) {
                return lhs.name.compareToIgnoreCase(rhs.name);
            }
        });
    }

    @Override
    public View onCreateActionView(){
        // must return null, otherwise onPrepareSubMenu is not called
        return null;
    }

    @Override
    public boolean hasSubMenu(){
        return true;
    }

    @Override
    public void onPrepareSubMenu(final SubMenu subMenu){
        subMenu.clear();
        for (int i = 0; i < registry.size(); i++) {
            final ComparatorEntry comparatorEntry = registry.get(i);
            final MenuItem menuItem = subMenu.add(MENU_GROUP, i, i, comparatorEntry.name);
            menuItem.setOnMenuItemClickListener(this).setCheckable(true);
            if (selection == null) {
                if (comparatorEntry.cacheComparator == null) {
                    menuItem.setChecked(true);
                }
            }
            else {
                if (selection.getClass().equals(comparatorEntry.cacheComparator)) {
                    menuItem.setChecked(true);
                }
            }
        }
        subMenu.setGroupCheckable(MENU_GROUP, true, true);
    }

    @Override
    public boolean onMenuItemClick(final MenuItem item){
        callListener(registry.get(item.getItemId()).cacheComparator);
        return true;
    }

    private void callListener(final Class<? extends CacheComparator> cacheComparator) {
        try {
            if (cacheComparator == null) {
                onClickListener.call(null);
            }
            else {
                final CacheComparator comparator = cacheComparator.newInstance();
                onClickListener.call(comparator);
            }
        } catch (final InstantiationException e) {
            Log.e("selectComparator", e);
        } catch (final IllegalAccessException e) {
            Log.e("selectComparator", e);
        }
    }

    public void setClickListener(final @NonNull Action1<CacheComparator> onClickListener) {
        this.onClickListener = onClickListener;
    }

    public void setSelection(final CacheComparator selection) {
        this.selection = selection;
    }
}