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 os modificadores como nós de wrapper para os nós de layout:

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 simplesmente nós de layout que descrevem como dispor os filhos.

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 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.

• Ilimitado: o nó não está restrito a nenhum tamanho. Os limites máximos de largura e altura são definidos como infinito.

• Exata: o nó precisa seguir um requisito de tamanho exato. Os limites mínimo e máximo são definidos com o mesmo valor.

• Combinação: o nó segue uma combinação dos tipos de restrição acima. 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.

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 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.

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:

O modificador size adapta as restrições recebidas para corresponder ao valor transmitido a ele. Neste exemplo, o valor é 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:

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:

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:

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:

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.

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:

• 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:

• 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:

• 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 100 por 100dp.
  • O modificador padding adiciona 10dp a todos os tamanhos, aumentando a largura e a altura informadas em 20dp.
  • Agora, na fase de desenho, o modificador clip atua em uma tela de 120 por 120dp. Assim, ele cria uma máscara circular desse tamanho.
  • O modificador padding insere o conteúdo em 10dp em todos os tamanhos, reduzindo o tamanho da tela para 100 por 100dp.
  • O Image é desenhado nessa tela. A imagem é cortada com base no círculo original de 120dp, então o resultado não é redondo.