Paquete | flashx.textLayout.elements |
Clase | public class TextFlow |
Herencia | TextFlow ContainerFormattedElement ParagraphFormattedElement FlowGroupElement FlowElement Object |
Implementa | IEventDispatcher |
Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | Flash Player 10, AIR 1.5 |
Un objeto TextFlow puede tener objetos ParagraphElement y DivElement como elementos secundarios. Un elemento div (objeto DivElement) representa un grupo de párrafos (objetos ParagraphElement). Un párrafo puede tener objetos SpanElement, InlineGraphicElement, LinkElement y TCYElement como elementos secundarios.
Un fragmento (SpanElement) es un rango de texto dentro de un párrafo que tiene los mismos atributos. Una imagen (InlineGraphicElement) representa un gráfico arbitrario que aparece como un solo carácter en una línea de texto. Un elemento LinkElement representa un hipervínculo o una etiqueta a
HTML. Puede contener varios fragmentos. Un objeto TCYElement se utiliza en texto japonés cuando hay un pequeño ciclo de texto que aparece perpendicular a la línea, como en un flujo de texto horizontal en una línea vertical. Un elemento TCYElement también puede contener varios fragmentos.
TextFlow también proviene de la clase ContainerFormattedElement, que es la raíz de todos los elementos de bloque del nivel del contenedor.
En la siguiente ilustración se muestra la relación de otros elementos, como fragmentos y párrafos, con el objeto TextFlow.
Cada objeto TextFlow tiene un objeto Configuration correspondiente que permite especificar los formatos de los caracteres iniciales y del párrafo, así como el formato del contenedor inicial. También permite especificar atributos para seleccionar, vincular, activar y desplazarse. Cuando se proporciona un objeto Configuration como parámetro al constructor TextFlow()
, crea una instantánea de sólo lectura a la que puede acceder mediante la propiedad TextFlow.configuration
. Una vez creado, no es posible cambiar la configuración de TextFlow. Si no especifica ninguna configuración, puede acceder a la predeterminada mediante la propiedad TextFlow.defaultConfiguration
.
Propiedad MXML predeterminadamxmlChildren
Más ejemplos
Elementos de API relacionados
IConfiguration
DivElement
FlowElement
FlowGroupElement
FlowLeafElement
IFlowComposer
ParagraphElement
SpanElement
Propiedad | Definido por | ||
---|---|---|---|
alignmentBaseline : *
TextLayoutFormat: especifica la línea de base con la que se alinea la línea de base dominante. | FlowElement | ||
backgroundAlpha : *
TextLayoutFormat: valor de transparencia alfa del fondo (adopta su valor predeterminado si es undefined durante el proceso). | FlowElement | ||
backgroundColor : *
TextLayoutFormat: color de fondo del texto (adopta su valor predeterminado si es undefined durante el proceso). | FlowElement | ||
baselineShift : *
TextLayoutFormat: cantidad de desplazamiento de línea de base desde el valor dominantBaseline. | FlowElement | ||
blockProgression : *
TextLayoutFormat: especifica una progresión vertical u horizontal de la línea de ubicación de los archivos. | FlowElement | ||
breakOpportunity : *
TextLayoutFormat: controla dónde se permite romper las líneas si se divide el texto en varias líneas. | FlowElement | ||
cffHinting : *
TextLayoutFormat: tipo de sugerencia CFF utilizada para este texto. | FlowElement | ||
clearFloats : *
TextLayoutFormat: controla cómo ciñe el texto una posición flotante. | FlowElement | ||
color : *
TextLayoutFormat: color del texto. | FlowElement | ||
columnCount : *
TextLayoutFormat: número de las columnas de texto (adopta el valor predeterminado si es undefined durante el proceso). | FlowElement | ||
columnGap : *
TextLayoutFormat: especifica la cantidad de espacio de medianil, en píxeles, para dejar entre las columnas (adopta el valor predeterminado si es undefined durante el proceso). | FlowElement | ||
columnWidth : *
TextLayoutFormat: ancho de columna en píxeles (adopta el valor predeterminado si es undefined durante el proceso). | FlowElement | ||
computedFormat : flashx.textLayout.formats:ITextLayoutFormat [solo lectura]
Devuelve los atributos de formato calculados que afectan a este elemento. | FlowElement | ||
configuration : IConfiguration [solo lectura]
El objeto Configuration para este objeto TextFlow. | TextFlow | ||
constructor : Object
Una referencia a la clase de objeto o función constructora para una instancia de objeto determinada. | Object | ||
coreStyles : Object [solo lectura] Devuelve coreStyles de este objeto FlowElement. | FlowElement | ||
defaultConfiguration : Configuration [estática] Configuración predeterminada para todos los nuevos objetos TextFlow si no se especifica configuración. | TextFlow | ||
digitCase : *
TextLayoutFormat: tipo de caja de dígitos utilizada para este texto. | FlowElement | ||
digitWidth : *
TextLayoutFormat: tipo de anchura de dígitos para este texto. | FlowElement | ||
direction : *
TextLayoutFormat: especifica la incorporación bidireccional predeterminada del texto del bloque de texto. | FlowElement | ||
dominantBaseline : *
TextLayoutFormat: especifica qué líneas de base del elemento se ajustan a alignmentBaseline para determinar la posición vertical del elemento en la línea. | FlowElement | ||
firstBaselineOffset : *
TextLayoutFormat: especifica la posición de línea de base de la primera línea en el contenedor. | FlowElement | ||
flowComposer : IFlowComposer [override] Administra los contenedores para este elemento. | TextFlow | ||
fontFamily : *
TextLayoutFormat: nombre de la fuente que se va a utilizar o una lista de nombres de fuentes separados por comas. | FlowElement | ||
fontLookup : *
TextLayoutFormat: búsqueda de fuentes para utilizar. | FlowElement | ||
fontSize : *
TextLayoutFormat: el tamaño del texto, expresado en píxeles. | FlowElement | ||
fontStyle : *
TextLayoutFormat: estilo del texto. | FlowElement | ||
fontWeight : *
TextLayoutFormat: grosor del texto. | FlowElement | ||
format : flashx.textLayout.formats:ITextLayoutFormat Propiedades de TextLayoutFormat aplicadas directamente a este elemento. | FlowElement | ||
formatResolver : IFormatResolver Una función callback para resolver estilos de elementos. | TextFlow | ||
generation : uint [solo lectura]
El número de generación para este objeto TextFlow. | TextFlow | ||
hostFormat : flashx.textLayout.formats:ITextLayoutFormat El objeto TextLayoutFormat para este objeto TextFlow. | TextFlow | ||
id : String
Asigna un nombre de identificación al elemento. Esto hace posible establecer un estilo para el elemento haciendo referencia a su id. | FlowElement | ||
interactionManager : ISelectionManager
El elemento InteractionManager asociado a este objeto TextFlow. | TextFlow | ||
justificationRule : *
TextLayoutFormat: regla utilizada para justificar texto de un párrafo. | FlowElement | ||
justificationStyle : *
TextLayoutFormat: el estilo utilizado para la justificación del párrafo. | FlowElement | ||
kerning : *
TextLayoutFormat: el ajuste entre caracteres ajusta los píxeles entre determinados pares de caracteres para que puedan leerse mejor. | FlowElement | ||
leadingModel : *
TextLayoutFormat: especifica el modelo de interlineado, que es una combinación de la base y la dirección del interlineado. | FlowElement | ||
ligatureLevel : *
TextLayoutFormat: controla cuál de las ligaduras que se definen en la fuente se puede utilizar en el texto. | FlowElement | ||
lineBreak : *
TextLayoutFormat: controla el ajuste del texto dentro del contenedor (adopta el valor predeterminado si es undefined durante el proceso). | FlowElement | ||
lineHeight : *
TextLayoutFormat: controles de interlineado para el texto. | FlowElement | ||
lineThrough : *
TextLayoutFormat: si es true, se aplica el tachado (una línea dibujada en el centro del texto). | FlowElement | ||
linkActiveFormat : *
TextLayoutFormat: Define los atributos de formato utilizados por los vínculos de estado normal. | FlowElement | ||
linkHoverFormat : *
TextLayoutFormat: Define los atributos de formato utilizados para los vínculos al pasar por encima con el ratón, cuando éste se encuentra dentro de los límites (desplazamiento sobre) un vínculo. | FlowElement | ||
linkNormalFormat : *
TextLayoutFormat: Define los atributos de formato utilizados por los vínculos de estado normal. | FlowElement | ||
listAutoPadding : *
TextLayoutFormat: esto especifica una sangría automática para el borde inicial de listas cuando el valor de margen de la lista de ese lado es auto. | FlowElement | ||
listMarkerFormat : *
TextLayoutFormat: define los atributos de formato de lista de marcadores. | FlowElement | ||
listStylePosition : *
TextLayoutFormat: los valores aceptados son ListStylePosition.INSIDE, ListStylePosition.OUTSIDE, FormatValue.INHERIT. El valor predeterminado es undefined e indica que no está definido. Si son undefined durante el proceso, esta propiedad heredará su valor de un ascendiente. | FlowElement | ||
listStyleType : *
TextLayoutFormat: los valores aceptados son ListStyleType.UPPER_ALPHA, ListStyleType.LOWER_ALPHA, ListStyleType.UPPER_ROMAN, ListStyleType.LOWER_ROMAN, ListStyleType.NONE, ListStyleType.DISC, ListStyleType.CIRCLE, ListStyleType.SQUARE, ListStyleType.BOX, ListStyleType.CHECK, ListStyleType.DIAMOND, ListStyleType.HYPHEN, ListStyleType.ARABIC_INDIC, ListStyleType.BENGALI, ListStyleType.DECIMAL, ListStyleType.DECIMAL_LEADING_ZERO, ListStyleType.DEVANAGARI, ListStyleType.GUJARATI, ListStyleType.GURMUKHI, ListStyleType.KANNADA, ListStyleType.PERSIAN, ListStyleType.THAI, ListStyleType.URDU, ListStyleType.CJK_EARTHLY_BRANCH, ListStyleType.CJK_HEAVENLY_STEM, ListStyleType.HANGUL, ListStyleType.HANGUL_CONSTANT, ListStyleType.HIRAGANA, ListStyleType.HIRAGANA_IROHA, ListStyleType.KATAKANA, ListStyleType.KATAKANA_IROHA, ListStyleType.LOWER_ALPHA, ListStyleType.LOWER_GREEK, ListStyleType.LOWER_LATIN, ListStyleType.UPPER_ALPHA, ListStyleType.UPPER_GREEK, ListStyleType.UPPER_LATIN, FormatValue.INHERIT. El valor predeterminado es undefined e indica que no está definido. Si son undefined durante el proceso, esta propiedad heredará su valor de un ascendiente. | FlowElement | ||
locale : *
TextLayoutFormat: configuración regional del texto. | FlowElement | ||
mxmlChildren : Array
Añade un conjunto de elementos secundarios para este objeto. | FlowGroupElement | ||
numChildren : int [solo lectura]
Devuelve el número de elementos secundarios FlowElement que contiene este elemento FlowGroupElement. | FlowGroupElement | ||
paddingBottom : *
TextLayoutFormat: margen inferior en píxeles. | FlowElement | ||
paddingLeft : *
TextLayoutFormat: margen izquierdo en píxeles. | FlowElement | ||
paddingRight : *
TextLayoutFormat: margen derecho en píxeles. | FlowElement | ||
paddingTop : *
TextLayoutFormat: margen superior en píxeles. | FlowElement | ||
paragraphEndIndent : *
TextLayoutFormat: un número que especifica, en píxeles, la cantidad que se va a sangrar el final del borde del párrafo. | FlowElement | ||
paragraphSpaceAfter : *
TextLayoutFormat: un número que especifica la cantidad de espacio, en píxeles, que se deja después del párrafo. | FlowElement | ||
paragraphSpaceBefore : *
TextLayoutFormat: un número que especifica la cantidad de espacio, en píxeles, que se deja antes del párrafo. | FlowElement | ||
paragraphStartIndent : *
TextLayoutFormat: un número que especifica, en píxeles, la cantidad que se va a sangrar el inicio del borde del párrafo. | FlowElement | ||
parent : FlowGroupElement [solo lectura] Devuelve el elemento principal de este objeto FlowElement. | FlowElement | ||
parentRelativeEnd : int [solo lectura] Devuelve el final relativo de este objeto FlowElement en el elemento principal. | FlowElement | ||
parentRelativeStart : int [solo lectura] Devuelve el inicio relativo de este objeto FlowElement en el elemento principal. | FlowElement | ||
renderingMode : *
TextLayoutFormat: modo de representación utilizado para este texto. | FlowElement | ||
styleName : *
TextLayoutFormat: asigna una clase de identificación al elemento. Esto hace posible establecer un estilo para el elemento haciendo referencia a su objeto styleName. | FlowElement | ||
styles : Object [solo lectura] Devuelve los estilos de este objeto FlowElement. | FlowElement | ||
tabStops : *
TextLayoutFormat: especifica los tabuladores asociado con el párrafo. | FlowElement | ||
textAlign : *
TextLayoutFormat: alineación de las líneas del párrafo con respecto al contenedor. | FlowElement | ||
textAlignLast : *
TextLayoutFormat: alineación de la última (o única) línea del párrafo con relación al contenedor del texto justificado. | FlowElement | ||
textAlpha : *
TextLayoutFormat: valor alfa (transparencia) del texto. | FlowElement | ||
textDecoration : *
TextLayoutFormat: decoración del texto. | FlowElement | ||
textIndent : *
TextLayoutFormat: número que especifica, en píxeles, la cantidad para sangrar la primera línea del párrafo. | FlowElement | ||
textJustify : *
TextLayoutFormat: especifica las opciones para justificar texto. | FlowElement | ||
textLength : int [solo lectura]
Devuelve la longitud total del texto perteneciente a este objeto FlowElement y a sus elementos secundarios. | FlowElement | ||
textRotation : *
TextLayoutFormat: determina el número de grados para girar este texto. | FlowElement | ||
tracking : Object [solo escritura]
Establece el espaciado entre caracteres y es sinónimo de la propiedad trackingRight. | FlowElement | ||
trackingLeft : *
TextLayoutFormat: número, en píxeles, (o porcentaje de fontSize, por ejemplo, 120%) que indica la cantidad de espaciado entre caracteres (ajuste manual) que se debe aplicar a la izquierda de cada carácter. | FlowElement | ||
trackingRight : *
TextLayoutFormat: número, en píxeles, (o porcentaje de fontSize, por ejemplo, 120%) que indica la cantidad de espaciado entre caracteres (ajuste manual) que se debe aplicar a la derecha de cada carácter. | FlowElement | ||
typeName : String
Cada objeto FlowElement tiene un typeName. | FlowElement | ||
typographicCase : *
TextLayoutFormat: tipo de caja tipográfica utilizada para este texto. | FlowElement | ||
userStyles : Object Permite leer y escribir estilos de usuario en un objeto FlowElement. | FlowElement | ||
verticalAlign : *
TextLayoutFormat: alineación vertical o justificación (adopta el valor predeterminado si es undefined durante el proceso). | FlowElement | ||
whiteSpaceCollapse : *
TextLayoutFormat: contrae o conserva espacios en blanco cuando se importa texto en un objeto TextFlow. | FlowElement | ||
wordSpacing : *
TextLayoutFormat: especifica el espaciado óptimo, mínimo y máximo (como un multiplicador de la anchura de un espacio normal) entre las palabras que se utiliza durante la justificación. | FlowElement |
Método | Definido por | ||
---|---|---|---|
TextFlow(config:IConfiguration = null)
Constructor: crea una nueva instancia de TextFlow. | TextFlow | ||
Añade un objeto FlowElement secundario. | FlowGroupElement | ||
Añade un objeto FlowElement secundario en la posición de índice especificada. | FlowGroupElement | ||
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registra un objeto de detector de eventos con un objeto EventDispatcher, de modo que el detector reciba la notificación de un evento. | TextFlow | ||
Borra el estilo especificado por el parámetro styleProp desde este objeto FlowElement. | FlowElement | ||
Realiza una copia en profundidad de este objeto FlowElement, incluidos todos los elementos secundarios. Copia el contenido entre las dos posiciones de caracteres especificadas y devuelve la copia como un objeto FlowElement. | FlowElement | ||
Distribuye un evento en el flujo del evento. | TextFlow | ||
Compara el parámetro userStyles de este elemento con el de otro. | FlowElement | ||
Dada una posición relativa del texto, busca el índice del primer elemento secundario FlowElement que contiene la posición relativa. | FlowGroupElement | ||
Dada una posición relativa del texto, busca el elemento de hoja que contiene la posición. | FlowGroupElement | ||
Devuelve la ubicación inicial del elemento en el flujo de texto como un índice absoluto. | FlowElement | ||
Devuelve el carácter en la posición especificada con relación a este objeto FlowElement. | FlowElement | ||
Devuelve el código del carácter en la posición especificada con relación a este objeto FlowElement. | FlowElement | ||
Devuelve el elemento secundario FlowElement en el índice especificado. | FlowGroupElement | ||
Busca en elementos secundarios el objeto FlowElement especificado y devuelve su posición de índice. | FlowGroupElement | ||
Devuelve un elemento cuya propiedad id coincide con el parámetro idName. | TextFlow | ||
Devuelve el inicio de este elemento con relación a un elemento antecesor. | FlowElement | ||
Devuelve todos los elementos con styleName establecido como styleNameValue. | TextFlow | ||
Devuelve todos los elementos que tienen typeName establecido como typeNameValue. | TextFlow | ||
Devuelve el primer elemento FlowLeafElement descendente de este grupo. | FlowGroupElement | ||
Devuelve el último elemento FlowLeafElement descendente de este grupo. | FlowGroupElement | ||
Devuelve el siguiente elemento FlowElement secundario de la jerarquía del flujo de texto. | FlowElement | ||
Devuelve el objeto ParagraphElement asociado a este elemento. | FlowElement | ||
Devuelve el elemento FlowElement secundario anterior de la jerarquía del flujo de texto. | FlowElement | ||
Devuelve el valor del estilo especificado en el parámetro styleProp, que especifica el nombre del estilo y puede contener cualquier nombre de estilo de usuario. | FlowElement | ||
[override] | FlowGroupElement | ||
Asciende por la jerarquía del flujo de texto para devolver el objeto raíz TextFlow para el elemento. | FlowElement | ||
Comprueba si el objeto EventDispatcher tiene detectores registrados para un tipo concreto de evento. | TextFlow | ||
Indica si un objeto tiene definida una propiedad especificada. | Object | ||
Llamado para objetos MXML tras crearse el objeto de implementación y todas las propiedades de componentes especificadas en la etiqueta MXML se hayan inicializado. | FlowElement | ||
Invalida toda la información de formato de TextFlow y obliga a volver a calcularla. | TextFlow | ||
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 | ||
Elimina el objeto secundario FlowElement especificado del grupo. | FlowGroupElement | ||
Elimina el objeto secundario FlowElement situado en la posición de índice especificada. | FlowGroupElement | ||
Elimina un detector del objeto EventDispatcher. | TextFlow | ||
Sustituye elementos secundarios del grupo por los elementos nuevos especificados. | FlowGroupElement | ||
Establece la disponibilidad de una propiedad dinámica para operaciones de bucle. | Object | ||
Establece el estilo especificado por el parámetro styleProp en el valor especificado por el parámetro newValue. | FlowElement | ||
Hace una copia de este objeto FlowElement. Para ello, copia el contenido entre dos posiciones de caracteres especificadas. | FlowElement | ||
Divide este objeto en la posición especificada por el parámetro childIndex. | FlowGroupElement | ||
Divide este objeto FlowElement en la posición especificada por el parámetro relativePosition, que es una posición relativa en el texto para este elemento. | FlowElement | ||
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 | ||
Comprueba si hay registrado un detector de eventos con este objeto EventDispatcher o con cualquiera de sus ascendientes para el tipo de evento concreto. | TextFlow |
Evento | Resumen | Definido por | ||
---|---|---|---|---|
Se distribuye cuando se hace clic en cualquier vínculo. | TextFlow | |||
Se distribuye tras cualquier recomposición. | TextFlow | |||
Distribuido por un objeto TextFlow cada vez que se daña. Puede usar este evento para saber qué ha cambiado en TextFlow, pero no para acceder al propio objeto TextFlow cuando se envíe este evento. | TextFlow | |||
Define el valor de la propiedad type de un objeto de evento flowOperationBegin. | TextFlow | |||
Define el valor de la propiedad type de un objeto de evento flowOperationComplete. | TextFlow | |||
Define el valor de la propiedad type de un objeto de evento flowOperationEnd. | TextFlow | |||
Se distribuye cuando cambia el tamaño de un elemento InlineGraphicElement debido al ajuste automático o porcentual de la anchura y la altura y cuando el gráfico termina de cargarse. | TextFlow | |||
Se distribuye cuando el ratón se pulsa encima de algún vínculo. | TextFlow | |||
Se distribuye cuando el ratón pasa por encima de algún vínculo. | TextFlow | |||
Se distribuye cuando el ratón se suelta encima de algún vínculo. | TextFlow | |||
Se distribuye cuando el ratón sale de cualquier vínculo. | TextFlow | |||
Se distribuye cuando el ratón entra en el vínculo por primera vez. | TextFlow | |||
Distribuido por un objeto TextFlow después del desplazamiento de texto dentro de un contenedor del controlador. | TextFlow | |||
Se distribuye siempre que cambia la selección. | TextFlow | |||
Distribuido por un objeto TextFlow cada vez que se añaden o se actualizan objetos DisplayObjects al contenedor como resultado de la composición. | TextFlow |
configuration | propiedad |
configuration:IConfiguration
[solo lectura] Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | Flash Player 10, AIR 1.5 |
El objeto Configuration para este objeto TextFlow. El objeto Configuration especifica los formatos de caracteres iniciales y de párrafo, el formato de contenedor inicial y los atributos para la selección de resaltado, vínculos, activación y desplazamiento.
Si no especifica ningún objeto Configuration, Text Layout Framework utiliza un objeto Configuration predeterminado al que hace referencia la propiedad defaultConfiguration
.
Implementación
public function get configuration():IConfiguration
Elementos de API relacionados
defaultConfiguration | propiedad |
public static var defaultConfiguration:Configuration
Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | Flash Player 10, AIR 1.5 |
Configuración predeterminada para todos los nuevos objetos TextFlow si no se especifica configuración.
Elementos de API relacionados
flowComposer | propiedad |
flowComposer:IFlowComposer
[override] Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | Flash Player 10, AIR 1.5 |
Administra los contenedores para este elemento.
Los objetos TextLine creados a partir del elemento se muestran como elementos secundarios del contenedor. flowComposer administra los contenedores y, a medida que se edita el texto, añade o elimina líneas de los contenedores. flowComposer también lleva un seguimiento de algunos atributos vitales, como la anchura y la altura de composición, si hay desplazamiento, etc.
El contenedor y flowComposer
están íntimamente relacionados. Si restaura flowComposer
, el contenedor se restaura también según el nuevo contenedor de flowComposer. Del mismo modo, si se restaura el contenedor, flowComposer
se restaura también según el nuevo flowComposer del contenedor.
Implementación
override public function get flowComposer():IFlowComposer
override public function set flowComposer(value:IFlowComposer):void
Elementos de API relacionados
formatResolver | propiedad |
formatResolver:IFormatResolver
Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | Flash Player 10, AIR 1.5 |
Una función callback para resolver estilos de elementos. Puede utilizarla para proporcionar estilos con CSS o estilos existentes, por ejemplo.
Implementación
public function get formatResolver():IFormatResolver
public function set formatResolver(value:IFormatResolver):void
Elementos de API relacionados
generation | propiedad |
generation:uint
[solo lectura] Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | Flash Player 10, AIR 1.5 |
El número de generación para este objeto TextFlow. Las operaciones Deshacer y Rehacer utilizan este número de generación para validar que están permitidas las acciones para deshacer y rehacer. Los números de generación deben coincidir.
Cada cambio de modelo hace que la generación
se incremente, por lo que si el número de generación cambia, sabrá que el modelo de TextFlow ha cambiado.
Implementación
public function get generation():uint
hostFormat | propiedad |
hostFormat:flashx.textLayout.formats:ITextLayoutFormat
Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | Flash Player 10, AIR 1.5 |
El objeto TextLayoutFormat para este objeto TextFlow. Esto permite diversas optimizaciones para reutilizar formatos host. Por ejemplo;
textFlowA.hostFormat = textFlowB.hostFormat
hostFormat
. Por ejemplo, las siguientes líneas no establecen el tamaño de fuente en 24 porque el tamaño de fuente se define después de que el objeto TextLayoutFormat se haya asignado a hostFormat
.
format = new TextLayoutFormat() textFlow.hostFormat = format format.fontSize = 24;
Implementación
public function get hostFormat():flashx.textLayout.formats:ITextLayoutFormat
public function set hostFormat(value:flashx.textLayout.formats:ITextLayoutFormat):void
Elementos de API relacionados
interactionManager | propiedad |
interactionManager:ISelectionManager
Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | Flash Player 10, AIR 1.5 |
El elemento InteractionManager asociado a este objeto TextFlow.
Controla toda la selección y edición del texto. Si el objeto TextFlow no se puede seleccionar, interactionManager es null. Para que TextFlow se pueda editar, asigne un elemento interactionManager que sea tanto ISelectionManager como IEditManager. Para crear un objeto TextFlow de sólo lectura y que permita selección, asigne un interactionManager que sea solamente ISelectionManager.
Implementación
public function get interactionManager():ISelectionManager
public function set interactionManager(value:ISelectionManager):void
Elementos de API relacionados
TextFlow | () | Información sobre |
public function TextFlow(config:IConfiguration = null)
Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | Flash Player 10, AIR 1.5 |
Constructor: crea una nueva instancia de TextFlow.
Si proporciona un parámetro config
, el contenido del objeto Configuration se copiará y no podrá realizar cambios. Puede acceder a los valores de configuración, no obstante, a través de la propiedad configuration
. Si el parámetro config
es null, puede acceder a los valores de configuración predeterminados a través de la propiedad defaultConfiguration
.
El objeto Configuration proporciona un mecanismo para establecer atributos predeterminados configurables en un objeto TextFlow. Aunque no es posible hacer cambios en el objeto Configuration, puede anular los atributos predeterminados si es necesario y establecer los de TextFlow y sus elementos secundarios.
Parámetrosconfig:IConfiguration (default = null ) — Especifica la configuración que se utiliza para este objeto TextFlow. Si es null, utilice TextFlow.defaultConfiguration para acceder a los valores de configuración.
|
Elementos de API relacionados
addEventListener | () | método |
public function addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | Flash Player 10, AIR 1.5 |
Registra un objeto de detector de eventos con un objeto EventDispatcher, de modo que el detector reciba la notificación de un evento. Puede registrar detectores de eventos en todos los nodos de la lista de visualización para un tipo concreto de evento, fase y prioridad.
Una vez registrado correctamente un detector de eventos, no puede cambiar su prioridad mediante llamadas adicionales a addEventListener()
. Para cambiar la prioridad de un detector, en primer lugar debe llamar a removeEventListener()
. Seguidamente, puede volver a registrar el nuevo nivel de prioridad.
Una vez registrado el detector, las siguientes llamadas a addEventListener()
con un valor type
o useCapture
distinto tendrán como resultado la creación de un registro independiente del detector. Por ejemplo, si registra primero un detector con useCapture
definido como true
, detectará únicamente durante la fase de captura. Si vuelve a llamar a addEventListener()
con el mismo objeto detector, pero con useCapture
definido como false
, tendrá dos detectores independientes: uno que detecta durante la fase de captura y otro que lo hace durante las fases de destino y de propagación.
No es posible registrar un detector de eventos únicamente para la fase de destino o la fase de propagación. Dichas fases se acoplan durante el registro, ya que la propagación sólo se aplica a los ascendientes del nodo de destino.
Si ya no necesita ningún detector de eventos, elimínelo llamando a EventDispatcher.removeEventListener()
; en caso contrario, podrían surgir problemas de memoria. Los objetos con detectores de eventos registrados no se eliminan automáticamente de la memoria, ya que el recolector de datos innecesarios no elimina objetos que aún tienen referencias.
Al copiar una instancia EventDispatcher no se copian los detectores de eventos asociados. (Si el nodo recién creado necesita un detector de eventos, debe asociarlo después de crear el nodo.) Sin embargo, si mueve una instancia EventDispatcher, los detectores de eventos asociados se moverán también.
Si el detector de eventos se registra en un nodo mientras se procesa un evento en dicho nodo, el detector de eventos no se desencadenará durante la fase actual, aunque sí se desencadenará en una fase posterior del flujo del evento, por ejemplo, en la fase de propagación.
Si un detector de eventos se elimina de un nodo mientras se procesa un evento en dicho nodo, las acciones actual seguirán desencadenándolo. Una vez eliminado, el detector de eventos ya no se vuelve a invocar nunca más (a no ser que se registre de nuevo para otro proceso).
Parámetros
type:String — El tipo de evento.
| |
listener:Function — La función del detector que procesa el evento. Esta función debe aceptar un objeto de evento como parámetro único y no debe devolver ningún valor, tal como indica el siguiente ejemplo:
| |
useCapture:Boolean (default = false ) — Determina si el detector funciona en la fase de captura o en las fases de destino y de propagación. Si useCapture se define como true , el detector procesa el evento sólo durante la fase de captura y no en las fases de destino o propagación. Si useCapture es false , el detector procesa el evento sólo durante la fase de destino o de propagación. Para detectar el evento en las tres fases, llame dos veces a addEventListener() , una con useCapture definido como true y, a continuación, otra con useCapture establecido en false .
| |
priority:int (default = 0 ) — El nivel de prioridad del detector de eventos. Las prioridades se designan mediante un entero de 32 bits. Cuanto mayor sea el número, mayor será la prioridad. Todos los detectores con prioridad n se procesan antes que los detectores con prioridad n-1. Si dos o más detectores comparten la misma prioridad, se procesarán en el orden en el que se añadieron. La prioridad predeterminada es 0.
| |
useWeakReference:Boolean (default = false ) — Determina si la referencia al detector es fuerte o débil. Una referencia fuerte (valor predeterminado) impide que el detector sea eliminado por el recolector de datos innecesarios. Una referencia débil no lo hace. Las funciones de miembros de clase no están sujetas a la recolección de elementos no utilizados, por lo que |
dispatchEvent | () | método |
public function dispatchEvent(event:Event):Boolean
Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | Flash Player 10, AIR 1.5 |
Distribuye un evento en el flujo del evento. El destino del evento es el objeto EventDispatcher en el que se llama dispatchEvent()
.
Parámetros
event:Event — El objeto de evento distribuido en el flujo del evento.
|
Boolean — Un valor true a menos que se llame a preventDefault() en el evento, en cuyo caso devolverá false .
|
getBackgroundManager | () | método |
getElementByID | () | método |
public function getElementByID(idName:String):FlowElement
Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | Flash Player 10, AIR 1.5 |
Devuelve un elemento cuya propiedad id
coincide con el parámetro idName
. Permite aplicar un estilo basado en el id
.
Por ejemplo, la línea siguiente establece el estilo "color" como 0xFF0000 (rojo) para el elemento con id
span1.
textFlow.getElementByID("span1").setStyle("color", 0xFF0000);
Nota: en el código siguiente, p.addChild(s)
elimina s
de su elemento principal original y lo añade a p
, el nuevo elemento principal.
var s:SpanElement = new SpanElement(); var p:ParagraphElement = new ParagraphElement(); ... s = textFlow.getElementByID("span3") as SpanElement; p.addChild(s); textFlow.addChild(p);
Parámetros
idName:String — El valor de id del elemento que se quiere encontrar.
|
FlowElement — El elemento cuyo id coincide con idName .
|
Elementos de API relacionados
Ejemplo ( Cómo utilizar este ejemplo )
getElementByID()
para acceder al fragmento con el id span3
y su color definido como rojo.
package flashx.textLayout.elements.examples { import flash.display.Sprite; import flashx.textLayout.conversion.TextConverter; import flashx.textLayout.container.ContainerController; import flashx.textLayout.elements.ParagraphElement; import flashx.textLayout.elements.SpanElement; import flashx.textLayout.elements.TextFlow; public class TextFlow_getElementByIDExample extends Sprite { public function TextFlow_getElementByIDExample() { // create the TextFlow object var textFlow:TextFlow = new TextFlow(); // xml markup that defines the attributes and contents of a text flow var simpleText:String = "<?xml version=\"1.0\" encoding=\"utf-8\"?>" + "<flow:TextFlow xmlns:flow=\"http://ns.adobe.com/textLayout/2008\" verticalScrollPolicy=\"auto\" horizontalScrollPolicy=\"auto\" fontSize=\"14\" textIndent=\"15\" marginBottom=\"15\" paddingTop=\"4\" paddingLeft=\"4\">"+ "<flow:p>"+ "<flow:span id='span1'>In the first paragraph of the </flow:span>"+ "<flow:span id='span2' fontStyle=\"italic\">cheap </flow:span>"+ "<flow:span id='span3'>Western novel, a cowboy meets a saloon girl.</flow:span>"+ "</flow:p>"+ "</flow:TextFlow>"; var s:SpanElement = new SpanElement(); var s2:SpanElement = new SpanElement(); var p:ParagraphElement = new ParagraphElement(); // import the xml markup into a TextFlow object and display it on the stage textFlow = TextConverter.importToFlow(simpleText, TextConverter.TEXT_LAYOUT_FORMAT); // get element with ID of span3, make a copy of it textFlow.getElementByID("span3").setStyle("color", 0xFF0000); textFlow.flowComposer.addController(new ContainerController(this, 200, 800)); textFlow.flowComposer.updateAllControllers(); } } }
getElementsByStyleName | () | método |
public function getElementsByStyleName(styleNameValue:String):Array
Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | Flash Player 10, AIR 1.5 |
Devuelve todos los elementos con styleName
establecido como styleNameValue
.
Parámetros
styleNameValue:String — El nombre del estilo para el que se buscan elementos que lo tengan establecido.
|
Array — Un conjunto de elementos cuyo valor de styleName coincide con styleNameValue . Por ejemplo, todos los elementos que tienen el mismo nombre de estilo "color".
|
Elementos de API relacionados
getElementsByTypeName | () | método |
public function getElementsByTypeName(typeNameValue:String):Array
Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | Flash Player 10, AIR 1.5 |
Devuelve todos los elementos con typeName
como typeNameValue
.
Parámetros
typeNameValue:String — El nombre del estilo para el que se buscan elementos que lo tengan establecido.
|
Array — Un conjunto de elementos cuyo valor de typeName coincide con typeNameValue . Por ejemplo, todos los elementos que tienen el mismo nombre de tipo "color".
|
Elementos de API relacionados
hasEventListener | () | método |
public function hasEventListener(type:String):Boolean
Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | Flash Player 10, AIR 1.5 |
Comprueba si el objeto EventDispatcher tiene detectores registrados para un tipo concreto de evento. De este modo, es posible determinar en qué lugar de la jerarquía del flujo del evento un objeto EventDispatcher ha alterado el control de un tipo de evento. Para determinar si un tipo de evento concreto realmente desencadenará un detector de eventos, utilice IEventDispatcher.willTrigger()
.
La diferencia entre hasEventListener()
y willTrigger()
reside en que hasEventListener()
examina sólo el objeto al que pertenece, mientras que willTrigger()
examina todo el flujo del evento especificado por el parámetro type
.
Parámetros
type:String — El tipo de evento.
|
Boolean — Un valor true si está registrado un detector del tipo especificado; false en caso contrario.
|
invalidateAllFormats | () | método |
public function invalidateAllFormats():void
Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | Flash Player 10, AIR 1.5 |
Invalida toda la información de formato de TextFlow y obliga a volver a calcularla. Llame a este método si han cambiado los estilos.
Elementos de API relacionados
removeEventListener | () | método |
public function removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | Flash Player 10, AIR 1.5 |
Elimina un detector del objeto EventDispatcher. Si no hay ningún detector coincidente registrado con el objeto EventDispatcher, la llamada a este método no surtirá ningún efecto.
Parámetros
type:String — El tipo de evento.
| |
listener:Function — El objeto detector que se va a eliminar.
| |
useCapture:Boolean (default = false ) — Especifica si el detector se registró para la fase de captura o para las fases de destino y de propagación. Si el detector se registró para la fase de captura y para las fases de destino y propagación, serán necesarias dos llamadas a removeEventListener() para eliminar ambos: una llamada con useCapture definido como true y otra llamada con useCapture definido como false .
|
willTrigger | () | método |
public function willTrigger(type:String):Boolean
Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | Flash Player 10, AIR 1.5 |
Comprueba si hay registrado un detector de eventos con este objeto EventDispatcher o con cualquiera de sus ascendientes para el tipo de evento concreto. Este método devuelve true
si se desencadena un detector de eventos durante cualquier fase del flujo del evento cuando se distribuye un evento del tipo especificado a este objeto EventDispatcher o a cualquiera de sus descendientes.
La diferencia entre hasEventListener()
y willTrigger()
reside en que hasEventListener()
examina sólo el objeto al que pertenece, mientras que willTrigger()
examina todo el flujo del evento especificado por el parámetro type
.
Parámetros
type:String — El tipo de evento.
|
Boolean — Un valor true si se desencadena un detector del tipo especificado; de lo contrario, false .
|
click | Evento |
flashx.textLayout.events.FlowElementMouseEvent
Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | Flash Player 10, AIR 1.5 |
Se distribuye cuando se hace clic en cualquier vínculo.
compositionComplete | Evento |
flashx.textLayout.events.CompositionCompleteEvent
Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | Flash Player 10, AIR 1.5 |
Se distribuye tras cualquier recomposición.
damage | Evento |
flashx.textLayout.events.DamageEvent
Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | Flash Player 10, AIR 1.5 |
Distribuido por un objeto TextFlow cada vez que se daña. Puede usar este evento para saber qué ha cambiado en TextFlow, pero no para acceder al propio objeto TextFlow cuando se envíe este evento. Este evento se envía cuando los cambios de TextFlow han concluido parcialmente. Por ello, puede tener un estado incoherente: algunos cambios ya se han registrado y otros siguen pendientes. Obtenga la información que necesite del evento y lleve a cabo los cambios necesarios cuando el control vuelva a su aplicación.
flowOperationBegin | Evento |
flashx.textLayout.events.FlowOperationEvent
propiedad FlowOperationEvent.type =
flashx.textLayout.events.FlowOperationEvent.FLOW_OPERATION_BEGIN
Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | Flash Player 10, AIR 1.5 |
Define el valor de la propiedad
type
de un objeto de evento flowOperationBegin
. Se distribuye antes de que se ejecute ninguna operación. Si se cancela este evento, se bloquea la operación.
flowOperationComplete | Evento |
flashx.textLayout.events.FlowOperationEvent
propiedad FlowOperationEvent.type =
flashx.textLayout.events.FlowOperationEvent.FLOW_OPERATION_COMPLETE
Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | Flash Player 10, AIR 1.5 |
Define el valor de la propiedad
type
para un objeto de evento flowOperationComplete
Se distribuye una vez que todas las operaciones pendientes de composición han finalizado, la composición ha terminado y la visualización se ha desplazado.
flowOperationEnd | Evento |
flashx.textLayout.events.FlowOperationEvent
propiedad FlowOperationEvent.type =
flashx.textLayout.events.FlowOperationEvent.FLOW_OPERATION_END
Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | Flash Player 10, AIR 1.5 |
Define el valor de la propiedad
type
de un objeto de evento flowOperationEnd
. Se distribuye antes de que se ejecute ninguna operación. Todos los errores se guardan en OperationEvent.error
. Si se produce un error, cancelar este evento bloqueará la redifusión del mismo. Por norma general, todos los errores son graves.
Cambiar una operación en este momento (una vez ejecutada) es probable que falle.
inlineGraphicStatusChanged | Evento |
flashx.textLayout.events.StatusChangeEvent
Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | Flash Player 10, AIR 1.5 |
Se distribuye cuando cambia el tamaño de un elemento InlineGraphicElement debido al ajuste automático o porcentual de la anchura y la altura y cuando el gráfico termina de cargarse.
mouseDown | Evento |
flashx.textLayout.events.FlowElementMouseEvent
Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | Flash Player 10, AIR 1.5 |
Se distribuye cuando el ratón se pulsa encima de algún vínculo.
mouseMove | Evento |
flashx.textLayout.events.FlowElementMouseEvent
Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | Flash Player 10, AIR 1.5 |
Se distribuye cuando el ratón pasa por encima de algún vínculo.
mouseUp | Evento |
flashx.textLayout.events.FlowElementMouseEvent
Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | Flash Player 10, AIR 1.5 |
Se distribuye cuando el ratón se suelta encima de algún vínculo.
rollOut | Evento |
flashx.textLayout.events.FlowElementMouseEvent
Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | Flash Player 10, AIR 1.5 |
Se distribuye cuando el ratón sale de cualquier vínculo.
rollOver | Evento |
flashx.textLayout.events.FlowElementMouseEvent
Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | Flash Player 10, AIR 1.5 |
Se distribuye cuando el ratón entra en el vínculo por primera vez.
scroll | Evento |
flashx.textLayout.events.TextLayoutEvent
Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | Flash Player 10, AIR 1.5 |
Distribuido por un objeto TextFlow después del desplazamiento de texto dentro de un contenedor del controlador.
selectionChange | Evento |
flashx.textLayout.events.SelectionEvent
Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | Flash Player 10, AIR 1.5 |
Se distribuye siempre que cambia la selección. Se utiliza fundamentalmente para actualizar la interfaz de usuario dependiente de la selección. También se puede utilizar para modificar la selección, pero no puede utilizarse para modificar el objeto TextFlow en sí mismo.
updateComplete | Evento |
flashx.textLayout.events.UpdateCompleteEvent
Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | Flash Player 10, AIR 1.5 |
Distribuido por un objeto TextFlow cada vez que se añaden o se actualizan objetos DisplayObjects al contenedor como resultado de la composición.
package flashx.textLayout.elements.examples { import flash.display.Sprite; import flashx.textLayout.container.ContainerController; import flashx.textLayout.elements.Configuration; import flashx.textLayout.elements.ParagraphElement; import flashx.textLayout.elements.SpanElement; import flashx.textLayout.elements.TextFlow; import flashx.textLayout.formats.TextLayoutFormat; import flashx.textLayout.formats.TextAlign; import flash.text.engine.FontPosture; import flash.text.engine.Kerning; public class TextFlowExample extends Sprite { public function TextFlowExample() { var config:Configuration = new Configuration(); var textLayoutFormat:TextLayoutFormat = new TextLayoutFormat(); textLayoutFormat.color = 0xFF0000; textLayoutFormat.fontFamily = "Arial, Helvetica, _sans"; textLayoutFormat.fontSize = 48; textLayoutFormat.kerning = Kerning.ON; textLayoutFormat.fontStyle = FontPosture.ITALIC; textLayoutFormat.textAlign = TextAlign.CENTER; config.textFlowInitialFormat = textLayoutFormat; var textFlow:TextFlow = new TextFlow(config); var p:ParagraphElement = new ParagraphElement(); var span:SpanElement = new SpanElement(); span.text = "Hello, World!"; p.addChild(span); textFlow.addChild(p); textFlow.flowComposer.addController(new ContainerController(this,500,200)); textFlow.flowComposer.updateAllControllers(); } } }
Tue Jun 12 2018, 02:12 PM Z