RichEditableText  - AS3 Flex

Package	spark.components
Classe	public class RichEditableText
Héritage	RichEditableText UIComponent FlexSprite Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher Object
Implémente	IFocusManagerComponent, IIMESupport, ISystemCursorClient, IViewport, IEditableText

Adobe recommande de ne pas utiliser ce composant dans une application qui fait appel au profil mobileDevice.

Texte enrichi peut contenir des hyperliens cliquables et des trafics en ligne incorporés ou chargés à partir d’URL.

Le contrôle RichEditableText ne possède pas de barre de défilement, mais il implémente l’interface IViewport permettant le défilement par programme afin de pouvoir être contrôlée par un objet Scroller, qui fournit des barres de défilement. Il prend également en charge le défilement vertical avec la molette de la souris.

Il n’inclut pas d’interface utilisateur permettant de modifier le formatage du texte. Mais il offre des API qui peut le faire par programmation. Ces dernières vous permettent, par exemple, de créer un bouton Gras qui rend le texte sélectionné en gras.

Cette classe est utilisée dans les habillages des versions Spark de TextInput et TextArea. (TextInput n’expose pas sa capacité à traiter du texte enrichi, contrairement à TextArea.) Par défaut, RichEditableText possède un arrière-plan transparent et ne prend pas en charge le traçage d’une bordure.

RichEditableText utilise la bibliothèque Text Layout Framework (TLF), qui repose elle-même sur le nouveau moteur Flash Text Engine (FTE) de Flash Player 10. Associés, ces calques offrent des fonctionnalités de modification de texte, notamment de typographie et de présentation internationales de qualité supérieure.

L’architecture Spark fournit trois « primitives » de texte : Label, RichText et RichEditableText. Label est la plus rapide et la plus légère, car elle utilise uniquement FTE, et pas TLF. Mais elle est limitée dans ses capacités : aucun texte enrichi, aucun défilement, aucune sélection et aucune modification. RichText ajoute la possibilité de lire du texte à la présentation complexe, mais n’est absolument pas interactive. RichEditableText est la plus lourde, mais tire le meilleur parti de la technologie TLF. Vous devez utiliser la primitive la plus rapide adaptée à vos besoins.

RichEditableText est similaire à la classe UITextField utilisée dans les composants MX. Cette classe n’utilise pas FTE ou TLF mais étend plutôt l’ancienne classe TextField.

Les principales différences entre UITextField et RichEditableText sont les suivantes :

• RichEditableText offre des fonctionnalités typographiques et de présentation de texte optimisées, ainsi qu’une meilleure prise en charge des langues internationales.
• RichEditableText possède un modèle orienté objet. de texte enrichi, ce qui n’est pas le cas de la classe UITextField.
• RichEditableText possède une meilleure prise en charge de l’affichage de grandes quantités de texte.
• Par rapport à la classe UITextField, l’incorporation de polices doit s’effectuer de manière différente dans RichEditableText. Consultez la documentation concernant l’utilisation de l’attribut embedAsCFF lors de l’incorporation d’une police.

RichEditableText utilise le modèle de texte enrichi orienté objet TLF, dans lequel les éléments de présentation de texte, tels que les divisions, les paragraphes, les étendues, les hyperliens, et les images sont représentés à l’exécution par des objets ActionScript. TextFlow est l’objet central de TLF permettant de représenter le texte enrichi. Vous pouvez spécifier l’affichage du texte enrichi dans le contrôle RichEditableText en définissant sa propriété textFlow sur une instance TextFlow. Consultez la description de la propriété textFlow pour en savoir plus sur sa création, par exemple, dans le cadre d’une importation de marquage TLF. Si vous n’avez pas besoin d’afficher un texte possédant plusieurs formats, vous pouvez utiliser la propriété text pour définir un composant TextArea sur une chaîne de texte brut. Consultez les descriptions des propriétés text et textFlow pour plus d’informations sur leurs interactions ; par exemple, vous pouvez en définir une et obtenir l’autre.

Lors de la compilation, vous pouvez placer des balises de marquage TLF dans la balise RichEditableText, comme l’illustre l’exemple suivant :

      <s:RichEditableText>Hello <s:span fontWeight="bold">World!</s:span></s:RichEditableText>
      

Le formatage de texte par défaut est déterminé par des styles CSS, par exemple fontFamily et fontSize. Les informations de formatage de l’objet TextFlow remplacent le formatage par défaut fourni par les styles CSS.

