FlowComposerBase

Пакет	flashx.textLayout.compose
Класс	public class FlowComposerBase
Наследование	FlowComposerBase Object
Подклассы	StandardFlowComposer

Язык версии:

ActionScript 3.0

Версии среды выполнения:

Flash Player 10, AIR 1.5

Класс FlowComposerBase является базовым классом для классов Text Layout Framework компоновщика потока, которые обеспечивают управление компоновкой текстовых строк в объектах ContainerController.

FlowComposerBase является служебным классом, который реализует методы и свойства, общие для нескольких типов компоновщиков потока. Как правило, код приложения не создает экземпляры этого класса и не использует этот класс (за исключением случая его расширения для создания пользовательского компоновщика потока).

Связанные элементы API

flashx.textLayout.elements.TextFlow.flowComposer

Общедоступные свойства

Скрыть унаследованные общедоступные свойства

Показать унаследованные общедоступные свойства

	Свойство		Определено
		constructor : Object Ссылка на объект класса или функцию конструктора для данного экземпляра объекта.	Object
		damageAbsoluteStart : int [только для чтения] Абсолютная позиция, непосредственно предшествующая первому элементу текстового потока, который требует компоновки и обновления.	FlowComposerBase
		numLines : int [только для чтения] Общее количество строк, созданных в потоке.	FlowComposerBase
		swfContext : ISWFContext Экземпляр ISWFContext, используемый для создания, при необходимости, вызовов FTE.	FlowComposerBase
		textFlow : flashx.textLayout.elements:TextFlow [только для чтения] Объект TextFlow, к которому присоединен этот компоновщик потока.	FlowComposerBase

Общедоступные методы

Скрыть унаследованные общедоступные методы

Показать унаследованные общедоступные методы

	Метод		Определено
		FlowComposerBase() Конструктор.	FlowComposerBase
		damage(startPosition:int, damageLength:int, damageType:String):void Пометить строки как поврежденные и требующие восстановления.	FlowComposerBase
		findLineAtPosition(absolutePosition:int, preferPrevious:Boolean = false):flashx.textLayout.compose:TextFlowLine Возвращает объект TextFlowLine, включающий содержимое в указанной позиции.	FlowComposerBase
		findLineIndexAtPosition(absolutePosition:int, preferPrevious:Boolean = false):int Возвращает порядковый номер строки объекта TextFlowLine, который включает содержимое в указанной позиции.	FlowComposerBase
		getLineAt(index:int):flashx.textLayout.compose:TextFlowLine Возвращает строку с указанным номером.	FlowComposerBase
		hasOwnProperty(name:String):Boolean Показывает, определено ли заданное свойство для объекта.	Object
		isDamaged(absolutePosition:int):Boolean Указывает, отмечены ли какие-либо объекты TextFlowLine между началом потока и строкой, включающей содержимое в указанной позиции, как поврежденные.	FlowComposerBase
		isPrototypeOf(theClass:Object):Boolean Показывает, есть ли экземпляр класса Object в цепи прототипов объекта, заданного в качестве параметра.	Object
		propertyIsEnumerable(name:String):Boolean Показывает наличие заданного свойства и его перечисляемость.	Object
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Задает доступность динамического свойства для операций цикла.	Object
		toLocaleString():String Возвращает строковое представление этого объекта, отформатированного в соответствии со стандартами, принятыми для данной локали.	Object
		toString():String Возвращает строковое представление заданного объекта.	Object
		updateLengths(startPosition:int, deltaLength:int):void Обновляет значения длины строк для поддержания отображения в TextFlow.	FlowComposerBase
		valueOf():Object Возвращает элементарное значение заданного объекта.	Object

Сведения о свойстве

damageAbsoluteStart

свойство

damageAbsoluteStart:int [только для чтения]

Язык версии:

ActionScript 3.0

Версии среды выполнения:

Flash Player 10, AIR 1.5

Абсолютная позиция, непосредственно предшествующая первому элементу текстового потока, который требует компоновки и обновления.

Реализация
public function get damageAbsoluteStart():int

numLines

свойство

numLines:int [только для чтения]

Язык версии:

ActionScript 3.0

Версии среды выполнения:

Flash Player 10, AIR 1.5

Общее количество строк, созданных в потоке. По умолчанию TLF не создает весь поток и это значение может быть неточным. composeToPosition используется для получения всех созданных строк.

Реализация
public function get numLines():int

swfContext

свойство

swfContext:ISWFContext

Язык версии:

ActionScript 3.0

Версии среды выполнения:

Flash Player 10, AIR 1.5

Экземпляр ISWFContext, используемый для создания, при необходимости, вызовов FTE.

По умолчанию реализация ISWFContext является объектом FlowComposerBase. Приложения могут предоставлять пользовательскую реализацию для использования шрифтов, встроенных в другой файл SWF, или для кэширования и повторного использования текстовых строк.

Реализация
public function get swfContext():ISWFContext
public function set swfContext(value:ISWFContext):void

Связанные элементы API

