Restrições e ordem dos modificadores

No Compose, é possível encadear vários modificadores para mudar a aparência de um elemento combinável. Essas cadeias de modificadores podem afetar as restrições transmitidas aos elementos combináveis, que definem limites de largura e altura.

Nesta página, descrevemos como os modificadores encadeados afetam as restrições e, por sua vez, a medição e o posicionamento dos elementos combináveis.

Modificadores na árvore da interface

Para entender como os modificadores se influenciam, é útil visualizar como eles aparecem na árvore da interface, que é gerada durante a fase de composição. Para mais informações, consulte a seção Composição.

Na árvore da interface, é possível visualizar modificadores como nós de wrapper para os nós de layout:

Código para elementos combináveis e modificadores, além da representação visual deles como uma árvore de UI.
Figura 1. Modificadores que encapsulam nós de layout na árvore de UI.

Adicionar mais de um modificador a um elemento combinável cria uma cadeia de modificadores. Quando você encadeia vários modificadores, cada nó de modificador encapsula o restante da cadeia e o nó de layout dentro. Por exemplo, quando você encadeia um clip e um modificador size, o nó do modificador clip envolve o nó do modificador size, que, por sua vez, envolve o nó de layout Image.

Na fase de layout, o algoritmo que percorre a árvore permanece o mesmo, mas cada nó modificador também é visitado. Assim, um modificador pode mudar os requisitos de tamanho e o posicionamento do modificador ou do nó de layout que ele envolve.

Como mostrado na Figura 2, a implementação dos elementos combináveis Image e Text consiste em uma cadeia de modificadores que envolvem um único nó de layout.

As implementações de Row e Column são nós de layout que descrevem como dispor os elementos filhos.

A estrutura de árvore de antes, mas agora cada nó é apenas um layout simples, com muitos nós de encapsulamento de modificadores ao redor.
Figura 2. A mesma estrutura de árvore da Figura 1, mas com elementos combináveis na árvore de UI visualizados como cadeias de modificadores.

Para resumir:

  • Os modificadores envolvem um único modificador ou nó de layout.
  • Os nós de layout podem dispor vários nós filhos.

As seções a seguir descrevem como usar esse modelo mental para refletir sobre o encadeamento de modificadores e como ele influencia o tamanho dos elementos combináveis.

Restrições na fase de layout

A fase de layout segue um algoritmo de três etapas para encontrar a largura, a altura e as coordenadas x e y de cada nó de layout:

  1. Medir filhos: um nó mede os filhos, se houver.
  2. Decidir o próprio tamanho: com base nessas medições, um nó decide o próprio tamanho.
  3. Posicionar filhos: cada nó filho é posicionado em relação à posição do próprio nó.

Constraints ajuda a encontrar os tamanhos certos para os nós durante as duas primeiras etapas do algoritmo. As restrições definem os limites mínimo e máximo para a largura e a altura de um nó. Quando o nó decide o tamanho, o tamanho medido precisa estar dentro desse intervalo.

Tipos de restrições

Uma restrição pode ser uma das seguintes opções:

  • Delimitado: o nó tem uma largura e altura máximas e mínimas.
Restrições delimitadas de tamanhos diferentes em um contêiner.
Figura 3. Restrições limitadas.
  • Ilimitado: o nó não está restrito a nenhum tamanho. Os limites máximos de largura e altura são definidos como infinito.
Restrições sem limites com largura e altura definidas como infinito. As restrições vão além do contêiner.
Figura 4. Restrições sem limites.
  • Exata: o nó precisa seguir um requisito de tamanho exato. Os limites mínimo e máximo são definidos com o mesmo valor.
Restrições exatas que obedecem a um requisito de tamanho exato dentro do contêiner.
Figura 5. Restrições exatas.
  • Combinação: o nó segue uma combinação dos tipos de restrição anteriores. Por exemplo, uma restrição pode limitar a largura e permitir uma altura máxima ilimitada ou definir uma largura exata, mas fornecer uma altura limitada.
Dois contêineres que mostram combinações de restrições limitadas e ilimitadas e larguras e alturas exatas.
Figura 6. Combinações de restrições vinculadas e não vinculadas e larguras e alturas exatas.

A próxima seção descreve como essas restrições são transmitidas de um pai para um filho.

Como as restrições são transmitidas de um familiar responsável para uma criança

Durante a primeira etapa do algoritmo descrito em Restrições na fase de layout, as restrições são transmitidas do elemento pai para o filho na árvore da interface.