Vous pouvez contrôler l’espacement entre les lignes l’aide du style lineHeight et l’espacement entre les paragraphes avec les styles paragraphSpaceBefore et paragraphSpaceAfter. Vous pouvez aligner ou justifier le texte à l’aide des styles textAlign et textAlignLast. Vous pouvez mettre le texte en retrait à partir des bords du composant de l’aide des styles paddingLeft, paddingTop, paddingRight et paddingBottom.

Par défaut, un objet RichEditableText « se redimensionne automatiquement » : très réduit au départ en l’absence de texte, il croît en largeur jusqu’à maxWidth au fur et à mesure de la saisie. Sa taille augmente en hauteur lorsque vous appuyez sur la touche Entrée pour commencer une nouvelle ligne.

Les propriétés widthInChars et heightInLines constituent un moyen pratique pour spécifier la largeur et la hauteur en fonction de la taille de police. Vous pouvez également utiliser la propriété typicalText. Notez que si vous utilisez typicalText, les propriétés widthInChars et heightInLines sont ignorées. Vous pouvez également spécifier une largeur ou une hauteur explicite en pixels ou utiliser un pourcentage de largeur et de hauteur ou des contraintes telles que left and right ou top et bottom.

Lorsque vous spécifiez une largeur, qu’il s’agisse d’une largeur explicite ou en pourcentage, une largeur maxWidth ou des contraintes left et right, le texte revient à la ligne sur le bord droit du composant et il est possible de le faire défiler lorsqu’il dépasse les dimensions du conteneur. Si vous définissez le style lineBreak sur explicit, les nouvelles lignes commencent uniquement aux sauts de lignes explicites, si vous utilisez CR (\r), LF (\n) ou CR+LF (\r\n) dans text ou si vous utilisez <p> et <br /> dans le marquage TLF. Dans ce cas, il est possible de faire défiler le texte horizontalement si les lignes sont plus larges que le contrôle.

Vous pouvez utiliser la propriété maxChars pour limiter le nombre de caractères saisis par l’utilisateur et la propriété restrict pour limiter le type des caractères saisis par l’utilisateur.

La propriété multiline détermine ce qui se produit lorsque vous appuyez sur la touche Entrée. Si la valeur est true, la touche Entrée commence un nouveau paragraphe. Si elle est false, cela provoque la distribution d’un événement FlexEvent.ENTER.

Si vous ne souhaitez pas que le texte soit modifiable, définissez la propriété editable sur false. Si vous ne souhaitez pas que le texte soit sélectionné, définissez la propriété selectable sur false.

Etant donné que RichEditableText utilise TLF, prend en charge l’affichage du texte rédigé de gauche à droite (LTR), par exemple, en français, de droite à gauche (RTL), comme en arabe, et du texte bidirectionnel, par exemple une phrase française au sein d’une phrase arabe. Si le sens du texte prédominant est de droite à gauche, définissez le style direction sur rtl. Par défaut, le style textAlign pour la valeur "start", ce qui aligne le texte à gauche lorsque direction est définie sur ltr et à droite lorsque direction est définie sur rtl. Pour obtenir l’alignement inverse, définissez textAlign sur end.

L’utilisation TLF permet à RichEditableText de prendre en charge un nombre illimité d’opération d’annulation/rétablissement au cours d’une session d’édition. Une session d’édition commence lorsque le composant obtient le focus clavier et se termine lorsque le contrôle perd le focus.

RichEditableText utilise la classe TextContainerManager de TLF pour gérer l’affichage, le défilement, la sélection, la modification du texte et le menu contextuel.

Pour utiliser ce composant d’un composant à base de listes (par exemple List ou DataGrid) créez une option de rendu d’élément. Pour plus d’informations sur la création d’une option de rendu d’élément, consultez la section Options personnalisées de rendu d’élément Spark.

Afficher la syntaxe MXML

Masquer la syntaxe MXML

      <s:RichEditableText
        Properties
        clipAndEnableScrolling="false|true"
        contentHeight="Calculated default"
        contentWidth="Calculated default"
        displayAsPassword="false"
        editable="true"
        heightInLines="NaN"
        horizontalScrollPosition="0"
        imeMode="null"
        maxChars="0"
        multiline="true"
        restrict="null"
        selectable="true"
        selectionActivePosition="-1"
        selectionAnchorPosition="-1"
        selectionHighlighting="TextSelectionHighlighting.WHEN_FOCUSED"
        text=""
        textFlow="TextFlow"
        typicalText=null
        verticalScrollPosition="0"
        widthInChars="NaN"
      
        Events
        change="No default"
        changing="No default"
        enter="No default"
        selectionChange="No default"
      />
      

Propriété MXML par défautcontent

Consulter les exemples

Eléments de l’API associés