Contraintes et ordre des modificateurs

Dans Compose, vous pouvez enchaîner plusieurs modificateurs pour modifier l'apparence d'un composable. Ces chaînes de modificateurs peuvent affecter les contraintes transmises aux composables, qui définissent les limites de largeur et de hauteur.

Cette page décrit l'impact des modificateurs enchaînés sur les contraintes et, par conséquent, sur la mesure et l'emplacement des composables.

Modificateurs dans l'arborescence d'UI

Pour comprendre comment les modificateurs s'influencent mutuellement, il est utile de visualiser comment ils apparaissent dans l'arborescence de l'interface utilisateur, qui est générée pendant la phase de composition. Pour en savoir plus, consultez la section Composition.

Dans l'arborescence de l'UI, vous pouvez visualiser les modificateurs en tant que nœuds de wrapper pour les nœuds de mise en page :

L'ajout de plusieurs modificateurs à un composable crée une chaîne de modificateurs. Lorsque vous enchaînez plusieurs modificateurs, chaque nœud de modificateur encapsule le reste de la chaîne et le nœud de mise en page qu'il contient. Par exemple, lorsque vous associez un modificateur clip et un modificateur size, le nœud du modificateur clip encapsule le nœud du modificateur size, qui encapsule ensuite le nœud de mise en page Image.

Dans la phase de mise en page, l'algorithme qui parcourt l'arborescence reste le même, mais chaque nœud de modificateur est également visité. De cette façon, un modificateur peut modifier les exigences de taille et l'emplacement du modificateur ou du nœud de mise en page qu'il encapsule.

Comme illustré dans la figure 2, l'implémentation des composables Image et Text consiste en une chaîne de modificateurs encapsulant un seul nœud de mise en page.

Les implémentations de Row et Column sont des nœuds de mise en page qui décrivent comment disposer leurs enfants.

En résumé :

• Les modificateurs encapsulent un seul modificateur ou nœud de mise en page.
• Les nœuds de mise en page peuvent disposer plusieurs nœuds enfants.

Les sections suivantes décrivent comment utiliser ce modèle mental pour comprendre l'enchaînement des modificateurs et comment il influence la taille des composables.

Contraintes lors de la phase de mise en page

La phase de mise en page suit un algorithme en trois étapes pour trouver la largeur, la hauteur et les coordonnées x et y de chaque nœud de mise en page :

1. Mesurer les enfants : un nœud mesure ses enfants, le cas échéant.
2. Déterminer sa propre taille : en fonction de ces mesures, un nœud détermine sa propre taille.
3. Placer les enfants : chaque nœud enfant est placé par rapport à la position d'un nœud.

Constraints aide à trouver les tailles appropriées pour les nœuds au cours des deux premières étapes de l'algorithme. Les contraintes définissent les limites minimale et maximale de la largeur et de la hauteur d'un nœud. Lorsque le nœud détermine sa taille, sa taille mesurée doit se situer dans cette plage de tailles.

Types de contraintes

Une contrainte peut être l'une des suivantes :

• Bounded : le nœud a une largeur et une hauteur maximales et minimales.

• Non limité : le nœud n'est limité à aucune taille. Les limites de largeur et de hauteur maximales sont définies sur l'infini.

• Exact : le nœud doit respecter une exigence de taille exacte. Les limites minimale et maximale sont définies sur la même valeur.

• Combinaison : le nœud suit une combinaison des types de contraintes précédents. Par exemple, une contrainte peut limiter la largeur tout en autorisant une hauteur maximale illimitée, ou définir une largeur exacte, mais fournir une hauteur limitée.

La section suivante décrit comment ces contraintes sont transmises d'un parent à un enfant.

Comment les contraintes sont transmises du parent à l'enfant

Lors de la première étape de l'algorithme décrit dans Contraintes de la phase de mise en page, les contraintes sont transmises du parent à l'enfant dans l'arborescence de l'UI.

Lorsqu'un nœud parent mesure ses enfants, il fournit ces contraintes à chaque enfant pour lui indiquer la taille qu'il peut avoir. Ensuite, lorsqu'il décide de sa propre taille, il respecte également les contraintes transmises par ses propres parents.

De manière générale, l'algorithme fonctionne de la manière suivante :

1. Pour décider de la taille qu'il souhaite réellement occuper, le nœud racine de l'arborescence de l'UI mesure ses enfants et transmet les mêmes contraintes à son premier enfant.
2. Si l'enfant est un modificateur qui n'a pas d'impact sur la mesure, il transmet les contraintes au modificateur suivant. Les contraintes sont transmises telles quelles dans la chaîne de modificateurs, sauf si un modificateur ayant un impact sur la mesure est atteint. Les contraintes sont ensuite redimensionnées en conséquence.
3. Lorsqu'un nœud n'a pas d'enfant (appelé "nœud feuille"), il détermine sa taille en fonction des contraintes transmises et renvoie cette taille résolue à son parent.
4. Le parent adapte ses contraintes en fonction des mesures de cet enfant et appelle son enfant suivant avec ces contraintes ajustées.
5. Une fois que tous les enfants d'un parent ont été mesurés, le nœud parent décide de sa propre taille et la communique à son propre parent.
6. De cette façon, l'ensemble de l'arbre est parcouru en profondeur d'abord. Enfin, tous les nœuds ont déterminé leur taille, et l'étape de mesure est terminée.

