Criar um widget simples

Os widgets de apps são visualizações em miniatura que podem ser incorporadas a outros apps, como a tela inicial, e receber atualizações periódicas. Essas visualizações são chamadas de widgets na interface do usuário, e é possível publicar uma delas com um provedor de widgets de app (ou provedor de widgets). Um componente de app que armazena outros widgets é chamado de host de widgets de apps (ou host de widgets). A Figura 1 mostra um exemplo de widget de música:

Este documento descreve como publicar um widget usando um provedor. Para saber como criar seu próprio AppWidgetHost para hospedar widgets de apps, consulte Criar um host de widgets.

Para saber mais sobre como projetar seu widget, consulte Visão geral dos widgets de apps.

Componentes do widget

Para criar um widget, você precisa dos seguintes componentes básicos:

Objeto AppWidgetProviderInfo

Descreve os metadados de um widget, como o layout, a frequência de atualização e a classe AppWidgetProvider. AppWidgetProviderInfo é definido em XML, conforme descrito neste documento.

Classe AppWidgetProvider

Define os métodos básicos que permitem interagir programaticamente com o widget. Por meio dela, você recebe transmissões quando o widget é atualizado, ativado, desativado ou excluído. Declare AppWidgetProvider no manifesto e implemente, conforme descrito neste documento.

Layout de visualização

Define o layout inicial do widget. O layout é definido em XML, conforme descrito neste documento.

A Figura 2 mostra como esses componentes se encaixam no fluxo geral de processamento de widgets do app.

Se o widget precisar de configuração do usuário, implemente a atividade de configuração do widget de app. Essa atividade permite que os usuários modifiquem as configurações do widget, por exemplo, o fuso horário de um widget de relógio.

• A partir do Android 12 (nível 31 da API), é possível fornecer uma configuração padrão e permitir que os usuários reconfigurem o widget mais tarde. Consulte Usar a configuração padrão do widget e Permitir que os usuários reconfigurem widgets colocados para mais detalhes.
• No Android 11 (nível 30 da API) ou versões anteriores, essa atividade é iniciada sempre que o usuário adiciona o widget à tela inicial.

Também recomendamos as seguintes melhorias: layouts flexíveis de widgets, melhorias diversas, widgets avançados, widgets de coleção e como criar um host de widgets.

Declarar o XML AppWidgetProviderInfo

O objeto AppWidgetProviderInfo define as qualidades essenciais de um widget. Defina o objeto AppWidgetProviderInfo em um arquivo de recurso XML usando um único elemento <appwidget-provider> e salve-o na pasta res/xml/ do projeto.

Isso é mostrado neste exemplo:

<appwidget-provider xmlns:android="http://schemas.android.com/apk/res/android"
    android:minWidth="40dp"
    android:minHeight="40dp"
    android:targetCellWidth="1"
    android:targetCellHeight="1"
    android:maxResizeWidth="250dp"
    android:maxResizeHeight="120dp"
    android:updatePeriodMillis="86400000"
    android:description="@string/example_appwidget_description"
    android:previewLayout="@layout/example_appwidget_preview"
    android:initialLayout="@layout/example_loading_appwidget"
    android:configure="com.example.android.ExampleAppWidgetConfigurationActivity"
    android:resizeMode="horizontal|vertical"
    android:widgetCategory="home_screen"
    android:widgetFeatures="reconfigurable|configuration_optional">
</appwidget-provider>

Atributos de dimensionamento de widgets

A tela inicial padrão posiciona widgets na janela com base em uma grade de células com altura e largura definidas. A maioria das telas iniciais só permite que os widgets assumam tamanhos que sejam múltiplos de fração das células da grade. Por exemplo, duas células horizontalmente por três células verticalmente.

Os atributos de dimensionamento de widgets permitem especificar um tamanho padrão para o widget e fornecer limites mínimos e máximos. Nesse contexto, o tamanho padrão de um widget é o tamanho que ele assume quando é adicionado à tela inicial.

