Oferecer layouts de widget flexíveis

Esta página descreve os refinamentos para dimensionamento de widgets e maior flexibilidade introduzidos no Android 12 (nível 31 da API). Ele também detalha como determinar um tamanho para o widget.

Usar APIs melhoradas para tamanhos e layouts de widgets

A partir do Android 12 (nível 31 da API), é possível fornecer atributos de tamanho mais refinados e layouts flexíveis fazendo o seguinte, conforme descrito nas seções a seguir:

1. Especifique outras restrições de dimensionamento de widgets.

2. Fornecer layouts responsivos ou layouts exatos.

Em versões anteriores do Android, era possível conferir os tamanhos de um widget usando os extras OPTION_APPWIDGET_MIN_WIDTH, OPTION_APPWIDGET_MIN_HEIGHT, OPTION_APPWIDGET_MAX_WIDTH e OPTION_APPWIDGET_MAX_HEIGHT e, em seguida, estimar o tamanho do widget, mas essa lógica não funciona em todas as situações. Para widgets destinados ao Android 12 ou mais recente, recomendamos fornecer layouts responsivos ou exatos.

Especificar outras restrições de dimensionamento do widget

O Android 12 adiciona APIs para garantir que o widget seja dimensionado de forma mais confiável em diferentes dispositivos com diferentes tamanhos de tela.

Além dos atributos minWidth, minHeight, minResizeWidth, e minResizeHeight, use os novos atributos appwidget-provider a seguir:

• targetCellWidth e targetCellHeight: definem o tamanho de destino do widget em termos de células de grade na tela de início. Se definidos, esses atributos serão usados em vez de minWidth ou minHeight.

• maxResizeWidth e maxResizeHeight: definem o tamanho máximo permitido pela tela de início ao usuário para redimensionar o widget.

O XML a seguir mostra como usar os atributos de dimensionamento.

<appwidget-provider
  ...
  android:targetCellWidth="3"
  android:targetCellHeight="2"
  android:maxResizeWidth="250dp"
  android:maxResizeHeight="110dp">
</appwidget-provider>

Fornecer layouts responsivos

Se o layout precisar mudar dependendo do tamanho do widget, recomendamos criar um pequeno conjunto de layouts, cada um válido para uma série de tamanhos. Se isso não for possível, outra opção é fornecer layouts com base no tamanho exato do widget durante a execução, conforme descrito nesta página.

Esse recurso melhora a escala e a integridade do sistema em geral, porque o sistema não precisa ativar o app sempre que ele mostra o widget em um tamanho diferente.

O exemplo de código a seguir mostra como fornecer uma lista de layouts.

override fun onUpdate(...) {
    val smallView = ...
    val tallView = ...
    val wideView = ...

    val viewMapping: Map<SizeF, RemoteViews> = mapOf(
            SizeF(150f, 100f) to smallView,
            SizeF(150f, 200f) to tallView,
            SizeF(215f, 100f) to wideView
    )
    val remoteViews = RemoteViews(viewMapping)

    appWidgetManager.updateAppWidget(id, remoteViews)
}

@Override
public void onUpdate(...) {
    RemoteViews smallView = ...;
    RemoteViews tallView = ...;
    RemoteViews wideView = ...;

    Map<SizeF, RemoteViews> viewMapping = new ArrayMap<>();
    viewMapping.put(new SizeF(150f, 100f), smallView);
    viewMapping.put(new SizeF(150f, 200f), tallView);
    viewMapping.put(new SizeF(215f, 100f), wideView);
    RemoteViews remoteViews = new RemoteViews(viewMapping);

    appWidgetManager.updateAppWidget(id, remoteViews);
}

Suponha que o widget tenha os seguintes atributos:

<appwidget-provider
    android:minResizeWidth="160dp"
    android:minResizeHeight="110dp"
    android:maxResizeWidth="250dp"
    android:maxResizeHeight="200dp">
</appwidget-provider>

O snippet de código anterior significa o seguinte:

• smallView oferece suporte de 160 dp (minResizeWidth) × 110 dp (minResizeHeight) a 160 dp × 199 dp (próximo ponto de corte - 1 dp).
• tallView oferece suporte de 160 dp × 200 dp a 214 dp (próximo ponto de corte - 1) × 200 dp.

• wideView oferece suporte de 215 dp × 110 dp (minResizeHeight) a 250 dp (maxResizeWidth) × 200 dp (maxResizeHeight).

Seu widget precisa oferecer suporte ao intervalo de tamanhos de minResizeWidth × minResizeHeight a maxResizeWidth × maxResizeHeight. Dentro desse intervalo, é possível definir o ponto de corte para alternar os layouts.