Quando um nó pai mede os filhos, ele fornece essas restrições a cada filho para informar o tamanho máximo e mínimo permitido. Depois, quando ele decide o próprio tamanho, também obedece às restrições transmitidas pelos próprios pais.

Em geral, o algoritmo funciona da seguinte maneira:

  1. Para decidir o tamanho que quer ocupar, o nó raiz na árvore de UI mede os filhos e encaminha as mesmas restrições ao primeiro filho.
  2. Se a criança for um modificador que não afeta a medição, ela encaminhará as restrições para o próximo modificador. As restrições são transmitidas pela cadeia de modificadores sem alterações, a menos que um modificador que afete a medição seja alcançado. As restrições são redimensionadas de acordo.
  3. Quando um nó sem filhos (chamado de "nó folha") é alcançado, ele decide o tamanho com base nas restrições transmitidas e retorna esse tamanho resolvido ao pai.
  4. O elemento pai adapta as restrições com base nas medições do filho e chama o próximo filho com essas restrições ajustadas.
  5. Depois que todos os filhos de um pai são medidos, o nó pai decide o próprio tamanho e comunica isso ao pai dele.
  6. Dessa forma, toda a árvore é percorrida em profundidade. Eventualmente, todos os nós decidem os tamanhos, e a etapa de medição é concluída.

Para um exemplo detalhado, assista ao vídeo Restrições e ordem de modificadores.

Modificadores que afetam restrições

Na seção anterior, você aprendeu que alguns modificadores podem afetar o tamanho da restrição. As seções a seguir descrevem modificadores específicos que afetam as restrições.

O modificador size

O modificador size declara o tamanho preferencial do conteúdo.

Por exemplo, a seguinte árvore de UI precisa ser renderizada em um contêiner de 300dp por 200dp. As restrições são limitadas, permitindo larguras entre 100dp e 300dp, e alturas entre 100dp e 200dp:

Uma parte de uma árvore de interface com o modificador de tamanho envolvendo um nó de layout e a representação das restrições limitadas definidas pelo modificador de tamanho em um contêiner.
Figura 7. Restrições limitadas na árvore da interface e na representação dela em um container.

O modificador size adapta as restrições recebidas para corresponder ao valor transmitido a ele. Neste exemplo, o valor é 150dp:

Igual à Figura 7, exceto que o modificador de tamanho adapta as restrições recebidas para corresponder ao valor transmitido a ele.
Figura 8. O modificador size ajustando as restrições para 150dp.

Se a largura e a altura forem menores que o menor limite de restrição ou maiores que o maior limite, o modificador vai corresponder às restrições transmitidas o mais próximo possível, sem deixar de obedecer às restrições transmitidas em:

Duas árvores de interface e as representações correspondentes em contêineres. No primeiro, o modificador de tamanho aceita as restrições recebidas. No segundo, ele se adapta às restrições muito grandes o mais próximo possível, resultando em restrições que preenchem o contêiner.
Figura 9. O modificador size aderindo à restrição transmitida o mais próximo possível.

Não é possível encadear vários modificadores size. O primeiro modificador size define as restrições mínima e máxima como um valor fixo. Mesmo que o segundo modificador de tamanho solicite um tamanho menor ou maior, ele ainda precisa obedecer aos limites exatos transmitidos, portanto, não vai substituir esses valores:

Uma cadeia de dois modificadores de tamanho na árvore da interface e sua representação em um contêiner, que é o resultado do primeiro valor transmitido e não do segundo.
Figura 10. Uma cadeia de dois modificadores size, em que o segundo valor transmitido (50dp) não substitui o primeiro valor (100dp).

O modificador requiredSize

Use o modificador requiredSize em vez de size se precisar que seu nó substitua as restrições recebidas. O modificador requiredSize substitui as restrições recebidas e transmite o tamanho especificado como limites exatos.

Quando o tamanho é transmitido de volta para cima na árvore, o nó filho é centralizado no espaço disponível:

O modificador size e requiredSize encadeados em uma árvore de UI e a representação correspondente em um contêiner. As restrições do modificador requiredSize substituem as restrições do modificador de tamanho.
Figura 11. O modificador requiredSize substitui as restrições recebidas do modificador size.

Os modificadores width e height

O modificador size adapta a largura e a altura das restrições. Com o modificador width, é possível definir uma largura fixa, mas deixar a altura indefinida. Da mesma forma, com o modificador height, é possível definir uma altura fixa, mas deixar a largura indefinida:

