LayoutBase  - AS3 Flex

Si la valeur est true, indique d’écrêter les enfants aux limites de la fenêtre. Si la valeur est false, les enfants du conteneur s’étendent au-delà des limites du conteneur, quelle que soit la spécification de taille du composant.

La valeur par défaut est false.

Objet DisplayObject utilisé par cette présentation pour l’indicateur de dépôt au cours d’une opération glisser-déposer. En règle générale, vous ne définissez pas cette propriété directement. Vous définissez une partie d’habillage dropIndicator dans la classe d’habillage de la cible de dépôt.

Le contrôle List définit cette propriété en réponse à un événement DragEvent.DRAG_ENTER. La classe List initialise cette propriété avec une instance de son composant d’habillage dropIndicator. La classe List efface cette propriété en réponse à un événement DragEvent.DRAG_EXIT.

Coordonnée x de l’origine de la fenêtre dans le système de coordonnées du composant, où la valeur par défaut est (0,0) correspondant au coin supérieur gauche du composant. Si la valeur de clipAndEnableScrolling est true, définir cette propriété entraîne généralement la définition de la fenêtre sur :

      new Rectangle(horizontalScrollPosition, verticalScrollPosition, width, height)
      

La valeur par défaut est 0.

Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement propertyChange .

Le conteneur GroupBase dont les éléments sont mesurés, dimensionnés et positionnés par cette mise en forme.

Les sous-classes peuvent remplacer l’accesseur d’initialisation pour effectuer des actions spécifiques aux cibles. Par exemple, une présentation 3D peut définir ici la propriété maintainProjectionCenter de la cible.

La valeur par défaut est null.

Eléments de l’API associés

Utilisé par les présentations lorsque des tailles de ligne/colonne fixes sont demandées mais qu’une taille spécifique n’est pas spécifié. Utilisé par les présentations virtuelles pour estimer la taille des éléments de présentation n’ayant pas fait l’objet d’un défilement pour être affichés.

Cette propriété fait référence à un composant utilisé par Flex pour définir la hauteur de tous les conteneurs enfant, comme l’illustre l’exemple suivant :

      <s:Group>
        <s:layout>
          <s:VerticalLayout variableRowHeight="false"
              typicalLayoutElement="{b3}"/> 
        </s:layout>
        <s:Button id="b1" label="Button 1"/>
        <s:Button id="b2" label="Button 2"/>
        <s:Button id="b3" label="Button 3" fontSize="36"/>
        <s:Button id="b4" label="Button 4" fontSize="24"/>
      </s:Group>

Si cette propriété n’a pas été définie et que la cible n’est pas nulle, le premier élément de présentation de la cible est mis en cache et renvoyé.

La valeur par défaut est le premier élément de mise en forme de la cible.

La valeur par défaut est null.

Eléments de l’API associés

Un conteneur peut contenir n’importe quel nombre d’enfants. Toutefois, chaque enfant nécessite une instance d’un rendu d’élément. Si le conteneur comporte de nombreux enfants, vous remarquerez peut-être une dégradation des performances au fur et à mesure que vous ajoutez d’autres enfants au conteneur.

Au lieu de créer un rendu d’élément pour chaque enfant, vous pouvez configurer le conteneur pour qu’il utilise une mise en forme virtuelle. La mise en forme virtuelle permet au conteneur de réutiliser les fonctionnalités de rendu d’élément pour créer uniquement des rendus d’élément pour les enfants du conteneur actuellement visibles. Lorsqu’un enfant est déplacé hors de l’écran, ce qui est possible en faisant défiler le conteneur, un nouvel enfant faisant l’objet d’un défilement à l’écran peut réutiliser son rendu d’élément.

Pour configurer l’utilisation d’une mise en forme virtuelle par un conteneur, définissez la propriété useVirtualLayout sur true pour la mise en forme associée au conteneur. Seul le conteneur DataGroup ou SkinnableDataContainer avec la présentation définie sur VerticalLayout, HorizontalLayout ou TileLayout prend en charge la présentation virtuelle. Les sous-classes de mise en page qui ne prennent pas en charge la virtualisation doivent empêcher la modification de cette propriété.

Remarque : la classe BasicLayout renvoie une erreur d’exécution, si vous définissez useVirtualLayout sur true.

Lorsque la valeur est true, les mises en page qui prennent en charge la virtualisation doivent utiliser target.getVirtualElementAt(), plutôt que getElementAt() et doivent seulement obtenir les éléments dont ils anticipent qu’ils seront visibles étant donnée la valeur du rectangle getScrollRect().

Lorsque la valeur est true, la classe de mise en forme doit être en mesure de calculer les index des éléments de mise en page qui chevauchent le rectangle scrollRect dans sa méthode updateDisplayList() basée exclusivement sur les informations mises en cache et non en lisant éléments de mise en forme et en examinant leurs limites.

