Package | flashx.textLayout.conversion |
Classe | public class TextConverter |
Héritage | TextConverter Object |
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | Flash Player 10, AIR 1.5 |
Le format des données converties n’est pas prédéfini ; les convertisseurs écrits par l’utilisateur sont libres d’accepter et de renvoyer tout format de leur choix. Les formats courants sont les chaînes, XML et les occurrences ByteArray. Les auteurs de convertisseur devraient indiquer quels formats sont pris en charge.
Plus d’exemples
Propriété | Défini par | ||
---|---|---|---|
constructor : Object
Référence à l’objet de classe ou à la fonction constructeur d’une occurrence donnée d’un objet. | Object | ||
numFormats : int [statique] [lecture seule] Nombre de formats. | TextConverter |
Méthode | Défini par | ||
---|---|---|---|
[statique]
Enregistrez un nouveau format d’importation/exportation. | TextConverter | ||
addFormatAt(index:int, format:String, importerClass:Class, exporterClass:Class = null, clipboardFormat:String = null):void [statique]
Enregistrez un nouveau format d’importation/exportation, à l’emplacement spécifié. | TextConverter | ||
[statique]
Exporte un objet TextFlow vers un format spécifié. | TextConverter | ||
[statique]
Crée et renvoie un convertisseur d’exportation, que vous pouvez ensuite utiliser pour exporter à partir d’un objet TextFlow vers une chaîne source ou un objet XML. | TextConverter | ||
[statique] Renvoie le nom de format pour l’index-ième format. | TextConverter | ||
[statique] Renvoie le FormatDescriptor pour l’index-ième format. | TextConverter | ||
[statique]
Crée et renvoie un convertisseur d’importation, qui vous permet ensuite d’importer à partir d’une chaîne source, d’un objet XML ou de n’importe quel format de données défini par l’utilisateur vers un objet TextFlow. | TextConverter | ||
Indique si la propriété spécifiée d’un objet est définie. | Object | ||
importToFlow(source:Object, format:String, config:IConfiguration = null):flashx.textLayout.elements:TextFlow [statique]
Crée un objet TextFlow à partir de la source du contenu dans un format spécifié. | TextConverter | ||
Indique si une occurrence de la classe Object figure dans la chaîne de prototype de l’objet spécifié en tant que paramètre. | Object | ||
Indique si la propriété spécifiée existe et est énumérable. | Object | ||
[statique]
Supprimez le format. | TextConverter | ||
[statique]
Supprimez le format à l’emplacement de l’index. | TextConverter | ||
Définit la disponibilité d’une propriété dynamique pour les opérations en boucle. | Object | ||
Renvoie la représentation de chaîne de cet objet, formatée selon les paramètres régionaux en vigueur. | Object | ||
Renvoie la représentation sous forme de chaîne de l’objet spécifié. | Object | ||
Renvoie la valeur primitive de l’objet spécifié. | Object |
Constante | Défini par | ||
---|---|---|---|
PLAIN_TEXT_FORMAT : String = "plainTextFormat" [statique]
Format texte. | TextConverter | ||
TEXT_FIELD_HTML_FORMAT : String = "textFieldHTMLFormat" [statique]
Format HTML. | TextConverter | ||
TEXT_LAYOUT_FORMAT : String = "textLayoutFormat" [statique]
TextLayout Format. | TextConverter |
numFormats | propriété |
addFormat | () | méthode |
public static function addFormat(format:String, importerClass:Class, exporterClass:Class, clipboardFormat:String):void
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | Flash Player 10, AIR 1.5 |
Enregistrez un nouveau format d’importation/exportation. Le nouveau format sera ajouté à la fin, en tant que priorité la plus faible. L’emplacement peut être important pour les clients ayant plusieurs choix de format à utiliser, comme par exemple lors de l’importation à partir du presse-papiers externe. Le nouveau format peut prendre en charge l’importation et/ou l’exportation. Si le format a déjà été ajouté, il sera présent dans plusieurs emplacements. La première occurrence trouvée sera utilisée.
Paramètres
format:String — Classe du convertisseur d’importation à enregistrer ou null
| |
importerClass:Class — Classe du convertisseur d’exportation à enregistrer ou null
| |
exporterClass:Class — Chaîne de format qui marque les classes de convertisseur. Les formats peuvent avoir un nom quelconque, mais doivent être uniques.
| |
clipboardFormat:String — Chaîne utilisée comme format de presse-papiers lors de la conversion vers/à partir du presse-papiers. Spécifiez la valeur null si le format ne prend pas en charge l’accès au presse-papiers.
|
addFormatAt | () | méthode |
public static function addFormatAt(index:int, format:String, importerClass:Class, exporterClass:Class = null, clipboardFormat:String = null):void
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | Flash Player 10, AIR 1.5 |
Enregistrez un nouveau format d’importation/exportation, à l’emplacement spécifié. L’emplacement peut être important pour les clients ayant plusieurs choix de format à utiliser, comme par exemple lors de l’importation à partir du presse-papiers externe. Les nombres faibles indiquent une priorité élevée ; ces convertisseurs seront essayés en premier. Le nouveau format peut prendre en charge l’importation et/ou l’exportation. Si le format a déjà été ajouté, il sera présent dans plusieurs emplacements. La première occurrence trouvée sera utilisée.
Paramètres
index:int — Classe du convertisseur d’importation à enregistrer ou null
| |
format:String — Classe du convertisseur d’exportation à enregistrer ou null
| |
importerClass:Class — Chaîne de format qui marque les classes de convertisseur
| |
exporterClass:Class (default = null ) — Chaîne utilisée comme format de presse-papiers lors de la conversion vers/à partir du presse-papiers. Spécifiez la valeur null si le format ne prend pas en charge l’accès au presse-papiers.
| |
clipboardFormat:String (default = null )
|
export | () | méthode |
public static function export(source:flashx.textLayout.elements:TextFlow, format:String, conversionType:String):Object
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | Flash Player 10, AIR 1.5 |
Exporte un objet TextFlow vers un format spécifié.
Utilisez l’une des constantes statiques fournies avec cette classe, un type MIME ou un format défini par l’utilisateur pour les exportateurs définis par l’utilisateur, pour spécifier le paramètre format
:
- TextConverter.TEXT_FIELD_HTML_FORMAT
- TextConverter.PLAIN_TEXT_FORMAT
- TextConverter.TEXT_LAYOUT_FORMAT
Spécifiez le type des données exportées dans le paramètre conversionType
avec l’une des constantes statiques fournies par la classe ConversionType ou un type de données défini par l’utilisateur pour les exportateurs définis par l’utilisateur :
- ConversionType.STRING_TYPE
- ConversionType.XML_TYPE
Paramètres
source:flashx.textLayout.elements:TextFlow — Contenu de la source.
| |
format:String — Format de sortie.
| |
conversionType:String — Type de données exportées.
|
Object — Formulaire Objet exporté de l’objet TextFlow., ou null en cas d’erreurs
|
Eléments de l’API associés
getExporter | () | méthode |
public static function getExporter(format:String):flashx.textLayout.conversion:ITextExporter
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | Flash Player 10, AIR 1.5 |
Crée et renvoie un convertisseur d’exportation, que vous pouvez ensuite utiliser pour exporter à partir d’un objet TextFlow vers une chaîne source ou un objet XML. Utilisez cette fonction si vous devez effectuer de nombreuses exportations. Cela revient à appeler la méthode flashx.textLayout.conversion.TextConverter.export()
.
Utilisez l’une des constantes statiques fournies avec cette classe pour spécifier le paramètre format
:
- TextConverter.TEXT_FIELD_HTML_FORMAT
- TextConverter.PLAIN_TEXT_FORMAT
- TextConverter.TEXT_LAYOUT_FORMAT
Si le format a été ajouté plusieurs fois, la première occurrence trouvée sera utilisée.
Paramètres
format:String — Format cible pour les données exportées.
|
flashx.textLayout.conversion:ITextExporter — Exportateur de texte ITextExporter pouvant exporter dans le format spécifié
|
Eléments de l’API associés
Exemple ( Comment utiliser cet exemple )
Ce fragment de code illustre une utilisation possible de la méthode getExporter
pour effectuer des exportations répétées de texte mis en forme.
package flashx.textLayout.conversion.examples { import flashx.textLayout.conversion.ConversionType; import flashx.textLayout.conversion.ITextExporter; import flashx.textLayout.conversion.TextConverter; import flashx.textLayout.elements.TextFlow; public class getExporter_example { // Serialize the TextFlow into a String public function export(textFlow:TextFlow):String { var exporter:ITextExporter = TextConverter.getExporter(TextConverter.TEXT_LAYOUT_FORMAT); return exporter.export(textFlow, ConversionType.STRING_TYPE) as String; } } }
getFormatAt | () | méthode |
getFormatDescriptorAt | () | méthode |
public static function getFormatDescriptorAt(index:int):FormatDescriptor
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | Flash Player 10, AIR 1.5 |
Renvoie le FormatDescriptor pour l’index-ième format.
Paramètres
index:int |
FormatDescriptor |
getImporter | () | méthode |
public static function getImporter(format:String, config:IConfiguration = null):flashx.textLayout.conversion:ITextImporter
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | Flash Player 10, AIR 1.5 |
Crée et renvoie un convertisseur d’importation, qui vous permet ensuite d’importer à partir d’une chaîne source, d’un objet XML ou de n’importe quel format de données défini par l’utilisateur vers un objet TextFlow. Utilisez cette méthode, si vous devez exécuter de nombreuses importations ou si vous voulez gérer des erreurs lors de l’importation. Cela revient à appeler la méthode flashx.textLayout.conversion.TextConverter.importToFlow()
.
Utilisez l’une des constantes statiques fournies avec cette classe pour spécifier le paramètre format
, un type MIME ou un format de données défini par l’utilisateur.
- TextConverter.TEXT_FIELD_HTML_FORMAT
- TextConverter.PLAIN_TEXT_FORMAT
- TextConverter.TEXT_LAYOUT_FORMAT
Si le format a été ajouté plusieurs fois, la première occurrence trouvée sera utilisée.
Paramètres
format:String — Format du contenu de la source. Utilise des constantes issues de flashx.textLayout.conversion.TextConverter.TEXT_LAYOUT_FORMAT, PLAIN_TEXT_FORMAT, TEXT_FIELD_HTML_FORMAT etc, un type MIME ou un format défini par l’utilisateur.
| |
config:IConfiguration (default = null ) — Configuration à utiliser au cours de cette importation. La valeur null correspond à l’utilisation du paramètre par défaut. Vous pouvez également définir la configuration via la propriété ITextImporter.configuration .
|
flashx.textLayout.conversion:ITextImporter — Importateur de texte ITextImporter pouvant importer les données source
|
Eléments de l’API associés
Exemple ( Comment utiliser cet exemple )
Ce fragment de code illustre une utilisation possible de la méthode getimporter
pour effectuer des importations répétées de texte mis en forme. Notez que les erreurs sont supprimées au début de chaque appel de importToFlow
.
package flashx.textLayout.conversion.examples { import flashx.textLayout.conversion.ITextImporter; import flashx.textLayout.conversion.TextConverter; import flashx.textLayout.elements.TextFlow; public class getImporter_example { public function importAndCheckErrors():TextFlow { var markup:String = "<TextFlow xmlns='http://ns.adobe.com/textLayout/2008'><p><span>Hello, World</span></p></TextFlow>"; var importer:ITextImporter = TextConverter.getImporter(TextConverter.TEXT_LAYOUT_FORMAT); importer.throwOnError = false; var textFlow:TextFlow = importer.importToFlow(markup); if (!textFlow) { var errors:Vector.<String> = importer.errors; //deal with import errors } return textFlow; } } }
importToFlow | () | méthode |
public static function importToFlow(source:Object, format:String, config:IConfiguration = null):flashx.textLayout.elements:TextFlow
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | Flash Player 10, AIR 1.5 |
Crée un objet TextFlow à partir de la source du contenu dans un format spécifié.
Utilisez l’une des constantes statiques fournies avec cette classe, un type MIME, pour spécifier le paramètre format
, ou utilisez une valeur définie par l’utilisateur pour les importateurs enregistrés par l’utilisateur :
- TextConverter.TEXT_FIELD_HTML_FORMAT
- TextConverter.PLAIN_TEXT_FORMAT
- TextConverter.TEXT_LAYOUT_FORMAT
Paramètres
source:Object — Contenu de la source.
| |
format:String — Format du contenu de la source.
| |
config:IConfiguration (default = null ) — Interface IConfiguration à utiliser lors de la création de nouveaux objets TextFlow.
|
flashx.textLayout.elements:TextFlow — Objet TextFlow qui a été créé à partir de la source, ou null en cas d’erreurs.
|
Eléments de l’API associés
removeFormat | () | méthode |
public static function removeFormat(format:String):void
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | Flash Player 10, AIR 1.5 |
Supprimez le format. Si un format a été ajouté plusieurs fois, seul le premier format trouvé est supprimé.
Paramètres
format:String — Chaîne de format du convertisseur à supprimer
|
removeFormatAt | () | méthode |
PLAIN_TEXT_FORMAT | Constante |
public static const PLAIN_TEXT_FORMAT:String = "plainTextFormat"
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | Flash Player 10, AIR 1.5 |
Format texte. Utilisez-le pour créer un objet TextFlow à partir d’une simple chaîne non formatée ou pour créer une simple chaîne non formatée à partir d’un objet TextFlow.
TEXT_FIELD_HTML_FORMAT | Constante |
public static const TEXT_FIELD_HTML_FORMAT:String = "textFieldHTMLFormat"
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | Flash Player 10, AIR 1.5 |
Format HTML. Utilisez-le pour l’importation à partir d’un TextFlow ou l’exportation vers un TextFlow en utilisant le format HTML. Text Layout Framework HTML prend en charge un sous-ensemble de balises et d’attributs pris en charge par la classe TextField du package flash.text
.
Le tableau suivant répertorie les attributs et les balises HTML pris en charge pour les processus d’importation et d’exportation (les balises et attributs pris en charge par l’objet TextField, mais pas par Text Layout Framework sont spécifiquement décrits comme non pris en charge) :
Balise | Description |
---|---|
Balise d’ancrage |
La balise <a> crée un lien hypertexte et prend en charge les attributs suivants :
|
Balise Bold |
La balise <b> met le texte en gras. Des caractères en gras doivent être disponibles dans la police utilisée.
|
Balise Break |
La balise <br> introduit un saut de ligne dans le texte.
|
Balise Font |
La balise <font> spécifie une police ou une liste de polices pour afficher le texte. La balise font prend en charge les attributs suivants :
|
Balise Image |
La balise <img> permet d’intégrer des fichiers image (JPEG, GIF, PNG), des fichiers SWF et des clips externes dans le texte.
La balise
Remarque : contrairement à la classe TextField, les attributs suivants ne sont pas pris en charge : |
Balise Italic |
La balise <i> affiche le texte entre balises en italiques. Des caractères italiques doivent être disponibles dans la police utilisée.
|
Balise List item | Remarque : contrairement à la classe TextField, la balise de l’élément List n’est pas prise en charge. |
Balise Paragraphe |
La balise <p> crée un paragraphe. La balise <p> prend en charge les attributs suivants :
|
Balise Span |
La balise <span> prend en charge les attributs suivants :
|
Balise Text format |
La balise La balise
|
Balise Underline |
La balise <u> souligne le texte placé entre les balises.
|
Lorsqu’une balise inconnue est importée, l’importateur textFieldHTMLFormat
définira une propriété unique typeName de FlowElement pour le nom de cette balise ou créera un objet DivElement ou SubParagraphGroupElement avec sa propriété typeName définie sur le nom de la balise.
L’exportateur textFieldHTMLFormat
exportera typeName
en tant que balise XML lorsque sa valeur diffère de la valeur par défaut.
Eléments de l’API associés
TEXT_LAYOUT_FORMAT | Constante |
public static const TEXT_LAYOUT_FORMAT:String = "textLayoutFormat"
Version du langage: | ActionScript 3.0 |
Versions du moteur d’exécution: | Flash Player 10, AIR 1.5 |
TextLayout Format. Utilisez-le pour l’importation à partir d’un TextFlow ou l’exportation vers un TextFlow en utilisant le format de balisage TextLayout. Le format de mise en forme de texte détectera les erreurs suivantes :
- Espace inattendu
- Elément inconnu
- Attribut inconnu
Cet exemple illustre une utilisation possible de la classe de conversion TextConverter
. Le texte dans un format de balisage standard est importé dans un objet TextFlow
, puis affiché. Le texte est ensuite exporté au format XML.
package flashx.textLayout.conversion.examples { import flash.display.Sprite; import flashx.textLayout.container.ContainerController; import flashx.textLayout.elements.TextFlow; import flashx.textLayout.conversion.TextConverter; import flashx.textLayout.conversion.ConversionType; public class TextConverter_example extends Sprite { public function TextConverter_example() { var markup:String = "<TextFlow xmlns='http://ns.adobe.com/textLayout/2008'><p><span>Hello, World</span></p></TextFlow>"; var textFlow:TextFlow = TextConverter.importToFlow(markup, TextConverter.TEXT_LAYOUT_FORMAT); textFlow.flowComposer.addController(new ContainerController(this, 200, 50)); textFlow.flowComposer.updateAllControllers(); //export to XML var xmlOut:XML = TextConverter.export(textFlow,TextConverter.TEXT_LAYOUT_FORMAT, ConversionType.XML_TYPE) as XML; } } }
Tue Jun 12 2018, 09:30 AM Z