flashx.textLayout.compose.ISWFContext

textFlow

свойство

textFlow:flashx.textLayout.elements:TextFlow [только для чтения]

Язык версии:

ActionScript 3.0

Версии среды выполнения:

Flash Player 10, AIR 1.5

Объект TextFlow, к которому присоединен этот компоновщик потока.

Реализация
public function get textFlow():flashx.textLayout.elements:TextFlow

Связанные элементы API

flashx.textLayout.elements.TextFlow

Сведения о конструкторе

()

Конструктор

public function FlowComposerBase()

Язык версии:

ActionScript 3.0

Версии среды выполнения:

Flash Player 10, AIR 1.5

Конструктор.

Сведения о методе

damage

()

метод

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

Язык версии:

ActionScript 3.0

Версии среды выполнения:

Flash Player 10, AIR 1.5

Пометить строки как поврежденные и требующие восстановления.

Параметры

	`startPosition:int` — начало поврежденного диапазона

	`damageLength:int` — число поврежденных символов

	`damageType:String` — тип повреждения. Один из flashx.textLayout.compose.FlowDamageType

findLineAtPosition

()

метод

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

Язык версии:

ActionScript 3.0

Версии среды выполнения:

Flash Player 10, AIR 1.5

Возвращает объект TextFlowLine, включающий содержимое в указанной позиции.

Позиция может рассматриваться в качестве разделителя между двумя символами или другими элементами текстового потока. Если значение absolutePosition является позицией между последним элементом одной строки и первым элементом следующей, то возвращается предшествующая строка в том случае, если параметр preferPrevious имеет значение true, если же параметр preferPrevious имеет значение false, возвращается последующая строка.

Параметры

	`absolutePosition:int` — Позиция содержимого, для которой требуется определить объект TextFlowLine.

	`preferPrevious:Boolean` (default = `false`) — Указывает возвращаемую строку, если позиция находится между последним элементом одной линии и первым элементом следующей.

Возвращает

flashx.textLayout.compose:TextFlowLine — TextFlowLine, включающий содержимое в указанной позиции, либо null, если не найдено.

findLineIndexAtPosition

()

метод

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

Язык версии:

ActionScript 3.0

Версии среды выполнения:

Flash Player 10, AIR 1.5

Возвращает порядковый номер строки объекта TextFlowLine, который включает содержимое в указанной позиции.

Номер первой строки равен 0, номер последней строки равен количеству строк минус один. Если позиция, указанная значением absolutePosition, находится за пределами конца текстового потока, этот метод возвращает номер, который будет присвоен следующей новой строке, добавляемой к текстовому потоку (равный количеству текущих строк).

Позиция может рассматриваться в качестве разделителя между двумя символами или другими элементами текстового потока. Если значение в absolutePosition является позицией между последней строкой одного контейнера и первой строкой следующего, то в случае, если параметр preferPrevious имеет значение true, возвращается предшествующий контейнер, а в том случае, если для параметра preferPrevious установлено значение false, возвращается последующий контейнер.

Параметры

	`absolutePosition:int` — Позиция содержимого, для которой требуется определить текстовую строку.

	`preferPrevious:Boolean` (default = `false`) — Указывает индекс контейнера для возврата, если позиция находится между последней строкой одного контейнера и первой строкой следующего.

Возвращает

int — Индекс текстовой строки в указанной позиции. Если не найден, обрабатывается как значение за пределами конца строки, и возвращается количество строк.

getLineAt

()

метод

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

Язык версии:

ActionScript 3.0

Версии среды выполнения:

Flash Player 10, AIR 1.5

Возвращает строку с указанным номером.

Список строк нумеруется от нуля до значения, равного количеству строк минус один. Если значение index находится за пределами списка строк, то эта функция возвращает null.

Параметры

index:int — Номер возвращаемой строки объекта TextFlowLine.

Возвращает

flashx.textLayout.compose:TextFlowLine — TextFlowLine с указанным номером строки, либо null, если значение не найдено.

isDamaged

()

метод

public function isDamaged(absolutePosition:int):Boolean

Язык версии:

ActionScript 3.0

Версии среды выполнения:

Flash Player 10, AIR 1.5

Указывает, отмечены ли какие-либо объекты TextFlowLine между началом потока и строкой, включающей содержимое в указанной позиции, как поврежденные.

Параметры

absolutePosition:int — Последняя позиция в рассматриваемой области.

Возвращает

Boolean — true, если любой из объектов TextFlowLine с начала потока до строки, включающей содержимое в позиции absolutePosition, отмечен как поврежденный.

updateLengths

()

метод

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

Язык версии:

ActionScript 3.0

Версии среды выполнения:

Flash Player 10, AIR 1.5

Обновляет значения длины строк для поддержания отображения в TextFlow.

Параметры

	`startPosition:int` — Начало изменения длины

	`deltaLength:int` — Изменение числа символов.

Юридическая информация | Политика конфиденциальности онлайн

FlowComposerBase - AS3

Классы x

damageAbsoluteStart

numLines

swfContext

textFlow