Os widgets de coleção são especializados na exibição de muitos elementos do mesmo tipo, como como coleções de fotos de um app de galeria, artigos de um app de notícias, ou mensagens de um app de comunicação. Os widgets de coleção geralmente se concentram em dois usos casos: navegar pela coleção e abrir um elemento dela para sua visualização de detalhes. Os widgets de coleção podem apresentar rolagem vertical.
Esses widgets usam a
RemoteViewsService para mostrar
coleções apoiadas por dados remotos, como de um conteúdo
provedor. O widget apresenta
usando um dos tipos de visualização a seguir, conhecidos como coleção
visualizações:
ListView- Uma visualização que mostra itens em um lista de rolagem vertical.
GridView- Uma visualização que mostra itens em um grade de rolagem bidimensional.
StackView- Um cartão empilhado mais ou menos como uma rolodex, em que o usuário pode deslizar a frente para cima ou para baixo para ver o card anterior ou o próximo, respectivamente.
AdapterViewFlipper- Um
com adaptador simples
ViewAnimatorque é animado entre duas ou mais visualizações. Apenas um filho é exibido por vez.
Como essas visualizações de coleção exibem coleções apoiadas por dados remotos, elas
usar um Adapter para vincular o usuário
aos dados. Um Adapter vincula itens individuais de um conjunto de dados.
a objetos View individuais.
E, como essas visualizações de coleção são apoiadas por adaptadores, o framework do Android
precisa incluir arquitetura extra para dar suporte ao uso em widgets. No contexto
de um widget, o Adapter é substituído por um
RemoteViewsFactory,
que é um wrapper fino ao redor da interface Adapter. Quando uma solicitação de
item específico na coleção, a RemoteViewsFactory cria e retorna
o item para a coleção como uma
objeto RemoteViews. Para incluir um
visualização de coleção no seu widget, implemente RemoteViewsService e
RemoteViewsFactory.
RemoteViewsService é um serviço que permite que um adaptador remoto solicite
objetos RemoteViews. RemoteViewsFactory é uma interface para um adaptador.
entre uma visualização de coleção, como ListView, GridView e
StackView e os dados dessa visualização. Do StackWidget
amostra,
aqui está um exemplo do código boilerplate para implementar este serviço e
- interface:
Kotlin
class StackWidgetService : RemoteViewsService() {
override fun onGetViewFactory(intent: Intent): RemoteViewsFactory {
return StackRemoteViewsFactory(this.applicationContext, intent)
}
}
class StackRemoteViewsFactory(
private val context: Context,
intent: Intent
) : RemoteViewsService.RemoteViewsFactory {
// See the RemoteViewsFactory API reference for the full list of methods to
// implement.
}
Java
public class StackWidgetService extends RemoteViewsService {
@Override
public RemoteViewsFactory onGetViewFactory(Intent intent) {
return new StackRemoteViewsFactory(this.getApplicationContext(), intent);
}
}
class StackRemoteViewsFactory implements RemoteViewsService.RemoteViewsFactory {
// See the RemoteViewsFactory API reference for the full list of methods to
// implement.
}
App de exemplo
Os trechos de código nesta seção também foram extraídos do StackWidget
amostra:
StackWidget.Essa amostra consiste em uma pilha de dez visualizações que mostram os valores zero até nove. O widget de amostra tem estes comportamentos principais:
O usuário pode deslizar verticalmente a visualização superior do widget para exibir o próximo ou visualização anterior. Esse é um comportamento
StackViewintegrado.Sem interação do usuário, o widget avança automaticamente visualizações em sequência, como uma apresentação de slides. Isso se deve à configuração
android:autoAdvanceViewId="@id/stack_view"no arquivores/xml/stackwidgetinfo.xml. Essa configuração se aplica ao ID da vista, que, neste caso, é o ID da visualização em pilha.Se o usuário tocar na visualização superior, o widget exibirá o Mensagem de
Toast"Visualização tocada n". em que n é o índice (posição) da visualização tocada. Para mais informações sobre como para implementar comportamentos, consulte a seção Adicionar comportamentos a de linha.
Implementar widgets com coleções
Para implementar um widget com coleções, siga o procedimento para implementar qualquer
widget, seguido de mais algumas etapas:
modificar o manifesto, adicionar uma visualização de coleção ao layout do widget e modificar
AppWidgetProvider.
Manifesto para widgets com coleções
Além dos requisitos listados em Declarar um widget no
manifesto do app, você precisa possibilitar que widgets com
para se vincular ao RemoteViewsService. Para isso, declare o
no arquivo de manifesto com a permissão
BIND_REMOTEVIEWS
Isso impede que outros aplicativos acessem livremente os dados do seu widget.
Por exemplo, ao criar um widget que usa RemoteViewsService para preencher um
visualização de coleção, a entrada do manifesto será parecida com esta:
<service android:name="MyWidgetService"
android:permission="android.permission.BIND_REMOTEVIEWS" />
Neste exemplo, android:name="MyWidgetService" se refere à sua subclasse de
RemoteViewsService.
Layout para widgets com coleções
O principal requisito para o arquivo XML de layout de widget é que ele inclua um dos
as visualizações de coleções: ListView, GridView, StackView ou
AdapterViewFlipper. Este é o arquivo widget_layout.xml do
StackWidget
amostra:
<FrameLayout xmlns:android="http://schemas.android.com/apk/res/android"
android:layout_width="match_parent"
android:layout_height="match_parent">
<StackView
android:id="@+id/stack_view"
android:layout_width="match_parent"
android:layout_height="match_parent"
android:gravity="center"
android:loopViews="true" />
<TextView
android:id="@+id/empty_view"
android:layout_width="match_parent"
android:layout_height="match_parent"
android:gravity="center"
android:background="@drawable/widget_item_background"
android:textColor="#ffffff"
android:textStyle="bold"
android:text="@string/empty_view_text"
android:textSize="20sp" />
</FrameLayout>
Observe que as visualizações vazias devem ser irmãs da visualização da coleção para a qual o que a visualização vazia representa um estado vazio.
Além do arquivo de layout para todo o widget, crie outro layout
que define o layout de cada item na coleção, por exemplo,
um layout para cada livro em uma coleção de livros. A amostra StackWidget tem
apenas um arquivo de layout de item, widget_item.xml, já que todos os itens usam o mesmo
o mesmo layout organizacional.
Classe AppWidgetProvider para widgets com coleções
Como acontece com widgets comuns, a maior parte do código nos seus
Subclasse AppWidgetProvider
geralmente vai em
onUpdate()
A principal diferença na sua implementação de onUpdate() ao criar um
com coleções é que você precisa chamar
setRemoteAdapter(). Isso informa à visualização da coleção onde obter os dados.
O RemoteViewsService pode retornar a implementação do
RemoteViewsFactory, e o widget pode exibir os dados adequados. Quando você
chamar esse método, transmita uma intenção que aponte para sua implementação do
RemoteViewsService e o ID do widget que especifica o widget a ser atualizado.
Por exemplo, confira como o exemplo StackWidget implementa o onUpdate().
método de callback para definir o RemoteViewsService como o adaptador remoto do
coleção de widgets:
Kotlin
override fun onUpdate(
context: Context,
appWidgetManager: AppWidgetManager,
appWidgetIds: IntArray
) {
// Update each of the widgets with the remote adapter.
appWidgetIds.forEach { appWidgetId ->
// Set up the intent that starts the StackViewService, which
// provides the views for this collection.
val intent = Intent(context, StackWidgetService::class.java).apply {
// Add the widget ID to the intent extras.
putExtra(AppWidgetManager.EXTRA_APPWIDGET_ID, appWidgetId)
data = Uri.parse(toUri(Intent.URI_INTENT_SCHEME))
}
// Instantiate the RemoteViews object for the widget layout.
val views = RemoteViews(context.packageName, R.layout.widget_layout).apply {
// Set up the RemoteViews object to use a RemoteViews adapter.
// This adapter connects to a RemoteViewsService through the
// specified intent.
// This is how you populate the data.
setRemoteAdapter(R.id.stack_view, intent)
// The empty view is displayed when the collection has no items.
// It must be in the same layout used to instantiate the
// RemoteViews object.
setEmptyView(R.id.stack_view, R.id.empty_view)
}
// Do additional processing specific to this widget.
appWidgetManager.updateAppWidget(appWidgetId, views)
}
super.onUpdate(context, appWidgetManager, appWidgetIds)
}
Java
public void onUpdate(Context context, AppWidgetManager appWidgetManager, int[] appWidgetIds) {
// Update each of the widgets with the remote adapter.
for (int i = 0; i < appWidgetIds.length; ++i) {
// Set up the intent that starts the StackViewService, which
// provides the views for this collection.
Intent intent = new Intent(context, StackWidgetService.class);
// Add the widget ID to the intent extras.
intent.putExtra(AppWidgetManager.EXTRA_APPWIDGET_ID, appWidgetIds[i]);
intent.setData(Uri.parse(intent.toUri(Intent.URI_INTENT_SCHEME)));
// Instantiate the RemoteViews object for the widget layout.
RemoteViews views = new RemoteViews(context.getPackageName(), R.layout.widget_layout);
// Set up the RemoteViews object to use a RemoteViews adapter.
// This adapter connects to a RemoteViewsService through the specified
// intent.
// This is how you populate the data.
views.setRemoteAdapter(R.id.stack_view, intent);
// The empty view is displayed when the collection has no items.
// It must be in the same layout used to instantiate the RemoteViews
// object.
views.setEmptyView(R.id.stack_view, R.id.empty_view);
// Do additional processing specific to this widget.
appWidgetManager.updateAppWidget(appWidgetIds[i], views);
}
super.onUpdate(context, appWidgetManager, appWidgetIds);
}
Persistir dados
Como descrito nesta página, a subclasse RemoteViewsService fornece
o RemoteViewsFactory usado para preencher a visualização de coleção remota.
Especificamente, execute estas etapas:
Coloque
RemoteViewsServiceem subclasse.RemoteViewsServiceé o serviço por meio de em que um adaptador remoto pode solicitarRemoteViews.Na subclasse
RemoteViewsService, inclua uma classe que implemente aRemoteViewsFactory.RemoteViewsFactoryé uma interface para entre uma visualização de coleção remota, comoListView,GridView,StackViewe os dados dessa visualização. Seu é responsável por criar um objetoRemoteViewspara cada no conjunto de dados. Essa interface é um wrapper fino emAdapter.
Você não pode confiar em uma única instância do seu serviço, ou nos dados que ele contém, para
persistem. Não armazene dados no RemoteViewsService, a menos que ele seja estático. Se
Se você quer que os dados do seu widget persistam, a melhor abordagem é usar uma
ContentProvider cujos dados
persistem além do ciclo de vida do processo. Por exemplo, um widget de supermercado pode
armazenar o estado de cada item da lista de compras em um local persistente, como um
no banco de dados do SQL.
O conteúdo principal da implementação do RemoteViewsService é a
RemoteViewsFactory, descrito na seção a seguir.
Interface RemoteViewsFactory
A classe personalizada que implementa a interface RemoteViewsFactory fornece
o widget com os dados dos itens na coleção. Para fazer isso,
combina o arquivo de layout XML do item do widget com uma fonte de dados. Essa fonte de
os dados podem ser qualquer coisa, desde um banco de dados até uma matriz simples. No StackWidget
exemplo, a fonte de dados é uma matriz de WidgetItems. O RemoteViewsFactory
funciona como um adaptador para juntar os dados à visualização de coleta remota.
Os dois métodos mais importantes que você precisa implementar
a subclasse RemoteViewsFactory é
onCreate() e
getViewAt()
O sistema chama onCreate() ao criar a fábrica pela primeira vez.
É aqui que você configura conexões ou cursores para sua fonte de dados. Para
exemplo, a amostra StackWidget usa onCreate() para inicializar uma matriz de
objetos WidgetItem. Quando seu widget está ativo, o sistema acessa essas
objetos usando sua posição de índice na matriz e exibe o texto que eles
contêm.
Veja um trecho do RemoteViewsFactory da amostra de StackWidget
implementação que mostra partes do método onCreate():
Kotlin
private const val REMOTE_VIEW_COUNT: Int = 10
class StackRemoteViewsFactory(
private val context: Context
) : RemoteViewsService.RemoteViewsFactory {
private lateinit var widgetItems: List<WidgetItem>
override fun onCreate() {
// In onCreate(), set up any connections or cursors to your data
// source. Heavy lifting, such as downloading or creating content,
// must be deferred to onDataSetChanged() or getViewAt(). Taking
// more than 20 seconds on this call results in an ANR.
widgetItems = List(REMOTE_VIEW_COUNT) { index -> WidgetItem("$index!") }
...
}
...
}
Java
class StackRemoteViewsFactory implements RemoteViewsService.RemoteViewsFactory {
private static final int REMOTE_VIEW_COUNT = 10;
private List<WidgetItem> widgetItems = new ArrayList<WidgetItem>();
public void onCreate() {
// In onCreate(), setup any connections or cursors to your data
// source. Heavy lifting, such as downloading or creating content,
// must be deferred to onDataSetChanged() or getViewAt(). Taking
// more than 20 seconds on this call results in an ANR.
for (int i = 0; i < REMOTE_VIEW_COUNT; i++) {
widgetItems.add(new WidgetItem(i + "!"));
}
...
}
...
O método getViewAt() do RemoteViewsFactory retorna um objeto RemoteViews.
que corresponde aos dados no position especificado no conjunto de dados. Aqui está
Um trecho da implementação de RemoteViewsFactory da amostra StackWidget:
Kotlin
override fun getViewAt(position: Int): RemoteViews {
// Construct a remote views item based on the widget item XML file
// and set the text based on the position.
return RemoteViews(context.packageName, R.layout.widget_item).apply {
setTextViewText(R.id.widget_item, widgetItems[position].text)
}
}
Java
public RemoteViews getViewAt(int position) {
// Construct a remote views item based on the widget item XML file
// and set the text based on the position.
RemoteViews views = new RemoteViews(context.getPackageName(), R.layout.widget_item);
views.setTextViewText(R.id.widget_item, widgetItems.get(position).text);
return views;
}
Adicionar comportamentos a itens individuais
As seções anteriores mostram como vincular seus dados à coleção de widgets. Mas e se você quiser adicionar comportamento dinâmico aos itens individuais da sua visualização de coleção?
Conforme descrito em Processar eventos com o onUpdate()
classe, você normalmente usa
setOnClickPendingIntent() para definir o comportamento de clique de um objeto, como
faz com que um botão inicie uma Activity. Mas
essa abordagem não é permitida para visualizações filhas em um item de coleção individual.
Por exemplo, use setOnClickPendingIntent() para configurar um botão global.
no widget do Gmail que inicia o aplicativo, por exemplo, mas não na
itens de lista individuais.
Em vez disso, para adicionar o comportamento de clique a itens individuais em uma coleção, use
setOnClickFillInIntent() Isso envolve a configuração de um modelo de intent pendente para
sua visualização de coleção e, em seguida, definir uma intenção de preenchimento em cada item na
usando sua RemoteViewsFactory.
Esta seção usa o exemplo StackWidget para descrever como adicionar comportamentos
itens individuais. No exemplo StackWidget, se o usuário tocar na visualização superior,
o widget exibirá a mensagem Toast "Touched view n", em que n é o
índice (posição) da visualização tocada. Veja como funciona:
O
StackWidgetProvider: umAppWidgetProvidersubclasse: cria uma intent pendente com uma ação personalizada chamadaTOAST_ACTION.Quando o usuário toca em uma visualização, a intent é acionada e transmite
TOAST_ACTION:Essa transmissão foi interceptada pelo objeto da classe
StackWidgetProvideronReceive(), e o widget exibe a mensagemToastpara a visualização com toques. Os dados dos itens da coleção são fornecidos peloRemoteViewsFactorypeloRemoteViewsService.
Configurar o modelo de intent pendente
O StackWidgetProvider (uma
AppWidgetProvider).
configura uma intent pendente. Não é possível configurar itens individuais de uma coleção
as próprias intents pendentes. Em vez disso, a coleção como um todo configura uma intent pendente
modelo, e os itens individuais definem uma intent de preenchimento para criar
o comportamento de cada item.
Essa classe também recebe a transmissão que é enviada quando o usuário toca em um
visualização. Ela processa esse evento no método onReceive(). Se o estado
ação for TOAST_ACTION, o widget exibirá uma mensagem Toast para o
visualização.
Kotlin
const val TOAST_ACTION = "com.example.android.stackwidget.TOAST_ACTION"
const val EXTRA_ITEM = "com.example.android.stackwidget.EXTRA_ITEM"
class StackWidgetProvider : AppWidgetProvider() {
...
// Called when the BroadcastReceiver receives an Intent broadcast.
// Checks whether the intent's action is TOAST_ACTION. If it is, the
// widget displays a Toast message for the current item.
override fun onReceive(context: Context, intent: Intent) {
val mgr: AppWidgetManager = AppWidgetManager.getInstance(context)
if (intent.action == TOAST_ACTION) {
val appWidgetId: Int = intent.getIntExtra(
AppWidgetManager.EXTRA_APPWIDGET_ID,
AppWidgetManager.INVALID_APPWIDGET_ID
)
// EXTRA_ITEM represents a custom value provided by the Intent
// passed to the setOnClickFillInIntent() method to indicate the
// position of the clicked item. See StackRemoteViewsFactory in
// Set the fill-in Intent for details.
val viewIndex: Int = intent.getIntExtra(EXTRA_ITEM, 0)
Toast.makeText(context, "Touched view $viewIndex", Toast.LENGTH_SHORT).show()
}
super.onReceive(context, intent)
}
override fun onUpdate(
context: Context,
appWidgetManager: AppWidgetManager,
appWidgetIds: IntArray
) {
// Update each of the widgets with the remote adapter.
appWidgetIds.forEach { appWidgetId ->
// Sets up the intent that points to the StackViewService that
// provides the views for this collection.
val intent = Intent(context, StackWidgetService::class.java).apply {
putExtra(AppWidgetManager.EXTRA_APPWIDGET_ID, appWidgetId)
// When intents are compared, the extras are ignored, so embed
// the extra sinto the data so that the extras are not ignored.
data = Uri.parse(toUri(Intent.URI_INTENT_SCHEME))
}
val rv = RemoteViews(context.packageName, R.layout.widget_layout).apply {
setRemoteAdapter(R.id.stack_view, intent)
// The empty view is displayed when the collection has no items.
// It must be a sibling of the collection view.
setEmptyView(R.id.stack_view, R.id.empty_view)
}
// This section makes it possible for items to have individualized
// behavior. It does this by setting up a pending intent template.
// Individuals items of a collection can't set up their own pending
// intents. Instead, the collection as a whole sets up a pending
// intent template, and the individual items set a fillInIntent
// to create unique behavior on an item-by-item basis.
val toastPendingIntent: PendingIntent = Intent(
context,
StackWidgetProvider::class.java
).run {
// Set the action for the intent.
// When the user touches a particular view, it has the effect of
// broadcasting TOAST_ACTION.
action = TOAST_ACTION
putExtra(AppWidgetManager.EXTRA_APPWIDGET_ID, appWidgetId)
data = Uri.parse(toUri(Intent.URI_INTENT_SCHEME))
PendingIntent.getBroadcast(context, 0, this, PendingIntent.FLAG_UPDATE_CURRENT)
}
rv.setPendingIntentTemplate(R.id.stack_view, toastPendingIntent)
appWidgetManager.updateAppWidget(appWidgetId, rv)
}
super.onUpdate(context, appWidgetManager, appWidgetIds)
}
}
Java
public class StackWidgetProvider extends AppWidgetProvider {
public static final String TOAST_ACTION = "com.example.android.stackwidget.TOAST_ACTION";
public static final String EXTRA_ITEM = "com.example.android.stackwidget.EXTRA_ITEM";
...
// Called when the BroadcastReceiver receives an Intent broadcast.
// Checks whether the intent's action is TOAST_ACTION. If it is, the
// widget displays a Toast message for the current item.
@Override
public void onReceive(Context context, Intent intent) {
AppWidgetManager mgr = AppWidgetManager.getInstance(context);
if (intent.getAction().equals(TOAST_ACTION)) {
int appWidgetId = intent.getIntExtra(AppWidgetManager.EXTRA_APPWIDGET_ID,
AppWidgetManager.INVALID_APPWIDGET_ID);
// EXTRA_ITEM represents a custom value provided by the Intent
// passed to the setOnClickFillInIntent() method to indicate the
// position of the clicked item. See StackRemoteViewsFactory in
// Set the fill-in Intent for details.
int viewIndex = intent.getIntExtra(EXTRA_ITEM, 0);
Toast.makeText(context, "Touched view " + viewIndex, Toast.LENGTH_SHORT).show();
}
super.onReceive(context, intent);
}
@Override
public void onUpdate(Context context, AppWidgetManager appWidgetManager, int[] appWidgetIds) {
// Update each of the widgets with the remote adapter.
for (int i = 0; i < appWidgetIds.length; ++i) {
// Sets up the intent that points to the StackViewService that
// provides the views for this collection.
Intent intent = new Intent(context, StackWidgetService.class);
intent.putExtra(AppWidgetManager.EXTRA_APPWIDGET_ID, appWidgetIds[i]);
// When intents are compared, the extras are ignored, so embed
// the extras into the data so that the extras are not
// ignored.
intent.setData(Uri.parse(intent.toUri(Intent.URI_INTENT_SCHEME)));
RemoteViews rv = new RemoteViews(context.getPackageName(), R.layout.widget_layout);
rv.setRemoteAdapter(appWidgetIds[i], R.id.stack_view, intent);
// The empty view is displayed when the collection has no items. It
// must be a sibling of the collection view.
rv.setEmptyView(R.id.stack_view, R.id.empty_view);
// This section makes it possible for items to have individualized
// behavior. It does this by setting up a pending intent template.
// Individuals items of a collection can't set up their own pending
// intents. Instead, the collection as a whole sets up a pending
// intent template, and the individual items set a fillInIntent
// to create unique behavior on an item-by-item basis.
Intent toastIntent = new Intent(context, StackWidgetProvider.class);
// Set the action for the intent.
// When the user touches a particular view, it has the effect of
// broadcasting TOAST_ACTION.
toastIntent.setAction(StackWidgetProvider.TOAST_ACTION);
toastIntent.putExtra(AppWidgetManager.EXTRA_APPWIDGET_ID, appWidgetIds[i]);
intent.setData(Uri.parse(intent.toUri(Intent.URI_INTENT_SCHEME)));
PendingIntent toastPendingIntent = PendingIntent.getBroadcast(context, 0, toastIntent,
PendingIntent.FLAG_UPDATE_CURRENT);
rv.setPendingIntentTemplate(R.id.stack_view, toastPendingIntent);
appWidgetManager.updateAppWidget(appWidgetIds[i], rv);
}
super.onUpdate(context, appWidgetManager, appWidgetIds);
}
}
Definir a intent de preenchimento
Seu RemoteViewsFactory precisa definir uma intent de preenchimento em cada item da
coleção. Isso possibilita distinguir
a ação individual de clique
de um determinado item. A intent de preenchimento é então combinada com a
Modelo PendingIntent para determinar
a intent final que é executada quando o item é tocado.
Kotlin
private const val REMOTE_VIEW_COUNT: Int = 10
class StackRemoteViewsFactory(
private val context: Context,
intent: Intent
) : RemoteViewsService.RemoteViewsFactory {
private lateinit var widgetItems: List<WidgetItem>
private val appWidgetId: Int = intent.getIntExtra(
AppWidgetManager.EXTRA_APPWIDGET_ID,
AppWidgetManager.INVALID_APPWIDGET_ID
)
override fun onCreate() {
// In onCreate(), set up any connections or cursors to your data source.
// Heavy lifting, such as downloading or creating content, must be
// deferred to onDataSetChanged() or getViewAt(). Taking more than 20
// seconds on this call results in an ANR.
widgetItems = List(REMOTE_VIEW_COUNT) { index -> WidgetItem("$index!") }
...
}
...
override fun getViewAt(position: Int): RemoteViews {
// Construct a remote views item based on the widget item XML file
// and set the text based on the position.
return RemoteViews(context.packageName, R.layout.widget_item).apply {
setTextViewText(R.id.widget_item, widgetItems[position].text)
// Set a fill-intent to fill in the pending intent template.
// that is set on the collection view in StackWidgetProvider.
val fillInIntent = Intent().apply {
Bundle().also { extras ->
extras.putInt(EXTRA_ITEM, position)
putExtras(extras)
}
}
// Make it possible to distinguish the individual on-click
// action of a given item.
setOnClickFillInIntent(R.id.widget_item, fillInIntent)
...
}
}
...
}
Java
public class StackWidgetService extends RemoteViewsService {
@Override
public RemoteViewsFactory onGetViewFactory(Intent intent) {
return new StackRemoteViewsFactory(this.getApplicationContext(), intent);
}
}
class StackRemoteViewsFactory implements RemoteViewsService.RemoteViewsFactory {
private static final int count = 10;
private List<WidgetItem> widgetItems = new ArrayList<WidgetItem>();
private Context context;
private int appWidgetId;
public StackRemoteViewsFactory(Context context, Intent intent) {
this.context = context;
appWidgetId = intent.getIntExtra(AppWidgetManager.EXTRA_APPWIDGET_ID,
AppWidgetManager.INVALID_APPWIDGET_ID);
}
// Initialize the data set.
public void onCreate() {
// In onCreate(), set up any connections or cursors to your data
// source. Heavy lifting, such as downloading or creating
// content, must be deferred to onDataSetChanged() or
// getViewAt(). Taking more than 20 seconds on this call results
// in an ANR.
for (int i = 0; i < count; i++) {
widgetItems.add(new WidgetItem(i + "!"));
}
...
}
// Given the position (index) of a WidgetItem in the array, use the
// item's text value in combination with the widget item XML file to
// construct a RemoteViews object.
public RemoteViews getViewAt(int position) {
// Position always ranges from 0 to getCount() - 1.
// Construct a RemoteViews item based on the widget item XML
// file and set the text based on the position.
RemoteViews rv = new RemoteViews(context.getPackageName(), R.layout.widget_item);
rv.setTextViewText(R.id.widget_item, widgetItems.get(position).text);
// Set a fill-intent to fill in the pending
// intent template that is set on the collection view in
// StackWidgetProvider.
Bundle extras = new Bundle();
extras.putInt(StackWidgetProvider.EXTRA_ITEM, position);
Intent fillInIntent = new Intent();
fillInIntent.putExtras(extras);
// Make it possible to distinguish the individual on-click
// action of a given item.
rv.setOnClickFillInIntent(R.id.widget_item, fillInIntent);
// Return the RemoteViews object.
return rv;
}
...
}
manter os dados da coleção atualizados;
A Figura 2 ilustra o fluxo de atualização em um widget que usa coleções. Mostra
como o código do widget interage com a RemoteViewsFactory e como é possível
acionar atualizações:
RemoteViewsFactory durante as atualizações.Os widgets que usam coleções podem fornecer conteúdo atualizado aos usuários. Para
Por exemplo, o widget do Gmail oferece aos usuários um resumo da caixa de entrada. Para tornar isso
possível, acione seu RemoteViewsFactory e a visualização de coleção para buscar e
e mostrar novos dados.
Para fazer isso, use o método
AppWidgetManager para ligar
notifyAppWidgetViewDataChanged() Essa chamada gera um callback para o objeto RemoteViewsFactory
onDataSetChanged()
que permite buscar dados novos.
É possível executar operações de processamento intensivo de forma síncrona
onDataSetChanged(). Você tem a garantia de que esta chamada será concluída
antes que os metadados ou os dados de visualização sejam buscados em RemoteViewsFactory. Você
também pode realizar operações de processamento intensivo no getViewAt()
. Se essa chamada demorar muito, a visualização de carregamento, especificada pelo
RemoteViewsFactory do objeto
getLoadingView()
é exibido na posição correspondente da visualização de coleções
até que ele volte.
Usar RemoteCollectionItems para transmitir uma coleção diretamente
O Android 12 (nível 31 da API) adiciona o setRemoteAdapter(int viewId,
RemoteViews.RemoteCollectionItems
items).
, que permite que seu aplicativo transmita uma coleção diretamente ao preencher um
visualização de coleção. Se você definir o adaptador usando esse método, não será necessário
implementar uma RemoteViewsFactory e não é necessário chamar
notifyAppWidgetViewDataChanged().
Além de facilitar o preenchimento do adaptador, essa abordagem também
remove a latência de preenchimento de novos itens quando os usuários rolam a lista para baixo até
para revelar um novo item. É melhor usar essa abordagem para configurar o adaptador, desde que
seu conjunto de itens da coleção é relativamente pequeno. No entanto, por exemplo,
não funciona bem se sua coleção contém inúmeras Bitmaps
transmitido para setImageViewBitmap.
Se a coleção não usar um conjunto constante de layouts, ou seja, se algum
itens estão presentes apenas algumas vezes. Use setViewTypeCount para especificar o
número máximo de layouts exclusivos que a coleção pode conter. Assim,
ser reutilizado nas atualizações do widget de app.
Veja um exemplo de como implementar coleções RemoteViews simplificadas.
Kotlin
val itemLayouts = listOf(
R.layout.item_type_1,
R.layout.item_type_2,
...
)
remoteView.setRemoteAdapter(
R.id.list_view,
RemoteViews.RemoteCollectionItems.Builder()
.addItem(/* id= */ ID_1, RemoteViews(context.packageName, R.layout.item_type_1))
.addItem(/* id= */ ID_2, RemoteViews(context.packageName, R.layout.item_type_2))
...
.setViewTypeCount(itemLayouts.count())
.build()
)
Java
List<Integer> itemLayouts = Arrays.asList(
R.layout.item_type_1,
R.layout.item_type_2,
...
);
remoteView.setRemoteAdapter(
R.id.list_view,
new RemoteViews.RemoteCollectionItems.Builder()
.addItem(/* id= */ ID_1, new RemoteViews(context.getPackageName(), R.layout.item_type_1))
.addItem(/* id= */ ID_2, new RemoteViews(context.getPackageName(), R.layout.item_type_2))
...
.setViewTypeCount(itemLayouts.size())
.build()
);