Fornecer layouts exatos

Se não for viável usar um pequeno conjunto de layouts responsivos, é possível fornecer layouts diferentes de acordo com os tamanhos de exibição do widget. Normalmente, há dois tamanhos para smartphones (modo retrato e paisagem) e quatro para dispositivos dobráveis.

Para implementar essa solução, o app precisa realizar as seguintes etapas:

1. Sobrecarregue AppWidgetProvider.onAppWidgetOptionsChanged(), que é chamado quando o conjunto de tamanhos muda.

2. Chame AppWidgetManager.getAppWidgetOptions(), que retorna um Bundle contendo os tamanhos.

3. Acesse a chave AppWidgetManager.OPTION_APPWIDGET_SIZES do Bundle.

O exemplo de código a seguir mostra como fornecer layouts exatos.

override fun onAppWidgetOptionsChanged(
        context: Context,
        appWidgetManager: AppWidgetManager,
        id: Int,
        newOptions: Bundle?
) {
    super.onAppWidgetOptionsChanged(context, appWidgetManager, id, newOptions)
    // Get the new sizes.
    val sizes = newOptions?.getParcelableArrayList<SizeF>(
            AppWidgetManager.OPTION_APPWIDGET_SIZES
    )
    // Check that the list of sizes is provided by the launcher.
    if (sizes.isNullOrEmpty()) {
        return
    }
    // Map the sizes to the RemoteViews that you want.
    val remoteViews = RemoteViews(sizes.associateWith(::createRemoteViews))
    appWidgetManager.updateAppWidget(id, remoteViews)
}

// Create the RemoteViews for the given size.
private fun createRemoteViews(size: SizeF): RemoteViews { }

@Override
public void onAppWidgetOptionsChanged(
    Context context, AppWidgetManager appWidgetManager, int appWidgetId, Bundle newOptions) {
    super.onAppWidgetOptionsChanged(context, appWidgetManager, appWidgetId, newOptions);
    // Get the new sizes.
    ArrayList<SizeF> sizes =
        newOptions.getParcelableArrayList(AppWidgetManager.OPTION_APPWIDGET_SIZES);
    // Check that the list of sizes is provided by the launcher.
    if (sizes == null || sizes.isEmpty()) {
      return;
    }
    // Map the sizes to the RemoteViews that you want.
    Map<SizeF, RemoteViews> viewMapping = new ArrayMap<>();
    for (SizeF size : sizes) {
        viewMapping.put(size, createRemoteViews(size));
    }
    RemoteViews remoteViews = new RemoteViews(viewMapping);
    appWidgetManager.updateAppWidget(id, remoteViews);
}

// Create the RemoteViews for the given size.
private RemoteViews createRemoteViews(SizeF size) { }

Determinar um tamanho para o widget

Cada widget precisa definir um targetCellWidth e targetCellHeight para dispositivos com o Android 12 ou mais recente, ou minWidth e minHeight para todas as versões do Android, indicando a quantidade mínima de espaço que ele consome por padrão. No entanto, quando os usuários adicionam um widget à tela inicial, ele geralmente ocupa mais que a largura e a altura mínimas especificadas.

As telas iniciais do Android oferecem aos usuários uma grade de espaços disponíveis em que eles podem colocar widgets e ícones. Essa grade pode variar de acordo com o dispositivo. Por exemplo, muitos smartphones oferecem uma grade de 5x4, e os tablets podem oferecer uma grade maior. Quando o widget é adicionado, ele é esticado para ocupar o número mínimo de células, horizontal e verticalmente, necessário para satisfazer as restrições de targetCellWidth e targetCellHeight em dispositivos com Android 12 ou mais recente ou restrições de minWidth e minHeight em dispositivos com Android 11 (nível 30 da API) ou versões anteriores.

A largura e a altura de uma célula, assim como o tamanho das margens automáticas aplicadas aos widgets, podem variar de acordo com o dispositivo. Use a tabela a seguir para estimar aproximadamente as dimensões mínimas do widget em um dispositivo de grade 5x4, considerando o número de células ocupadas que você quer:

Use os tamanhos de célula do modo retrato para informar os valores fornecidos para os atributos minWidth, minResizeWidth e maxResizeWidth. Da mesma forma, use os tamanhos de célula do modo paisagem para informar os valores que você fornece para os atributos minHeight, minResizeHeight e maxResizeHeight.