A tabela a seguir descreve os atributos <appwidget-provider> relacionados ao dimensionamento do widget:

Exemplo

Para ilustrar como os atributos na tabela anterior afetam o tamanho do widget, considere as seguintes especificações:

• Uma célula da grade tem 30 dp de largura e 50 dp de altura.
• A seguinte especificação de atributo é fornecida:

<appwidget-provider xmlns:android="http://schemas.android.com/apk/res/android"
    android:minWidth="80dp"
    android:minHeight="80dp"
    android:targetCellWidth="2"
    android:targetCellHeight="2"
    android:minResizeWidth="40dp"
    android:minResizeHeight="40dp"
    android:maxResizeWidth="120dp"
    android:maxResizeHeight="120dp"
    android:resizeMode="horizontal|vertical" />

A partir do Android 12:

Use os atributos targetCellWidth e targetCellHeight como o tamanho padrão do widget.

O tamanho do widget é 2x2 por padrão. O widget pode ser redimensionado para 2x1 ou até 4x3.

Android 11 e versões anteriores:

Use os atributos minWidth e minHeight para calcular o tamanho padrão do widget.

A largura padrão = Math.ceil(80 / 30) = 3

A altura padrão = Math.ceil(80 / 50) = 2

O tamanho do widget é 3x2 por padrão. O widget pode ser redimensionado para 2x1 ou para tela cheia.

Outros atributos de widgets

A tabela a seguir descreve os atributos <appwidget-provider> relacionados a outras qualidades além do dimensionamento do widget.

Usar a classe AppWidgetProvider para processar transmissões de widgets

A classe AppWidgetProvider processa transmissões de widget e atualiza o widget em resposta a eventos do ciclo de vida do widget. As seções a seguir descrevem como declarar e implementar AppWidgetProvider no manifesto.

Declarar um widget no manifesto

Primeiro, declare a classe AppWidgetProvider no arquivo AndroidManifest.xml do app, conforme mostrado no exemplo abaixo:

<receiver android:name="ExampleAppWidgetProvider"
                 android:exported="false">
    <intent-filter>
        <action android:name="android.appwidget.action.APPWIDGET_UPDATE" />
    </intent-filter>
    <meta-data android:name="android.appwidget.provider"
               android:resource="@xml/example_appwidget_info" />
</receiver>

O elemento <receiver> requer o atributo android:name, que especifica o AppWidgetProvider usado pelo widget. O componente não pode ser exportado, a menos que um processo separado precise ser transmitido para o AppWidgetProvider, o que geralmente não acontece.

O elemento <intent-filter> precisa incluir um elemento <action> com o atributo android:name. Esse atributo especifica que o AppWidgetProvider aceita a transmissão de ACTION_APPWIDGET_UPDATE. Essa é a única transmissão que precisa ser declarada explicitamente. O AppWidgetManager envia automaticamente todas as outras transmissões de widgets para o AppWidgetProvider conforme necessário.

O elemento <meta-data> especifica o recurso AppWidgetProviderInfo e requer os seguintes atributos:

• android:name: especifica o nome dos metadados. Use android.appwidget.provider para identificar os dados como o descritor AppWidgetProviderInfo.
• android:resource: especifica o local do recurso AppWidgetProviderInfo.

Implementar a classe AppWidgetProvider

A classe AppWidgetProvider estende BroadcastReceiver como uma classe de conveniência para processar transmissões de widgets. Ele recebe apenas as transmissões de eventos que são relevantes para o widget, como quando ele é atualizado, excluído, ativado e desativado. Quando esses eventos de transmissão ocorrem, os seguintes métodos AppWidgetProvider são chamados:

onUpdate()

É chamado para atualizar o widget em intervalos definidos pelo atributo updatePeriodMillis no AppWidgetProviderInfo. Consulte a tabela que descreve outros atributos de widget nesta página para mais informações.