Duas árvores de interface, uma com o modificador de largura e a representação do contêiner, e a outra com o modificador de altura e a representação.
Figura 12. O modificador width e o modificador height definem uma largura e uma altura fixas, respectivamente.

O modificador sizeIn

O modificador sizeIn permite definir restrições mínimas e máximas exatas para largura e altura. Use o modificador sizeIn se precisar de um controle refinado sobre as restrições.

Uma árvore de interface com o modificador sizeIn e larguras e alturas mínimas e máximas definidas, e sua representação em um contêiner.
Figura 13. O modificador sizeIn com os conjuntos minWidth, maxWidth, minHeight e maxHeight.

Exemplos

Esta seção mostra e explica a saída de vários snippets de código com modificadores encadeados.

Image(
    painterResource(R.drawable.hero),
    contentDescription = null,
    Modifier
        .fillMaxSize()
        .size(50.dp)
)
ConstraintsModifiersSnippets.kt

Esse snippet produz a seguinte saída:

Um quadrado azul que preenche o contêiner principal.
Figura 14. O Image preenche o tamanho máximo como resultado da cadeia de modificadores.
  • O modificador fillMaxSize muda as restrições para definir a largura e a altura mínimas com o valor máximo: 300dp na largura e 200dp na altura.
  • Embora o modificador size queira usar um tamanho de 50dp, ele ainda precisa obedecer às restrições mínimas de entrada. Assim, o modificador size também vai gerar os limites exatos da restrição de 300 por 200, ignorando o valor fornecido no modificador size.
  • O Image segue esses limites e informa um tamanho de 300 por 200, que é transmitido por toda a árvore.

Image(
    painterResource(R.drawable.hero),
    contentDescription = null,
    Modifier
        .fillMaxSize()
        .wrapContentSize()
        .size(50.dp)
)
ConstraintsModifiersSnippets.kt

Esse snippet produz a seguinte saída:

Um pequeno quadrado azul centralizado no contêiner pai.
Figura 15. O Image é centralizado e dimensionado para 50dp.
  • O modificador fillMaxSize adapta as restrições para definir a largura e a altura mínimas com o valor máximo: 300dp na largura e 200dp na altura.
  • O modificador wrapContentSize redefine as restrições mínimas. Assim, enquanto fillMaxSize resultou em restrições fixas, wrapContentSize redefine para restrições limitadas. O nó a seguir pode ocupar todo o espaço novamente ou ser menor que ele.
  • O modificador size define as restrições para os limites mínimo e máximo de 50.
  • O Image é resolvido para um tamanho de 50 por 50, e o modificador size encaminha isso.
  • O modificador wrapContentSize tem uma propriedade especial. Ele pega o filho e o coloca no centro dos limites mínimos disponíveis que foram transmitidos a ele. Portanto, o tamanho que ele comunica aos pais é igual aos limites mínimos transmitidos a ele.

Ao combinar apenas três modificadores, você pode definir um tamanho para o elemento combinável e centralizá-lo no elemento pai.

Image(
    painterResource(R.drawable.hero),
    contentDescription = null,
    Modifier
        .clip(CircleShape)
        .padding(10.dp)
        .size(100.dp)
)
ConstraintsModifiersSnippets.kt

Esse snippet produz a seguinte saída:

Uma forma circular que foi cortada incorretamente devido à ordem dos modificadores.
Figura 16. Uma forma cortada incorretamente devido à ordem dos modificadores.
  • O modificador clip não muda as restrições.
  • O modificador padding reduz as restrições máximas.
  • O modificador size define todas as restrições como 100dp.
  • O Image obedece a essas restrições e informa um tamanho de 100dp por 100dp.
  • O modificador padding adiciona 10dp em todos os lados ao tamanho informado pelo Image. Assim, o layout com padding informa uma largura e uma altura de 120dp.
  • Agora, na fase de desenho, o modificador clip atua em uma tela de 120dp por 120dp. Isso cria uma máscara circular desse tamanho.
  • O modificador padding insere o conteúdo em 10dp em todos os lados, o que reduz o tamanho da tela para o Image de 100dp em 100dp.
  • O Image é desenhado nessa tela menor. A imagem é cortada com base no círculo original de 120dp, então a saída é um resultado não redondo.
Anterior
Conceitos básicos de layout
Avançar
Modificadores personalizados