FlowComposerBase

Paquete	flashx.textLayout.compose
Clase	public class FlowComposerBase
Herencia	FlowComposerBase Object
Subclases	StandardFlowComposer

Versión del lenguaje:

ActionScript 3.0

Versiones de motor de ejecución:

Flash Player 10, AIR 1.5

La clase FlowComposerBase es la clase en la que se basan las clases de composición de flujo de Text Layout Framework (TLF). Controla la composición de líneas de texto en objetos ContainerController.

FlowComposerBase es una clase de utilidad que implementa métodos y propiedades comunes para distintos tipos de composición de flujo. El código de la aplicación no suele crear instancias ni utilizar esta clase (a no ser que se amplíe para crear una composición de flujo personalizada).

Elementos de API relacionados

flashx.textLayout.elements.TextFlow.flowComposer

Propiedades públicas

Ocultar propiedades públicas heredadas

Mostrar propiedades públicas heredadas

	Propiedad		Definido por
		constructor : Object Una referencia a la clase de objeto o función constructora para una instancia de objeto determinada.	Object
		damageAbsoluteStart : int [solo lectura] La posición absoluta precede inmediatamente al primer elemento del flujo de texto que requiere composición y actualización.	FlowComposerBase
		numLines : int [solo lectura] El número total de líneas compuestas en el flujo.	FlowComposerBase
		swfContext : ISWFContext La instancia de ISWFContext utilizada para hacer llamadas FTE según sea necesario.	FlowComposerBase
		textFlow : flashx.textLayout.elements:TextFlow [solo lectura] El objeto TextFlow al que está conectada esta composición de flujo.	FlowComposerBase

Métodos públicos

Ocultar métodos públicos heredados

Mostrar métodos públicos heredados

	Método		Definido por
		FlowComposerBase() Constructor.	FlowComposerBase
		damage(startPosition:int, damageLength:int, damageType:String):void Marca las líneas como dañadas y que necesitan recomposición.	FlowComposerBase
		findLineAtPosition(absolutePosition:int, preferPrevious:Boolean = false):flashx.textLayout.compose:TextFlowLine Devuelve el objeto TextFlowLine que contiene el contenido en la posición especificada.	FlowComposerBase
		findLineIndexAtPosition(absolutePosition:int, preferPrevious:Boolean = false):int Devuelve el número de línea secuencial del objeto TextFlowLine que contiene el contenido en la posición especificada.	FlowComposerBase
		getLineAt(index:int):flashx.textLayout.compose:TextFlowLine Devuelve la línea con el número de línea especificado.	FlowComposerBase
		hasOwnProperty(name:String):Boolean Indica si un objeto tiene definida una propiedad especificada.	Object
		isDamaged(absolutePosition:int):Boolean Indica si alguno de los objetos TextFlowLine entre el principio de la línea y la línea que contiene el contenido en la posición especificada están marcados como dañados.	FlowComposerBase
		isPrototypeOf(theClass:Object):Boolean Indica si hay una instancia de la clase Object en la cadena de prototipo del objeto especificado como parámetro.	Object
		propertyIsEnumerable(name:String):Boolean Indica si existe la propiedad especificada y si es enumerable.	Object
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Establece la disponibilidad de una propiedad dinámica para operaciones de bucle.	Object
		toLocaleString():String Devuelve la representación de cadena de este objeto, con formato según las convenciones específicas de configuración regional.	Object
		toString():String Devuelve la representación de cadena del objeto especificado.	Object
		updateLengths(startPosition:int, deltaLength:int):void Actualiza las longitudes de las líneas para conservar la asignación con el objeto TextFlow.	FlowComposerBase
		valueOf():Object Devuelve el valor simple del objeto especificado.	Object

Información sobre propiedades

damageAbsoluteStart

propiedad

damageAbsoluteStart:int [solo lectura]

Versión del lenguaje:

ActionScript 3.0

Versiones de motor de ejecución:

Flash Player 10, AIR 1.5

La posición absoluta precede inmediatamente al primer elemento del flujo de texto que requiere composición y actualización.

Implementación
public function get damageAbsoluteStart():int

numLines

propiedad

numLines:int [solo lectura]

Versión del lenguaje:

ActionScript 3.0

Versiones de motor de ejecución:

Flash Player 10, AIR 1.5

El número total de líneas compuestas en el flujo. De forma predeterminada, TLF no necesita redactar todo el flujo y este valor puede ser impreciso. Utilice composeToPosition para obtener todas las líneas creadas.

Implementación
public function get numLines():int

swfContext

propiedad

swfContext:ISWFContext

Versión del lenguaje:

ActionScript 3.0

Versiones de motor de ejecución:

Flash Player 10, AIR 1.5

La instancia de ISWFContext utilizada para hacer llamadas FTE según sea necesario.

De forma predeterminada, la implementación de ISWFContext es este objeto FlowComposerBase. Las aplicaciones pueden proporcionar una implementación personalizada para utilizar fuentes incorporadas en un archivo SWF distinto o para guardar líneas de texto en caché y poder reutilizarlas.

Implementación
public function get swfContext():ISWFContext
public function set swfContext(value:ISWFContext):void

Elementos de API relacionados

flashx.textLayout.compose.ISWFContext

textFlow

propiedad

textFlow:flashx.textLayout.elements:TextFlow [solo lectura]

Versión del lenguaje:

ActionScript 3.0

Versiones de motor de ejecución:

Flash Player 10, AIR 1.5

El objeto TextFlow al que está conectada esta composición de flujo.