Esse método também é chamado quando o usuário adiciona o widget. Por isso, ele realiza a configuração essencial, como definir manipuladores de eventos para objetos View ou iniciar trabalhos para carregar dados para exibição no widget. No entanto, se você declarar uma atividade de configuração sem a flag configuration_optional, esse método não será chamado quando o usuário adicionar o widget, mas será chamado para as atualizações subsequentes. É responsabilidade da atividade de configuração realizar a primeira atualização quando a configuração for concluída. Consulte Permitir que os usuários configurem widgets de apps para mais informações.

O callback mais importante é onUpdate(). Consulte Processar eventos com a classe onUpdate() nesta página para mais informações.

onAppWidgetOptionsChanged()

É chamado quando o widget é posicionado pela primeira vez e sempre que ele é redimensionado. Use esse callback para mostrar ou ocultar conteúdo com base nas variações de tamanho do widget. Receba as variações de tamanho e, a partir do Android 12, a lista de tamanhos possíveis que uma instância de widget pode ter, chamando getAppWidgetOptions(), que retorna um Bundle que inclui o seguinte:

• OPTION_APPWIDGET_MIN_WIDTH: contém o limite inferior da largura, em unidades dp, de uma instância de widget.
• OPTION_APPWIDGET_MIN_HEIGHT: contém o limite inferior da altura, em unidades dp, de uma instância de widget.
• OPTION_APPWIDGET_MAX_WIDTH: contém o limite superior da largura, em unidades dp, de uma instância de widget.
• OPTION_APPWIDGET_MAX_HEIGHT: contém o limite superior da altura, em unidades dp, de uma instância de widget.
• OPTION_APPWIDGET_SIZES: contém a lista de tamanhos possíveis (List<SizeF>), em unidades dp, que uma instância de widget pode ter. Introduzido no Android 12.

onDeleted(Context, int[])

É chamado toda vez que um widget é excluído do host de widgets.

onEnabled(Context)

É chamado quando uma instância do widget é criada pela primeira vez. Por exemplo, se o usuário adicionar duas instâncias do widget, ele só será chamado na primeira vez. Se você precisar abrir um novo banco de dados ou realizar outra configuração que só precise ocorrer uma vez para todas as instâncias de widget, esse é um bom lugar para fazer isso.

onDisabled(Context)

É chamado quando a última instância do widget é excluída do host de widgets. É aqui que você limpa todo o trabalho feito em onEnabled(Context), como excluir um banco de dados temporário.

onReceive(Context, Intent)

Isso é chamado para cada transmissão e antes de cada um dos métodos de callback anteriores. Normalmente, não é necessário implementar esse método, porque a implementação padrão de AppWidgetProvider filtra todas as transmissões de widgets e chama os métodos anteriores conforme apropriado.

É necessário declarar a implementação da classe AppWidgetProvider como um broadcast receiver usando o elemento <receiver> no AndroidManifest. Consulte Declarar um widget no manifesto nesta página para mais informações.

Processar eventos com a classe onUpdate()

O callback AppWidgetProvider mais importante é onUpdate(), porque ele é chamado quando cada widget é adicionado a um host, a menos que você use uma atividade de configuração sem a flag configuration_optional. Se o widget aceitar eventos de interação do usuário, registre os manipuladores de eventos nesse callback. Se o widget não criar arquivos ou bancos de dados temporários nem realizar outro trabalho que exija a limpeza, onUpdate() talvez seja o único método de callback que você precisa definir.

Por exemplo, se você quiser um widget com um botão que inicia uma atividade quando tocado, use a seguinte implementação de AppWidgetProvider:

class ExampleAppWidgetProvider : AppWidgetProvider() {

