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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
|
/*
* Copyright (C) 2007 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package android.widget;
import java.util.HashMap;
import java.util.Map;
import android.app.Service;
import android.content.Intent;
import android.os.IBinder;
import android.util.Pair;
import com.android.internal.widget.IRemoteViewsFactory;
/**
* The service to be connected to for a remote adapter to request RemoteViews. Users should
* extend the RemoteViewsService to provide the appropriate RemoteViewsFactory's used to
* populate the remote collection view (ListView, GridView, etc).
*/
public abstract class RemoteViewsService extends Service {
private static final String LOG_TAG = "RemoteViewsService";
// multimap implementation for reference counting
private HashMap<Intent.FilterComparison, Pair<RemoteViewsFactory, Integer>> mRemoteViewFactories;
private final Object mLock = new Object();
/**
* An interface for an adapter between a remote collection view (ListView, GridView, etc) and
* the underlying data for that view. The implementor is responsible for making a RemoteView
* for each item in the data set. This interface is a thin wrapper around {@link Adapter}.
*
* @see android.widget.Adapter
* @see android.appwidget.AppWidgetManager
*/
public interface RemoteViewsFactory {
/**
* Called when your factory is first constructed. The same factory may be shared across
* multiple RemoteViewAdapters depending on the intent passed.
*/
public void onCreate();
/**
* Called when notifyDataSetChanged() is triggered on the remote adapter. This allows a
* RemoteViewsFactory to respond to data changes by updating any internal references.
*
* Note: expensive tasks can be safely performed synchronously within this method. In the
* interim, the old data will be displayed within the widget.
*
* @see android.appwidget.AppWidgetManager#notifyAppWidgetViewDataChanged(int[], int)
*/
public void onDataSetChanged();
/**
* Called when the last RemoteViewsAdapter that is associated with this factory is
* unbound.
*/
public void onDestroy();
/**
* See {@link Adapter#getCount()}
*
* @return Count of items.
*/
public int getCount();
/**
* See {@link Adapter#getView(int, android.view.View, android.view.ViewGroup)}.
*
* Note: expensive tasks can be safely performed synchronously within this method, and a
* loading view will be displayed in the interim. See {@link #getLoadingView()}.
*
* @param position The position of the item within the Factory's data set of the item whose
* view we want.
* @return A RemoteViews object corresponding to the data at the specified position.
*/
public RemoteViews getViewAt(int position);
/**
* This allows for the use of a custom loading view which appears between the time that
* {@link #getViewAt(int)} is called and returns. If null is returned, a default loading
* view will be used.
*
* @return The RemoteViews representing the desired loading view.
*/
public RemoteViews getLoadingView();
/**
* See {@link Adapter#getViewTypeCount()}.
*
* @return The number of types of Views that will be returned by this factory.
*/
public int getViewTypeCount();
/**
* See {@link Adapter#getItemId(int)}.
*
* @param position The position of the item within the data set whose row id we want.
* @return The id of the item at the specified position.
*/
public long getItemId(int position);
/**
* See {@link Adapter#hasStableIds()}.
*
* @return True if the same id always refers to the same object.
*/
public boolean hasStableIds();
}
/**
* A private proxy class for the private IRemoteViewsFactory interface through the
* public RemoteViewsFactory interface.
*/
private class RemoteViewsFactoryAdapter extends IRemoteViewsFactory.Stub {
public RemoteViewsFactoryAdapter(RemoteViewsFactory factory) {
mFactory = factory;
}
public synchronized void onDataSetChanged() {
mFactory.onDataSetChanged();
}
public synchronized int getCount() {
return mFactory.getCount();
}
public synchronized RemoteViews getViewAt(int position) {
RemoteViews rv = mFactory.getViewAt(position);
rv.setIsWidgetCollectionChild(true);
return rv;
}
public synchronized RemoteViews getLoadingView() {
return mFactory.getLoadingView();
}
public synchronized int getViewTypeCount() {
return mFactory.getViewTypeCount();
}
public synchronized long getItemId(int position) {
return mFactory.getItemId(position);
}
public synchronized boolean hasStableIds() {
return mFactory.hasStableIds();
}
private RemoteViewsFactory mFactory;
}
public RemoteViewsService() {
mRemoteViewFactories =
new HashMap<Intent.FilterComparison, Pair<RemoteViewsFactory, Integer>>();
}
@Override
public IBinder onBind(Intent intent) {
synchronized (mLock) {
// increment the reference count to the particular factory associated with this intent
Intent.FilterComparison fc = new Intent.FilterComparison(intent);
Pair<RemoteViewsFactory, Integer> factoryRef = null;
RemoteViewsFactory factory = null;
if (!mRemoteViewFactories.containsKey(fc)) {
factory = onGetViewFactory(intent);
factoryRef = new Pair<RemoteViewsFactory, Integer>(factory, 1);
mRemoteViewFactories.put(fc, factoryRef);
factory.onCreate();
} else {
Pair<RemoteViewsFactory, Integer> oldFactoryRef = mRemoteViewFactories.get(fc);
factory = oldFactoryRef.first;
int newRefCount = oldFactoryRef.second.intValue() + 1;
factoryRef = new Pair<RemoteViewsFactory, Integer>(oldFactoryRef.first, newRefCount);
mRemoteViewFactories.put(fc, factoryRef);
}
return new RemoteViewsFactoryAdapter(factory);
}
}
@Override
public boolean onUnbind(Intent intent) {
synchronized (mLock) {
Intent.FilterComparison fc = new Intent.FilterComparison(intent);
if (mRemoteViewFactories.containsKey(fc)) {
// this alleviates the user's responsibility of having to clear all factories
Pair<RemoteViewsFactory, Integer> oldFactoryRef =
mRemoteViewFactories.get(fc);
int newRefCount = oldFactoryRef.second.intValue() - 1;
if (newRefCount <= 0) {
oldFactoryRef.first.onDestroy();
mRemoteViewFactories.remove(fc);
} else {
Pair<RemoteViewsFactory, Integer> factoryRef =
new Pair<RemoteViewsFactory, Integer>(oldFactoryRef.first, newRefCount);
mRemoteViewFactories.put(fc, factoryRef);
}
}
}
return super.onUnbind(intent);
}
/**
* To be implemented by the derived service to generate appropriate factories for
* the data.
*/
public abstract RemoteViewsFactory onGetViewFactory(Intent intent);
}
|