Pour un exemple détaillé, regardez la vidéo Contraintes et ordre des modificateurs.

Modificateurs qui affectent les contraintes

Dans la section précédente, vous avez appris que certains modificateurs peuvent affecter la taille des contraintes. Les sections suivantes décrivent les modificateurs spécifiques qui ont un impact sur les contraintes.

Le modificateur size

Le modificateur size déclare la taille souhaitée du contenu.

Par exemple, l'arborescence d'interface utilisateur suivante doit être affichée dans un conteneur de 300dp par 200dp. Les contraintes sont limitées, ce qui permet d'obtenir des largeurs comprises entre 100dp et 300dp, et des hauteurs comprises entre 100dp et 200dp :

Le modificateur size adapte les contraintes entrantes pour qu'elles correspondent à la valeur qui lui est transmise. Dans cet exemple, la valeur est 150dp :

Si la largeur et la hauteur sont inférieures à la limite de contrainte la plus petite ou supérieures à la limite de contrainte la plus grande, le modificateur correspond aux contraintes transmises aussi précisément que possible, tout en respectant les contraintes transmises :

Notez que l'enchaînement de plusieurs modificateurs size ne fonctionne pas. Le premier modificateur size définit les contraintes minimale et maximale sur une valeur fixe. Même si le deuxième modificateur de taille demande une taille plus petite ou plus grande, il doit toujours respecter les limites exactes transmises. Il ne remplacera donc pas ces valeurs :

Le modificateur requiredSize

Utilisez le modificateur requiredSize au lieu de size si vous avez besoin que votre nœud remplace les contraintes entrantes. Le modificateur requiredSize remplace les contraintes entrantes et transmet la taille que vous spécifiez en tant que limites exactes.

Lorsque la taille est transmise à l'arborescence, le nœud enfant est centré dans l'espace disponible :

Modificateurs width et height

Le modificateur size adapte à la fois la largeur et la hauteur des contraintes. Le modificateur width vous permet de définir une largeur fixe, mais de laisser la hauteur indéterminée. De même, avec le modificateur height, vous pouvez définir une hauteur fixe, mais laisser la largeur indéterminée :

Le modificateur sizeIn

Le modificateur sizeIn vous permet de définir des contraintes minimales et maximales exactes pour la largeur et la hauteur. Utilisez le modificateur sizeIn si vous avez besoin d'un contrôle précis des contraintes.

Exemples

Cette section présente et explique le résultat de plusieurs extraits de code avec des modificateurs enchaînés.

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

Cet extrait génère le résultat suivant :

• Le modificateur fillMaxSize modifie les contraintes pour définir la largeur et la hauteur minimales sur la valeur maximale : 300dp en largeur et 200dp en hauteur.
• Même si le modificateur size souhaite utiliser une taille de 50dp, il doit toujours respecter les contraintes minimales entrantes. Le modificateur size générera donc également les limites de contrainte exactes de 300 par 200, en ignorant la valeur fournie dans le modificateur size.
• Le Image suit ces limites et indique une taille de 300 par 200, qui est transmise jusqu'en haut de l'arborescence.

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

Cet extrait génère le résultat suivant :

• Le modificateur fillMaxSize adapte les contraintes pour définir la largeur et la hauteur minimales sur la valeur maximale : 300dp en largeur et 200dp en hauteur.
• Le modificateur wrapContentSize réinitialise les contraintes minimales. Ainsi, alors que fillMaxSize a entraîné des contraintes fixes, wrapContentSize le réinitialise en contraintes limitées. Le nœud suivant peut désormais occuper à nouveau tout l'espace ou être plus petit que l'espace entier.
• Le modificateur size définit les contraintes sur les limites minimale et maximale de 50.
• Image est résolu à une taille de 50 par 50, et le modificateur size transmet cette information.
• Le modificateur wrapContentSize possède une propriété spéciale. Il prend son enfant et le place au centre des limites minimales disponibles qui lui ont été transmises. La taille qu'il communique à ses parents est donc égale aux limites minimales qui lui ont été transmises.

En combinant seulement trois modificateurs, vous pouvez définir une taille pour le composable et le centrer dans son parent.

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

Cet extrait génère le résultat suivant :

• Le modificateur clip ne modifie pas les contraintes.
• Le modificateur padding réduit les contraintes maximales.
• Le modificateur size définit toutes les contraintes sur 100dp.
• Le Image respecte ces contraintes et indique une taille de 100dp par 100dp.
• Le modificateur padding ajoute 10dp de tous les côtés à la taille signalée par Image. La mise en page avec marge intérieure indique donc une largeur et une hauteur de 120dp.
• Maintenant, dans la phase de dessin, le modificateur clip agit sur un canevas de 120dp par 120dp. Il crée un masque circulaire de cette taille.
• Le modificateur padding insère ensuite son contenu de 10dp de tous les côtés, ce qui réduit la taille de la zone de dessin pour Image à 100dp par 100dp.
• Le Image est dessiné dans ce canevas plus petit. L'image est découpée en fonction du cercle d'origine de 120dp. Le résultat n'est donc pas rond.