    override fun onUpdate(
            context: Context,
            appWidgetManager: AppWidgetManager,
            appWidgetIds: IntArray
    ) {
        // Perform this loop procedure for each widget that belongs to this
        // provider.
        appWidgetIds.forEach { appWidgetId ->
            // Create an Intent to launch ExampleActivity.
            val pendingIntent: PendingIntent = PendingIntent.getActivity(
                    /* context = */ context,
                    /* requestCode = */  0,
                    /* intent = */ Intent(context, ExampleActivity::class.java),
                    /* flags = */ PendingIntent.FLAG_UPDATE_CURRENT or PendingIntent.FLAG_IMMUTABLE
            )

            // Get the layout for the widget and attach an onClick listener to
            // the button.
            val views: RemoteViews = RemoteViews(
                    context.packageName,
                    R.layout.appwidget_provider_layout
            ).apply {
                setOnClickPendingIntent(R.id.button, pendingIntent)
            }

            // Tell the AppWidgetManager to perform an update on the current
            // widget.
            appWidgetManager.updateAppWidget(appWidgetId, views)
        }
    }
}

public class ExampleAppWidgetProvider extends AppWidgetProvider {

    public void onUpdate(Context context, AppWidgetManager appWidgetManager, int[] appWidgetIds) {
        // Perform this loop procedure for each widget that belongs to this
        // provider.
        for (int i=0; i < appWidgetIds.length; i++) {
            int appWidgetId = appWidgetIds[i];
            // Create an Intent to launch ExampleActivity
            Intent intent = new Intent(context, ExampleActivity.class);
            PendingIntent pendingIntent = PendingIntent.getActivity(
                /* context = */ context,
                /* requestCode = */ 0,
                /* intent = */ intent,
                /* flags = */ PendingIntent.FLAG_UPDATE_CURRENT | PendingIntent.FLAG_IMMUTABLE
            );

            // Get the layout for the widget and attach an onClick listener to
            // the button.
            RemoteViews views = new RemoteViews(context.getPackageName(), R.layout.example_appwidget_layout);
            views.setOnClickPendingIntent(R.id.button, pendingIntent);

            // Tell the AppWidgetManager to perform an update on the current app
            // widget.
            appWidgetManager.updateAppWidget(appWidgetId, views);
        }
    }
}

Esse AppWidgetProvider define apenas o método onUpdate(), usando-o para criar um PendingIntent que inicia um Activity e o anexa ao botão do widget usando setOnClickPendingIntent(int, PendingIntent). Ele inclui um loop que é iterado em cada entrada em appWidgetIds, que é uma matriz de IDs que identifica cada widget criado por esse provedor. Se o usuário criar mais de uma instância do widget, todas serão atualizadas simultaneamente. No entanto, apenas uma programação de updatePeriodMillis é gerenciada para todas as instâncias do widget. Por exemplo, se a programação de atualização for definida a cada duas horas e uma segunda instância do widget for adicionada uma hora após a primeira, ambas serão atualizadas no período definido pelo primeiro, e o segundo período de atualização será ignorado. Elas são atualizadas a cada duas horas, não a cada hora.

Consulte a classe de exemplo ExampleAppWidgetProvider.java para mais detalhes.

Receber intents de transmissão de widgets

AppWidgetProvider é uma classe de conveniência. Se você quiser receber as transmissões do widget diretamente, implemente seu próprio BroadcastReceiver ou substitua o callback onReceive(Context,Intent). Os intents com os quais você precisa se preocupar são os seguintes:

• ACTION_APPWIDGET_UPDATE
• ACTION_APPWIDGET_DELETED
• ACTION_APPWIDGET_ENABLED
• ACTION_APPWIDGET_DISABLED
• ACTION_APPWIDGET_OPTIONS_CHANGED

Criar o layout do widget

É necessário definir um layout inicial para o widget em XML e salvá-lo no diretório res/layout/ do projeto. Consulte as diretrizes de design para mais detalhes.

Criar o layout do widget é simples se você conhecer os layouts. No entanto, os layouts de widgets são baseados em RemoteViews, que não oferece suporte a todos os tipos de layout ou widget de visualização. Não é possível usar visualizações personalizadas ou subclasses das visualizações que têm suporte para RemoteViews.