En général les mises en page virtuelles mettent à jour leurs informations mises en cache dans updateDisplayList(), en fonction de la taille et de l’emplacement calculés pour les éléments dans la vue.

De même, à l’instant measure(), les mises en page virtuelles doivent mettre à jour les propriétés de taille mesurée de la cible en fonction de l’élément typicalLayoutElement et d’autres informations de mise en page mises en cache, et non en mesurant les éléments.

Les conteneurs coopèrent avec les présentations dont la propriété useVirtualLayout est définie sur true en recyclant les rendus d’éléments précédemment construits mais qui ne sont plus utilisés. Un élément est considéré comme n’étant plus utilisé si son index ne figure pas dans la plage des index getVirtualElementAt() demandés au cours de la dernière invocation updateDisplayList() du conteneur.

La valeur par défaut est false.

Eléments de l’API associés

Coordonnée y de l’origine de la fenêtre dans le système de coordonnées du composant, où la valeur par défaut est (0,0) correspondant au coin supérieur gauche du composant. Si la valeur de clipAndEnableScrolling est true, définir cette propriété entraîne généralement la définition de la fenêtre sur :

      new Rectangle(horizontalScrollPosition, verticalScrollPosition, width, height)
      

La valeur par défaut est 0.

Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement propertyChange .

Constructeur.

Calcule la longueur de défilement pour l’objet dropLocation spécifié lors d’une opération glisser-déposer. Appelé par la méthode showDropIndicator() pour calculer le défilement lors de l’opération de glissement-défilement.

Paramètres

Eléments de l’API associés

Renvoie l’index dans lequel un nouvel élément doit être inséré lorsque l’utilisateur relâche la souris sur les coordonnées spécifiées à l’issue d’un glisser-déposer. Appelé par la méthode calculatedDropLocation().

Paramètres

Eléments de l’API associés

Calcule les limites de l’indicateur de dépôt qui fournit des informations visuelles à l’utilisateur sur l’emplacement d’insertion des éléments à l’issue d’une opération glisser-déposer. Appelé par la méthode showDropIndicator().

Paramètres

Eléments de l’API associés

Calcule l’emplacement de dépôt dans le fournisseur de données de la cible de dépôt pour l’objet dragEvent spécifié.

Paramètres

Eléments de l’API associés

Lorsque useVirtualLayout est true, cette méthode peut être utilisée par la cible de mise en forme pour effacer les informations de mise en forme en cache lors de la modification de la cible.

Par exemple, lorsqu’une propriété dataProvider ou itemRenderer d’une classe DataGroup est modifiée, les tailles des éléments mis en cache ne sont plus valides.

Lorsque la propriété useVirtualLayout est définie sur false, cette méthode est appelée automatiquement.

Les sous-classes qui prennent en charge useVirtualLayout = true doivent remplacer cette méthode.

Appelée par la cible après ajout d’un élément de présentation et avant validation de la taille et de la liste d’affichage de la cible. Les présentations mises en cache par état d’élément (par exemple, les présentations virtuelles) peuvent remplacer cette méthode pour mettre à jour leur cache.

L’appel de cette méthode par la cible garantit uniquement qu’un élément de présentation existera à l’index spécifié à l’heure updateDisplayList() ; par exemple, une classe DataGroup comportant une présentation virtuelle appellera cette méthode lorsqu’un élément dataProvider est ajouté.

Par défaut, cette méthode n’a aucune action.

Paramètres

Eléments de l’API associés

Cette méthode doit être appelée par la cible après suppression d’un élément de présentation et avant validation de la taille et de la liste d’affichage de la cible. Les présentations mises en cache par état d’élément (par exemple, les présentations virtuelles) peuvent remplacer cette méthode pour mettre à jour leur cache.

La cible appelle cette méthode uniquement pour garantir qu’un élément de mise en forme n’existe plus à l’index spécifié lors de l’exécution de la méthode updateDisplayList(). Par exemple, une classe DataGroup avec une mise en forme virtuelle appelle cette méthode lorsqu’un élément est ajouté à la propriété dataProvider.

Par défaut, cette méthode n’a aucun effet.

Paramètres

Eléments de l’API associés

Renvoie les limites de présentation de l’élément spécifié en tant que rectangle ou null si l’index n’est pas valide, l’élément correspondant est nul ou includeInLayout=false, ou si la propriété target de la mise en forme est nulle.

Les sous-classes de présentation qui prennent en charge useVirtualLayout=true doivent remplacer cette méthode afin de calculer une valeur potentiellement approximative pour les éléments non visibles.

Paramètres

Eléments de l’API associés

Renvoie les limites du premier élément de présentation qui englobe ou est au-dessus du bord supérieur du rectangle scrollRect.