Implementación
public function get textFlow():flashx.textLayout.elements:TextFlow

Elementos de API relacionados

flashx.textLayout.elements.TextFlow

Información sobre constructores

()

Información sobre

public function FlowComposerBase()

Versión del lenguaje:

ActionScript 3.0

Versiones de motor de ejecución:

Flash Player 10, AIR 1.5

Constructor.

Información sobre métodos

damage

()

método

public function damage(startPosition:int, damageLength:int, damageType:String):void

Versión del lenguaje:

ActionScript 3.0

Versiones de motor de ejecución:

Flash Player 10, AIR 1.5

Marca las líneas como dañadas y que necesitan recomposición.

Parámetros

	`startPosition:int` — comienzo de rango para dañar

	`damageLength:int` — número de caracteres para dañar

	`damageType:String` — tipo de daño. Uno de flashx.textLayout.compose.FlowDamageType

findLineAtPosition

()

método

 public function findLineAtPosition(absolutePosition:int, preferPrevious:Boolean = false):flashx.textLayout.compose:TextFlowLine

Versión del lenguaje:

ActionScript 3.0

Versiones de motor de ejecución:

Flash Player 10, AIR 1.5

Devuelve el objeto TextFlowLine que contiene el contenido en la posición especificada.

Puede considerarse posición la división entre dos caracteres u otros elementos de un flujo de texto. El valor de absolutePosition es una posición entre el último elemento de una línea y el primer elemento de la siguiente. Seguidamente, se devuelve el contenedor precedente si el parámetro preferPrevious está establecido como true y se devuelve la última línea si el parámetro preferPrevious está establecido como false.

Parámetros

	`absolutePosition:int` — La posición del contenido para el que quiere el objeto TextFlowLine.

	`preferPrevious:Boolean` (default = `false`) — Especifica qué línea se debe devolver cuando la posición se encuentra entre el último elemento de una línea y el primer elemento de la siguiente.

Valor devuelto

flashx.textLayout.compose:TextFlowLine — objeto TextFlowLine con el contenido en la posición especificada, o null, si no se encuentra.

findLineIndexAtPosition

()

método

public function findLineIndexAtPosition(absolutePosition:int, preferPrevious:Boolean = false):int

Versión del lenguaje:

ActionScript 3.0

Versiones de motor de ejecución:

Flash Player 10, AIR 1.5

Devuelve el número de línea secuencial del objeto TextFlowLine que contiene el contenido en la posición especificada.

El número de la primera línea es 0 y el número de la última línea es igual al número de líneas menos uno. Si la posición especificada en absolutePosition supera el final del flujo de texto, este método debe devolver el número que se asignará a la nueva línea añadida al flujo de texto (que es igual al número de líneas actuales).

Puede considerarse posición la división entre dos caracteres u otros elementos de un flujo de texto. El valor de absolutePosition es una posición entre la última línea de un contenedor y la primera línea del siguiente. Seguidamente, se devuelve el contenedor precedente si el parámetro preferPrevious está establecido como true y se devuelve el último contenedor si el parámetro preferPrevious está establecido como false.

Parámetros

	`absolutePosition:int` — La posición del contenido para el que quiere la línea de texto.

	`preferPrevious:Boolean` (default = `false`) — Especifica qué índice de contenedor se debe devolver cuando la posición se encuentra entre la última línea de un contenedor y la primera línea del siguiente.

Valor devuelto

int — el índice de la línea de texto en la posición especificada. Si no se encuentra, lo trata como como fuera del final y devuelve el número de líneas.

getLineAt

()

método

public function getLineAt(index:int):flashx.textLayout.compose:TextFlowLine

Versión del lenguaje:

ActionScript 3.0

Versiones de motor de ejecución:

Flash Player 10, AIR 1.5

Devuelve la línea con el número de línea especificado.

La lista de líneas se numera desde cero hasta el número de líneas menos uno. Si el valor de index se encuentra fuera de los límites de la lista de líneas, esta función devuelve null.

Parámetros

index:int — El número de línea del objeto TextFlowLine que se va a devolver.

Valor devuelto

flashx.textLayout.compose:TextFlowLine — el objeto TextFlowLine con el número de línea especificado, o null, si no se encuentra.

isDamaged

()

método

public function isDamaged(absolutePosition:int):Boolean

Versión del lenguaje:

ActionScript 3.0

Versiones de motor de ejecución:

Flash Player 10, AIR 1.5

Indica si alguno de los objetos TextFlowLine entre el principio de la línea y la línea que contiene el contenido en la posición especificada están marcados como dañados.

Parámetros

absolutePosition:int — la última posición del área de interés

Valor devuelto

Boolean — true si alguno de los objetos TextFlowLine desde el inicio del flujo hasta la línea que contiene el contenido en absolutePosition aparece marcado como dañado.

updateLengths

()

método

public function updateLengths(startPosition:int, deltaLength:int):void

Versión del lenguaje:

ActionScript 3.0

Versiones de motor de ejecución:

Flash Player 10, AIR 1.5

Actualiza las longitudes de las líneas para conservar la asignación con el objeto TextFlow.

Parámetros

	`startPosition:int` — inicio del cambio de longitud

	`deltaLength:int` — cambio en el número de caracteres.

Avisos legales | Política de privacidad en línea

FlowComposerBase - AS3

Paquetesx

Elementos del lenguaje

Apéndices

Paquete flashx.textLayout.compose

damageAbsoluteStart

numLines

swfContext

textFlow