A RemoteViews também oferece suporte a ViewStub, que é uma View invisível e de tamanho zero que pode ser usada para inflar lentamente os recursos de layout no momento da execução.

Suporte a comportamento com estado

O Android 12 adicionou suporte a comportamentos com estado usando os seguintes componentes:

• CheckBox

• Switch

• RadioButton

O widget ainda não tem estado. O app precisa armazenar o estado e se registrar para eventos de mudança de estado.

O exemplo de código a seguir mostra como implementar esses componentes.

// Check the view.
remoteView.setCompoundButtonChecked(R.id.my_checkbox, true)

// Check a radio group.
remoteView.setRadioGroupChecked(R.id.my_radio_group, R.id.radio_button_2)

// Listen for check changes. The intent has an extra with the key
// EXTRA_CHECKED that specifies the current checked state of the view.
remoteView.setOnCheckedChangeResponse(
        R.id.my_checkbox,
        RemoteViews.RemoteResponse.fromPendingIntent(onCheckedChangePendingIntent)
)

// Check the view.
remoteView.setCompoundButtonChecked(R.id.my_checkbox, true);

// Check a radio group.
remoteView.setRadioGroupChecked(R.id.my_radio_group, R.id.radio_button_2);

// Listen for check changes. The intent has an extra with the key
// EXTRA_CHECKED that specifies the current checked state of the view.
remoteView.setOnCheckedChangeResponse(
    R.id.my_checkbox,
    RemoteViews.RemoteResponse.fromPendingIntent(onCheckedChangePendingIntent));

Forneça dois layouts: um direcionado para dispositivos com o Android 12 ou versões mais recentes em res/layout-v31 e o outro direcionado para o Android 11 ou versões anteriores na pasta res/layout padrão.

Implementar cantos arredondados

O Android 12 introduz os parâmetros de sistema a seguir para definir o raio dos cantos arredondados do widget:

• system_app_widget_background_radius: o raio do canto do plano de fundo do widget, que nunca é maior que 28 dp.

• system_app_widget_inner_radius: o raio do canto de qualquer visualização dentro do widget. Ele é exatamente 8 dp menor que o raio do plano de fundo para se alinhar bem ao usar um preenchimento de 8 dp.

O exemplo a seguir mostra um widget que usa system_app_widget_background_radius para o canto e system_app_widget_inner_radius para as visualizações dentro do widget.

1 Canto do widget.

2 Canto de uma visualização dentro do widget.

Considerações importantes sobre cantos arredondados

• Telas de início de terceiros e fabricantes de dispositivos podem substituir o parâmetro system_app_widget_background_radius para que ele seja menor que 28 dp. O parâmetro system_app_widget_inner_radius é sempre 8 dp menor que o valor de system_app_widget_background_radius.
• Se o widget não usar @android:id/background ou definir um plano de fundo que recorte o conteúdo com base no contorno, com android:clipToOutline definido como true, o iniciador vai identificar automaticamente o plano de fundo e recortar o widget usando um retângulo com cantos arredondados de até 16 dp. Consulte Garantir que o widget seja compatível com o Android 12.

Para garantir a compatibilidade do widget com versões anteriores do Android, recomendamos definir atributos personalizados e usar um tema personalizado para substituí-los no Android 12, conforme mostrado nos exemplos de arquivos XML a seguir:

<resources>
  <attr name="backgroundRadius" format="dimension" />
</resources>

<resources>
  <style name="MyWidgetTheme">
    <item name="backgroundRadius">@dimen/my_background_radius_dimen</item>
  </style>
</resources>

<resources>
  <style name="MyWidgetTheme" parent="@android:style/Theme.DeviceDefault.DayNight">
    <item name="backgroundRadius">@android:dimen/system_app_widget_background_radius</item>
  </style>
</resources>

<shape xmlns:android="http://schemas.android.com/apk/res/android"
  android:shape="rectangle">
  <corners android:radius="?attr/backgroundRadius" />
  ...
</shape>

<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
  ...
  android:background="@drawable/my_widget_background" />