Il s’agit d’une méthode pratique utilisée par l’implémentation par défaut de la méthode getVerticalScrollPositionDelta(). Les sous-classes faisant appel à l’implémentation par défaut de la méthode getVerticalScrollPositionDelta() doivent remplacer cette méthode pour fournir un rectangle de sélection précis comportant des propriétés top et bottom valides.

Par défaut, cette méthode renvoie un rectangle avec width=0, height=1, dont le bord supérieur est inférieur de un par rapport au bord supérieur du rectangle scrollRect et left=0.

Les sous-classes doivent remplacer cette méthode pour fournir un rectangle de sélection précis comportant des propriétés top et bottom valides.

Paramètres

Eléments de l’API associés

Renvoie les limites du premier élément de présentation qui englobe ou est en dessous du bord inférieur du rectangle scrollRect.

Il s’agit d’une méthode pratique utilisée par l’implémentation par défaut de la méthode getVerticalScrollPositionDelta(). Les sous-classes faisant appel à l’implémentation par défaut de la méthode getVerticalScrollPositionDelta() doivent remplacer cette méthode pour fournir un rectangle de sélection précis comportant des propriétés top et bottom valides.

Par défaut, cette méthode renvoie un rectangle avec width=0, height=1, dont le bord inférieur est supérieur de un par rapport au bord inférieur du rectangle scrollRect et left=0.

Paramètres

Eléments de l’API associés

Renvoie les limites du premier élément de présentation qui englobe ou est à gauche du bord gauche du rectangle scrollRect.

Il s’agit d’une méthode pratique utilisée par l’implémentation par défaut de la méthode getHorizontalScrollPositionDelta(). Les sous-classes faisant appel à l’implémentation par défaut de la méthode getHorizontalScrollPositionDelta() doivent remplacer cette méthode pour fournir un rectangle de délimitation précis comportant des propriétés left et right valides.

Par défaut, cette méthode renvoie un rectangle avec width=1, height=0, dont le bord gauche est inférieur de un par rapport au bord gauche du rectangle scrollRect et top=0.

Paramètres

Eléments de l’API associés

Renvoie les limites du premier élément de présentation qui englobe ou est à droite du bord droit du rectangle scrollRect.

Il s’agit d’une méthode pratique utilisée par l’implémentation par défaut de la méthode getHorizontalScrollPositionDelta(). Les sous-classes faisant appel à l’implémentation par défaut de la méthode getHorizontalScrollPositionDelta() doivent remplacer cette méthode pour fournir un rectangle de délimitation précis comportant des propriétés left et right valides.

Par défaut, cette méthode renvoie un rectangle avec width=1, height=0, dont le bord droit est supérieur de un par rapport au bord droit du rectangle scrollRect et top=0.

Paramètres

Eléments de l’API associés

Renvoie la modification de la position de défilement horizontal pour traiter différentes options de défilement. Ces options sont définies par la classe NavigationUnit : END, HOME, LEFT, PAGE_LEFT, PAGE_RIGHT et RIGHT.

Paramètres

Eléments de l’API associés

Méthode de délégation qui détermine vers quel élément naviguer en fonction de l’élément actuel mis en focus et de l’entrée utilisateur en termes de constante NavigationUnit. Cette méthode est utilisée par des sous-classes de ListBase pour gérer la navigation par clavier. La classe ListBase mappe les entrées utilisateur aux constantes NavigationUnit.

Les sous-classes peuvent remplacer cette méthode pour calculer d’autres valeurs basées sur l’index actuel et la frappe de touche détectée.

Paramètres

Calcule les deltas horizontalScrollPosition et verticalScrollPosition requis pour faire défiler l’élément à l’index spécifié afin de l’afficher.

Cette méthode tente de minimiser la modification de verticalScrollPosition et horizontalScrollPosition.

Si clipAndEnableScrolling comporte la valeur true et que l’élément à l’index spécifié n’est pas entièrement visible par rapport au rectangle scrollRect de la cible, renvoie le delta à ajouter à horizontalScrollPosition et verticalScrollPosition qui fera défiler l’élément de manière à l’afficher entièrement dans les limites du rectangle scrollRect.

Paramètres

Eléments de l’API associés

Renvoie les limites du rectangle de défilement de la cible dans les coordonnées de présentation. Les méthodes de présentation ne doivent pas obtenir le rectangle de défilement de la cible directement.

Renvoie la modification de la position de défilement vertical pour traiter différentes options de défilement. Ces options sont définies par la classe NavigationUnit : DOWN, END, HOME, PAGE_DOWN, PAGE_UP et UP.

Paramètres

Eléments de l’API associés

Masque l’indicateur de dépôt créé par la méthode showDropIndicator() précédemment affiché, le supprime de la liste d’affichage et stoppe également l’opération de glissement-défilement.

