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
|
/*
* Copyright (C) 2006 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.gadget;
import android.content.BroadcastReceiver;
import android.content.Context;
import android.content.Intent;
import android.os.Bundle;
/**
* A conveience class to aid in implementing a gadget provider.
* Everything you can do with GadgetProvider, you can do with a regular {@link BroadcastReceiver}.
* GadgetProvider merely parses the relevant fields out of the Intent that is received in
* {@link #onReceive(Context,Intent) onReceive(Context,Intent)}, and calls hook methods
* with the received extras.
*
* <p>Extend this class and override one or more of the {@link #onUpdate}, {@link #onDeleted},
* {@link #onEnabled} or {@link #onDisabled} methods to implement your own gadget functionality.
*
* <h3>Sample Code</h3>
* For an example of how to write a gadget provider, see the
* <a href="{@toroot}reference/android/gadget/package-descr.html#providers">android.gadget
* package overview</a>.
*/
public class GadgetProvider extends BroadcastReceiver {
/**
* Constructor to initialize GadgetProvider.
*/
public GadgetProvider() {
}
/**
* Implements {@link BroadcastReceiver#onReceive} to dispatch calls to the various
* other methods on GadgetProvider.
*
* @param context The Context in which the receiver is running.
* @param intent The Intent being received.
*/
// BEGIN_INCLUDE(onReceive)
public void onReceive(Context context, Intent intent) {
// Protect against rogue update broadcasts (not really a security issue,
// just filter bad broacasts out so subclasses are less likely to crash).
String action = intent.getAction();
if (GadgetManager.ACTION_GADGET_UPDATE.equals(action)) {
Bundle extras = intent.getExtras();
if (extras != null) {
int[] gadgetIds = extras.getIntArray(GadgetManager.EXTRA_GADGET_IDS);
if (gadgetIds != null && gadgetIds.length > 0) {
this.onUpdate(context, GadgetManager.getInstance(context), gadgetIds);
}
}
}
else if (GadgetManager.ACTION_GADGET_DELETED.equals(action)) {
Bundle extras = intent.getExtras();
if (extras != null) {
int[] gadgetIds = extras.getIntArray(GadgetManager.EXTRA_GADGET_IDS);
if (gadgetIds != null && gadgetIds.length > 0) {
this.onDeleted(context, gadgetIds);
}
}
}
else if (GadgetManager.ACTION_GADGET_ENABLED.equals(action)) {
this.onEnabled(context);
}
else if (GadgetManager.ACTION_GADGET_DISABLED.equals(action)) {
this.onDisabled(context);
}
}
// END_INCLUDE(onReceive)
/**
* Called in response to the {@link GadgetManager#ACTION_GADGET_UPDATE} broadcast when
* this gadget provider is being asked to provide {@link android.widget.RemoteViews RemoteViews}
* for a set of gadgets. Override this method to implement your own gadget functionality.
*
* {@more}
*
* @param context The {@link android.content.Context Context} in which this receiver is
* running.
* @param gadgetManager A {@link GadgetManager} object you can call {@link
* GadgetManager#updateGadget} on.
* @param gadgetIds The gadgetsIds for which an update is needed. Note that this
* may be all of the gadget instances for this provider, or just
* a subset of them.
*
* @see GadgetManager#ACTION_GADGET_UPDATE
*/
public void onUpdate(Context context, GadgetManager gadgetManager, int[] gadgetIds) {
}
/**
* Called in response to the {@link GadgetManager#ACTION_GADGET_DELETED} broadcast when
* one or more gadget instances have been deleted. Override this method to implement
* your own gadget functionality.
*
* {@more}
*
* @param context The {@link android.content.Context Context} in which this receiver is
* running.
* @param gadgetIds The gadgetsIds that have been deleted from their host.
*
* @see GadgetManager#ACTION_GADGET_DELETED
*/
public void onDeleted(Context context, int[] gadgetIds) {
}
/**
* Called in response to the {@link GadgetManager#ACTION_GADGET_ENABLED} broadcast when
* the a gadget for this provider is instantiated. Override this method to implement your
* own gadget functionality.
*
* {@more}
* When the last gadget for this provider is deleted,
* {@link GadgetManager#ACTION_GADGET_DISABLED} is sent by the gadget manager, and
* {@link #onDisabled} is called. If after that, a gadget for this provider is created
* again, onEnabled() will be called again.
*
* @param context The {@link android.content.Context Context} in which this receiver is
* running.
*
* @see GadgetManager#ACTION_GADGET_ENABLED
*/
public void onEnabled(Context context) {
}
/**
* Called in response to the {@link GadgetManager#ACTION_GADGET_DISABLED} broadcast, which
* is sent when the last gadget instance for this provider is deleted. Override this method
* to implement your own gadget functionality.
*
* {@more}
*
* @param context The {@link android.content.Context Context} in which this receiver is
* running.
*
* @see GadgetManager#ACTION_GADGET_DISABLED
*/
public void onDisabled(Context context) {
}
}
|
