Paquete | flashx.textLayout.conversion |
Clase | public class TextConverter |
Herencia | TextConverter Object |
Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | Flash Player 10, AIR 1.5 |
El formato de los datos convertidos no es predefinido; los convertidores del usuario son libres de aceptar y devolver cualquier formato de su elección. Los formatos comunes son cadenas, XML e instancias de ByteArray. Los creadores del convertidor deben documentar qué formatos son compatibles.
Más ejemplos
Propiedad | Definido por | ||
---|---|---|---|
constructor : Object
Una referencia a la clase de objeto o función constructora para una instancia de objeto determinada. | Object | ||
numFormats : int [estática] [solo lectura] Número de formatos. | TextConverter |
Método | Definido por | ||
---|---|---|---|
[estática]
Registre un nuevo formato para la importación/exportación. | TextConverter | ||
addFormatAt(index:int, format:String, importerClass:Class, exporterClass:Class = null, clipboardFormat:String = null):void [estática]
Registre un nuevo formato para la importación/exportación en la ubicación especificada. | TextConverter | ||
[estática]
Exporta un objeto TextFlow a un formato especificado. | TextConverter | ||
[estática]
Crea y devuelve un conversor de exportación que, posteriormente, se puede para exportar desde un objeto TextFlow a una cadena de origen o a un objeto XML. | TextConverter | ||
[estática] Devuelve el nombre de formato para el formato del enésimo índice. | TextConverter | ||
[estática] Devuelve FormatDescriptor para el formato del enésimo índice. | TextConverter | ||
[estática]
Crea y devuelve un convertidor de importación, que se puede utilizar para importar desde una cadena de origen, un objeto XML o cualquier formatos de datos definido por el usuario a un objeto TextFlow. | TextConverter | ||
Indica si un objeto tiene definida una propiedad especificada. | Object | ||
importToFlow(source:Object, format:String, config:IConfiguration = null):flashx.textLayout.elements:TextFlow [estática]
Crea un objeto TextFlow desde el contenido de origen en un formato especificado. | TextConverter | ||
Indica si hay una instancia de la clase Object en la cadena de prototipo del objeto especificado como parámetro. | Object | ||
Indica si existe la propiedad especificada y si es enumerable. | Object | ||
[estática]
Elimina el formato. | TextConverter | ||
[estática]
Elimina el formato en la ubicación de índice. | TextConverter | ||
Establece la disponibilidad de una propiedad dinámica para operaciones de bucle. | Object | ||
Devuelve la representación de cadena de este objeto, con formato según las convenciones específicas de configuración regional. | Object | ||
Devuelve la representación de cadena del objeto especificado. | Object | ||
Devuelve el valor simple del objeto especificado. | Object |
Constante | Definido por | ||
---|---|---|---|
PLAIN_TEXT_FORMAT : String = "plainTextFormat" [estática]
Formato de texto normal. | TextConverter | ||
TEXT_FIELD_HTML_FORMAT : String = "textFieldHTMLFormat" [estática]
Formato HTML. | TextConverter | ||
TEXT_LAYOUT_FORMAT : String = "textLayoutFormat" [estática]
Formato TextLayout. | TextConverter |
numFormats | propiedad |
addFormat | () | método |
public static function addFormat(format:String, importerClass:Class, exporterClass:Class, clipboardFormat:String):void
Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | Flash Player 10, AIR 1.5 |
Registre un nuevo formato para la importación/exportación. El nuevo formato se añadirá al final, como la prioridad más baja. La ubicación puede ser importante para los clientes que tienen múltiples opciones sobre el formato que utilizar, como al importar desde un portapapeles externo. El nuevo formato puede admitir importación y/o exportación. Si el formato ya se ha añadido, a continuación, estará presente en varias ubicaciones. Se utilizará el primero encontrado.
Parámetros
format:String — La clase de convertidor de importación para registrar o null
| |
importerClass:Class — La clase de convertidor de importación para registrar o null
| |
exporterClass:Class — La cadena de formato que etiqueta las clases del convertidor. Los formatos se pueden tener cualquier nombre, pero debe ser exclusivo.
| |
clipboardFormat:String — La cadena utilizada como el formato del portapapeles al convertir a/desde el portapapeles. Asigne el valor null si el formato no admite acceso al portapapeles.
|
addFormatAt | () | método |
public static function addFormatAt(index:int, format:String, importerClass:Class, exporterClass:Class = null, clipboardFormat:String = null):void
Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | Flash Player 10, AIR 1.5 |
Registre un nuevo formato para la importación/exportación en la ubicación especificada. La ubicación puede ser importante para los clientes que tienen múltiples opciones sobre el formato que utilizar, como al importar desde un portapapeles externo. Números más pequeños indican una mayor prioridad; estos convertidores se utilizarán primero. El nuevo formato puede admitir importación y/o exportación. Si el formato ya se ha añadido, a continuación, estará presente en varias ubicaciones. Se utilizará el primero encontrado.
Parámetros
index:int — La clase de convertidor de importación para registrar o null
| |
format:String — La clase de convertidor de importación para registrar o null
| |
importerClass:Class — La cadena de formato que etiqueta las clases del convertidor
| |
exporterClass:Class (default = null ) — La cadena utilizada como el formato del portapapeles al convertir a/desde el portapapeles. Asigne el valor null si el formato no admite acceso al portapapeles.
| |
clipboardFormat:String (default = null )
|
export | () | método |
public static function export(source:flashx.textLayout.elements:TextFlow, format:String, conversionType:String):Object
Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | Flash Player 10, AIR 1.5 |
Exporta un objeto TextFlow a un formato especificado.
Utilice una de las constantes estáticas suministradas con esta clase, un tipo MIME, o un formato definido por el usuario para que los exportadores definidos por el usuario especifiquen el parámetro format
:
- TextConverter.TEXT_FIELD_HTML_FORMAT
- TextConverter.PLAIN_TEXT_FORMAT
- TextConverter.TEXT_LAYOUT_FORMAT
Especifique el tipo de los datos exportados en el parámetro conversionType
con una de las constantes estáticas suministradas por la clase ConversionType o un tipo de datos definido por el usuario para exportadores definidos por el usuario:
- ConversionType.STRING_TYPE
- ConversionType.XML_TYPE
Parámetros
source:flashx.textLayout.elements:TextFlow — Contenido de origen
| |
format:String — Formato de salida
| |
conversionType:String — Tipo de datos exportados
|
Object — Objeto exportado desde el objeto TextFlow, o null si hay errores
|
Elementos de API relacionados
getExporter | () | método |
public static function getExporter(format:String):flashx.textLayout.conversion:ITextExporter
Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | Flash Player 10, AIR 1.5 |
Crea y devuelve un conversor de exportación que, posteriormente, se puede para exportar desde un objeto TextFlow a una cadena de origen o a un objeto XML. Utilice esta función si necesita realizar varias exportaciones por separado. Equivale a llamar a flashx.textLayout.conversion.TextConverter.export()
.
Utilice una de las constantes estáticas suministradas con esta clase para especificar el parámetro format
:
- TextConverter.TEXT_FIELD_HTML_FORMAT
- TextConverter.PLAIN_TEXT_FORMAT
- TextConverter.TEXT_LAYOUT_FORMAT
Si el formato se ha añadido varias veces, se utilizará el primero encontrado.
Parámetros
format:String — Formato de destino de los datos exportados
|
flashx.textLayout.conversion:ITextExporter — Exportador de texto de ITextExporter que puede exportar en el formato especificado
|
Elementos de API relacionados
Ejemplo ( Cómo utilizar este ejemplo )
Este fragmento de código muestra un uso del método getExporter
para llevar a cabo exportaciones repetidas de texto con formato.
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étodo |
getFormatDescriptorAt | () | método |
public static function getFormatDescriptorAt(index:int):FormatDescriptor
Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | Flash Player 10, AIR 1.5 |
Devuelve FormatDescriptor para el formato del enésimo índice.
Parámetros
index:int |
FormatDescriptor |
getImporter | () | método |
public static function getImporter(format:String, config:IConfiguration = null):flashx.textLayout.conversion:ITextImporter
Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | Flash Player 10, AIR 1.5 |
Crea y devuelve un convertidor de importación, que se puede utilizar para importar desde una cadena de origen, un objeto XML o cualquier formatos de datos definido por el usuario a un objeto TextFlow. Utilice este método si necesita realizar varias importaciones o si quiere gestionar los errores durante la importación. equivale a llamar a flashx.textLayout.conversion.TextConverter.importToFlow()
.
Utilice una de las constantes estáticas suministradas con esta clase para especificar el parámetro format
, un tipo MIME o un formato de datos definido por el usuario.
- TextConverter.TEXT_FIELD_HTML_FORMAT
- TextConverter.PLAIN_TEXT_FORMAT
- TextConverter.TEXT_LAYOUT_FORMAT
Si el formato se ha añadido varias veces, se utilizará el primero encontrado.
Parámetros
format:String — Formato del contenido de origen. Utilice constantes de flashx.textLayout.conversion.TextConverter.TEXT_LAYOUT_FORMAT, PLAIN_TEXT_FORMAT, TEXT_FIELD_HTML_FORMAT etc, un tipo MIME type o un formato definido por el usuario.
| |
config:IConfiguration (default = null ) — configuración que se debe usar durante esta importación. null indica que se utilizarán los valores predeterminados actuales. También puede establecer la configuración a través de la propiedad ITextImporter.configuration .
|
flashx.textLayout.conversion:ITextImporter — Importador de texto de ITextImporter que puede importar los datos de origen
|
Elementos de API relacionados
Ejemplo ( Cómo utilizar este ejemplo )
Este fragmento de código muestra un uso del método getImporter
para llevar a cabo importaciones repetidas de texto con formato. Tenga en cuenta que los errores se borran al comenzar cada nueva llamada a 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étodo |
public static function importToFlow(source:Object, format:String, config:IConfiguration = null):flashx.textLayout.elements:TextFlow
Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | Flash Player 10, AIR 1.5 |
Crea un objeto TextFlow desde el contenido de origen en un formato especificado.
Utilice una de las constantes estáticas suministradas con esta clase, un tipo MIME, para especificar el parámetro format
o para utilizar un valor definido por el usuario para importadores registrados por usuarios:
- TextConverter.TEXT_FIELD_HTML_FORMAT
- TextConverter.PLAIN_TEXT_FORMAT
- TextConverter.TEXT_LAYOUT_FORMAT
Parámetros
source:Object — Contenido de origen
| |
format:String — Formato del contenido de origen
| |
config:IConfiguration (default = null ) — Configuración que debe usarse al crear nuevos objetos TextFlow
|
flashx.textLayout.elements:TextFlow — Objeto TextFlow creado desde el origen, o null si hay error.
|
Elementos de API relacionados
removeFormat | () | método |
public static function removeFormat(format:String):void
Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | Flash Player 10, AIR 1.5 |
Elimina el formato. Si un formato se ha añadido varias veces, solo se eliminará la primera instancia encontrada.
Parámetros
format:String — La cadena en formato de convertidor para eliminar
|
removeFormatAt | () | método |
PLAIN_TEXT_FORMAT | Constante |
public static const PLAIN_TEXT_FORMAT:String = "plainTextFormat"
Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | Flash Player 10, AIR 1.5 |
Formato de texto normal. Utilice esto para crear un objeto TextFlow a partir de una cadena sencilla y sin formato o para crear una cadena sencilla y sin formato a partir de un objeto TextFlow.
TEXT_FIELD_HTML_FORMAT | Constante |
public static const TEXT_FIELD_HTML_FORMAT:String = "textFieldHTMLFormat"
Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | Flash Player 10, AIR 1.5 |
Formato HTML. Utilice esto para importar o exportar desde y a un objeto TextFlow con formato HTML. El HTML de Text Layout Framework admite un subconjunto de etiquetas y atributos admitidos por la clase TextField en el paquete flash.text
.
La siguiente tabla muestra los atributos y etiquetas HTML compatibles con el proceso de importación y exportación (las etiquetas y atributos admitidos por TextField, pero no admitidos por Text Layout Framework se describen específicamente como no admitidas):
Etiqueta | Descripción |
---|---|
Etiqueta de anclaje |
La etiqueta <a> crea un vínculo de hipertexto y admite los atributos siguientes:
|
Etiqueta de negrita |
La etiqueta <b> muestra el texto en negrita. Debe haber un tipo de letra en negrita disponible para la fuente utilizada.
|
Etiqueta de salto de línea |
La etiqueta <br> crea un salto de línea en el texto.
|
Etiqueta de fuente |
La etiqueta <font> especifica una fuente o una lista de fuentes para mostrar el texto. La etiqueta de fuente admite los atributos siguientes:
|
Etiqueta de imagen |
La etiqueta <img> permite incorporar archivos de imagen externos (JPEG, GIF, PNG), archivos SWF y clips de película dentro del texto.
La etiqueta
Nota: a diferencia de lo que ocurre con la clase TextField, no se admiten los siguientes atributos: |
Etiqueta de cursiva |
La etiqueta <i> muestra el texto encerrado en cursiva. Debe haber un tipo de letra en cursiva disponible para la fuente utilizada.
|
Etiqueta de elemento de lista | Nota: a diferencia de la clase TextField, la etiqueta de elemento List no se admite. |
Etiqueta de párrafo |
La etiqueta <p> crea un párrafo nuevo. La etiqueta <p> admite los siguientes atributos:
|
Etiqueta de espacio |
La etiqueta <span> admite los atributos siguientes:
|
Etiqueta de formato de texto |
La etiqueta La etiqueta
|
Etiqueta de subrayado |
La etiqueta <u> subraya el texto encerrado.
|
Cuando se importa una etiqueta desconocida, el importador textFieldHTMLFormat
define una sola propiedad typeName del objeto FlowElement a dicho nombre de etiqueta o crea un elemento DivElement o un elemento SubParagraphGroupElement con su propiedad typeName establecida en el nombre de la etiqueta.
El exportador textFieldHTMLFormat
exporta typeName
como etiqueta XML cuando es distinto del predeterminado.
Elementos de API relacionados
TEXT_LAYOUT_FORMAT | Constante |
public static const TEXT_LAYOUT_FORMAT:String = "textLayoutFormat"
Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | Flash Player 10, AIR 1.5 |
Formato TextLayout. Utilice esto para importar o exportar desde y a un objeto TextFlow utilizando el formato de marcado TextLayout. El formato TextLayout detectará los errores siguientes:
- Espacios de nombres inesperados
- Elementos desconocidos
- Atributos desconocidos
Este ejemplo muestra un uso de la clase de conversión TextConverter
. El texto en formato de marcado estándar se importa a un objeto TextFlow
y, seguidamente, se visualiza. Luego el texto se exporta en formato 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, 02:12 PM Z