Eléments de l’API associés

Mesure la taille par défaut de la cible en fonction de son contenu et éventuellement la taille minimale par défaut de la cible.

Il s’agit d’une méthode que vous devez remplacer lorsque vous créez une sous-classe de la classe LayoutBase. L’autre méthode est updateDisplayList(). Vous n’appelez pas ces méthodes directement. Flex appelle cette méthode dans le cadre d’un passage de présentation. Un passage de présentation consiste en trois phases.

Premièrement, si les propriétés de la cible ne sont pas valides, la classe LayoutManager appelle la méthode commitProperties de la cible.

Deuxièmement, si la taille de la cible n’est pas valide, la classe LayoutManager appelle la méthode validateSize() de la cible. La méthode validateSize() de la cible appelle à son tour la méthode measure() de la présentation pour calculer la taille par défaut de la cible, sauf si elle a été explicitement spécifiée par les propriétés explicitWidth et explicitHeight de la cible. Si la taille par défaut change, Flex invalide la liste d’affichage de la cible.

Enfin, si la liste d’affichage de la cible n’est pas valide, la classe LayoutManager appelle la méthode validateDisplayList de la cible. La méthode validateDisplayList de la cible appelle à son tour la méthode updateDisplayList de la présentation pour dimensionner et positionner les éléments de la cible.

Lorsque vous implémentez cette méthode, vous devez spécifier les propriétés measuredWidth et measuredHeight de la cible pour définir la taille par défaut de la cible. Vous pouvez également définir les propriétés measuredMinWidth et measuredMinHeight pour définir la taille minimale par défaut. Une implémentation standard est itérée via les éléments de la cible et utilise les méthodes définies par la classe ILayoutElement pour accumuler les tailles préférées et/ou minimales des éléments, puis définit les propriétés measuredWidth, measuredHeight, measuredMinWidth et measuredMinHeight de la cible.

Eléments de l’API associés

Appelé lorsque les propriétés verticalScrollPosition ou horizontalScrollPosition changent.

L’implémentation par défaut met à jour la propriété scrollRect de la cible en appelant la méthode updateScrollRect(). Les sous-classes peuvent remplacer cette méthode pour calculer d’autres valeurs basées sur la position scrollPosition ou le rectangle scrollRect actuel.

Eléments de l’API associés

Définit la taille, la position et les parents de l’indicateur de dépôt en fonction de l’emplacement de dépôt spécifié. Utilisez la méthode calculateDropLocation() pour obtenir l’objet DropLocation.

Lance/arrête le glissement-défilement lorsque les conditions nécessaires sont remplies.

Paramètres

Eléments de l’API associés

Dimensionne et positionne les éléments de la cible.

Il s’agit d’une méthode que vous devez remplacer lorsque vous créez une sous-classe de la classe LayoutBase. L’autre méthode est measure(). Vous n’appelez pas ces méthodes directement. Flex appelle cette méthode dans le cadre d’un passage de présentation. Un passage de présentation consiste en trois phases.

Premièrement, si les propriétés de la cible ne sont pas valides, la classe LayoutManager appelle la méthode commitProperties de la cible.

Deuxièmement, si la taille de la cible n’est pas valide, la classe LayoutManager appelle la méthode validateSize() de la cible. La méthode validateSize() de la cible appelle à son tour la méthode measure() de la présentation pour calculer la taille par défaut de la cible, sauf si elle a été explicitement spécifiée par les propriétés explicitWidth et explicitHeight de la cible. Si la taille par défaut change, Flex invalide la liste d’affichage de la cible.

Enfin, si la liste d’affichage de la cible n’est pas valide, la classe LayoutManager appelle la méthode validateDisplayList de la cible. La méthode validateDisplayList de la cible appelle à son tour la méthode updateDisplayList de la présentation pour dimensionner et positionner les éléments de la cible.

Une implémentation standard est itérée via les éléments de la cible et utilise les méthodes définies par la classe ILayoutElement pour positionner et redimensionner les éléments. La présentation doit alors également calculer et définir les propriétés contentWidth et contentHeight de la cible pour définir la région de défilement de la cible.

Paramètres

Eléments de l’API associés

Appelé par la cible à la fin de sa liste updateDisplayList pour que la présentation mette à jour son rectangle scrollRect.

Si clipAndEnableScrolling est true, l’implémentation par défaut définit l’origine du rectangle scrollRect de la cible sur verticalScrollPosition, horizontalScrollPosition. Il définit sa taille en fonction des paramètres width, height (largeur et la hauteur de la cible non mise de l’échelle).

Si clipAndEnableScrolling comporte la valeur false, l’implémentation par défaut définit le rectangle scrollRect sur null.

Paramètres

Eléments de l’API associés