Isso ocorre porque a largura da célula geralmente é menor no modo retrato do que no modo paisagem. Da mesma forma, a altura da célula geralmente é menor no modo paisagem do que no modo retrato.

Por exemplo, se você quiser que a largura do widget seja redimensionável para uma célula em um Google Pixel 4, defina minResizeWidth como no máximo 56 dp para garantir que o valor do atributo minResizeWidth seja menor que 57 dp, porque uma célula tem pelo menos 57 dp de largura no modo retrato. Da mesma forma, se você quiser que a altura do widget seja redimensionável em uma célula no mesmo dispositivo, defina minResizeHeight como no máximo 50 dp para garantir que o valor do atributo minResizeHeight seja menor que 51 dp, porque uma célula tem pelo menos 51 dp de altura no modo paisagem.

Cada widget pode ser redimensionado dentro dos intervalos de tamanho entre os atributos minResizeWidth/minResizeHeight e maxResizeWidth/maxResizeHeight, o que significa que ele precisa se adaptar a todos os intervalos de tamanho entre eles.

Por exemplo, para definir o tamanho padrão do widget no posicionamento, é possível definir os seguintes atributos:

<appwidget-provider
    android:targetCellWidth="3"
    android:targetCellHeight="2"
    android:minWidth="180dp"
    android:minHeight="110dp">
</appwidget-provider>

Isso significa que o tamanho padrão do widget é de 3 x 2 células, conforme especificado pelos atributos targetCellWidth e targetCellHeight, ou 180 x 110 dp, conforme especificado por minWidth e minHeight para dispositivos com Android 11 ou versões anteriores. Nesse último caso, o tamanho nas células pode variar dependendo do dispositivo.

Além disso, para definir os intervalos de tamanho aceitos do widget, você pode definir os seguintes atributos:

<appwidget-provider
    android:minResizeWidth="180dp"
    android:minResizeHeight="110dp"
    android:maxResizeWidth="530dp"
    android:maxResizeHeight="450dp">
</appwidget-provider>

Conforme especificado pelos atributos anteriores, a largura do widget pode ser redimensionada de 180 dp a 530 dp, e a altura pode ser redimensionada de 110 dp a 450 dp. O widget pode ser redimensionado de 3x2 para 5x2 células, desde que as seguintes condições estejam presentes:

• O dispositivo tem a grade 5x4.
• O mapeamento entre o número de células e o tamanho disponível em DPS segue a tabela mostrando a estimativa das dimensões mínimas nesta página.
• O widget se adapta a esse intervalo de tamanho.

val smallView = RemoteViews(context.packageName, R.layout.widget_weather_forecast_small)
val mediumView = RemoteViews(context.packageName, R.layout.widget_weather_forecast_medium)
val largeView = RemoteViews(context.packageName, R.layout.widget_weather_forecast_large)

val viewMapping: Map<SizeF, RemoteViews> = mapOf(
        SizeF(180f, 110f) to smallView,
        SizeF(270f, 110f) to mediumView,
        SizeF(270f, 280f) to largeView
)

appWidgetManager.updateAppWidget(appWidgetId, RemoteViews(viewMapping))

RemoteViews smallView = 
    new RemoteViews(context.getPackageName(), R.layout.widget_weather_forecast_small);
RemoteViews mediumView = 
    new RemoteViews(context.getPackageName(), R.layout.widget_weather_forecast_medium);
RemoteViews largeView = 
    new RemoteViews(context.getPackageName(), R.layout.widget_weather_forecast_large);

Map<SizeF, RemoteViews> viewMapping = new ArrayMap<>();
viewMapping.put(new SizeF(180f, 110f), smallView);
viewMapping.put(new SizeF(270f, 110f), mediumView);
viewMapping.put(new SizeF(270f, 280f), largeView);
RemoteViews remoteViews = new RemoteViews(viewMapping);

appWidgetManager.updateAppWidget(id, remoteViews);

Suponha que o widget use os layouts responsivos definidos nos snippets de código anteriores. Isso significa que o layout especificado como R.layout.widget_weather_forecast_small é usado de 180 dp (minResizeWidth) x 110 dp (minResizeHeight) a 269 x 279 dp (próximos pontos de corte - 1). Da mesma forma, R.layout.widget_weather_forecast_medium é usado de 270x110 dp a 270x279 dp, e R.layout.widget_weather_forecast_large é usado de 270x280 dp a 530 dp (maxResizeWidth) x 450 dp (maxResizeHeight).

À medida que o usuário redimensiona o widget, a aparência dele muda para se adaptar a cada tamanho nas células, conforme mostrado nos exemplos a seguir.