Справочник по ActionScript® 3.0 для платформы Adobe® Flash®
Домашняя страница  |  Скрыть список пакетов и классов |  Пакеты  |  Классы  |  Что нового  |  Указатель  |  Приложения  |  Почему по-английски?
Фильтры: Получение данных с сервера...
Получение данных с сервера...
flashx.textLayout.elements 

TextFlow  - AS3

Пакетflashx.textLayout.elements
Классpublic class TextFlow
НаследованиеTextFlow Inheritance ContainerFormattedElement Inheritance ParagraphFormattedElement Inheritance FlowGroupElement Inheritance FlowElement Inheritance Object
Реализует IEventDispatcher

Язык версии: ActionScript 3.0
Версии среды выполнения: Flash Player 10, AIR 1.5

Класс TextFlow используется для управления всем текстовым содержимым статьи. В TextLayout текст хранится в виде иерархического дерева элементов. TextFlow — корневой объект дерева элемента. Все элементы дерева происходят от базового класса FlowElement.

Объект TextFlow в качестве дочерних элементов может иметь объекты ParagraphElement и DivElement. Элемент div (объект DivElement) представляет группу абзацев (объекты ParagraphElement). Абзац может иметь в качестве дочерних элементов объекты SpanElement, InlineGraphicElement, LinkElement и TCYElement.

Элемент диапазона (SpanElement) является диапазоном текста в абзаце, имеющим одинаковые атрибуты. Изображение (InlineGraphicElement) представляет произвольную графику, отображаемую в виде отдельного символа в строке текста. LinkElement представляет гиперссылку или HTML-тег a. Он может содержать несколько диапазонов. Объект TCYElement используется для японского языка для отображения небольшого фрагмента текста, направленного перпендикулярно к строке, то есть в виде горизонтально направленной строки текста в вертикальной строке. TCYElement может также содержать несколько диапазонов.

TextFlow также происходит от класса ContainerFormattedElement, который является корневым классом для всех элементов блока уровня контейнера.

На следующей иллюстрации показано отношение других элементов, например, диапазонов и абзацев, к объекту TextFlow.

пример иерархии TextFlow

Каждый объект TextFlow имеет соответствующий объект Configuration, что позволяет указывать начальные форматы символа и абзаца и начальный формат контейнера. Также можно указывать атрибуты для выделения, ссылок, фокуса и прокрутки. При использовании объекта Configuration в качестве параметра конструктора TextFlow() создается доступный только для чтения снимок, к которому можно получить доступ через свойство TextFlow.configuration. После его создания конфигурацию TextFlow изменить невозможно. Если Configuration не указан, получить доступ к стандартной конфигурации можно через свойство TextFlow.defaultConfiguration.

Свойство MXML по умолчаниюmxmlChildren

Посмотреть примеры

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



Общедоступные свойства
 СвойствоОпределено
 InheritedalignmentBaseline : *
TextLayoutFormat: определяет базовую линию, по которой выравнивается основная базовая линия.
FlowElement
 InheritedbackgroundAlpha : *
TextLayoutFormat: альфа-значение (прозрачности) для фона (принимает значение по умолчанию, если имеет значение undefined в процессе каскада).
FlowElement
 InheritedbackgroundColor : *
TextLayoutFormat: цвет фона (принимает значение по умолчанию, если имеет значение undefined в процессе каскада).
FlowElement
 InheritedbaselineShift : *
TextLayoutFormat: величина сдвига базовой линии от значения dominantBaseline.
FlowElement
 InheritedblockProgression : *
TextLayoutFormat: указывает размещение срок по вертикали или горизонтали.
FlowElement
 InheritedbreakOpportunity : *
TextLayoutFormat: определяет допустимые места разбиения строк, когда обтекающий текст разбивается на несколько строк.
FlowElement
 InheritedcffHinting : *
TextLayoutFormat: тип используемого для текста хинтинга CFF.
FlowElement
 InheritedclearFloats : *
TextLayoutFormat: определяет тип обтекания текста вокруг плавающего объекта.
FlowElement
 Inheritedcolor : *
TextLayoutFormat: цвет текста.
FlowElement
 InheritedcolumnCount : *
TextLayoutFormat: число колонок текста (принимает значение по умолчанию, если имеет значение undefined в процессе каскада).
FlowElement
 InheritedcolumnGap : *
TextLayoutFormat: определяет величину промежутка между колонками в пикселях (принимает значение по умолчанию, если имеет значение undefined в процессе каскада).
FlowElement
 InheritedcolumnWidth : *
TextLayoutFormat: ширина колонки в пикселях (принимает значение по умолчанию, если в процессе каскада было установлено значение undefined).
FlowElement
 InheritedcomputedFormat : flashx.textLayout.formats:ITextLayoutFormat
[только для чтения] Возвращает вычисленные атрибуты формата, являющиеся действующими для этого элемента.
FlowElement
  configuration : IConfiguration
[только для чтения] Объект Configuration для данного объекта TextFlow.
TextFlow
 Inheritedconstructor : Object
Ссылка на объект класса или функцию конструктора для данного экземпляра объекта.
Object
 InheritedcoreStyles : Object
[только для чтения] Возвращает coreStyles в этот FlowElement.
FlowElement
  defaultConfiguration : Configuration
[статические] Стандартная конфигурация, используемая для всех новых объектов TextFlow, если не указана иная настройка.
TextFlow
 InheriteddigitCase : *
TextLayoutFormat: тип регистра цифр, используемого для текста.
FlowElement
 InheriteddigitWidth : *
TextLayoutFormat: тип ширины цифр, используемый для этого текста.
FlowElement
 Inheriteddirection : *
TextLayoutFormat: задает уровень двунаправленной вложенности текста в блоке по умолчанию.
FlowElement
 InheriteddominantBaseline : *
TextLayoutFormat: указывает, какая из базовых линий элемента привязывается к alignmentBaseline для определения позиции элемента в строке по вертикали.
FlowElement
 InheritedfirstBaselineOffset : *
TextLayoutFormat: определяет положение базовой линии первой строки в контейнере.
FlowElement
  flowComposer : IFlowComposer
[переопределить] Управляет контейнерами для этого элемента.
TextFlow
 InheritedfontFamily : *
TextLayoutFormat: имя используемого шрифта или разделенный запятой список имен шрифтов.
FlowElement
 InheritedfontLookup : *
TextLayoutFormat: поиск используемых шрифтов.
FlowElement
 InheritedfontSize : *
TextLayoutFormat: размер текста в пикселях.
FlowElement
 InheritedfontStyle : *
TextLayoutFormat: стиль текста.
FlowElement
 InheritedfontWeight : *
TextLayoutFormat: толщина текста.
FlowElement
 Inheritedformat : flashx.textLayout.formats:ITextLayoutFormat
Свойства TextLayoutFormat, применяются непосредственно к этому элементу.
FlowElement
  formatResolver : IFormatResolver
Функция обратного вызова для разрешения стилей элемента.
TextFlow
  generation : uint
[только для чтения] Номер генерации для этого объекта TextFlow.
TextFlow
  hostFormat : flashx.textLayout.formats:ITextLayoutFormat
Объект TextLayoutFormat для данного объекта TextFlow.
TextFlow
 Inheritedid : String
Присваивает элементу идентификатор, позволяя задавать стиль для элемента путем ссылки на его id.
FlowElement
  interactionManager : ISelectionManager
InteractionManager, связанный с данным объектом TextFlow.
TextFlow
 InheritedjustificationRule : *
TextLayoutFormat: правило, используемое для выравнивания текста в абзаце.
FlowElement
 InheritedjustificationStyle : *
TextLayoutFormat: стиль, используемый для выравнивания абзаца.
FlowElement
 Inheritedkerning : *
TextLayoutFormat: кернинг регулирует количество пикселов между определенными парами символов с целью улучшения удобочитаемости текста.
FlowElement
 InheritedleadingModel : *
TextLayoutFormat: указывает модель межстрочного интервала, которая представляет собой комбинацию основы межстрочного интервала и направления межстрочного интервала.
FlowElement
 InheritedligatureLevel : *
TextLayoutFormat: указывает, какая из лигатур, определенных в шрифте, может использоваться в тексте.
FlowElement
 InheritedlineBreak : *
TextLayoutFormat: определяет перенос слов в контейнере (принимает значение по умолчанию, если имеет значение undefined в процессе каскада).
FlowElement
 InheritedlineHeight : *
TextLayoutFormat: определяет межстрочные интервалы в тексте.
FlowElement
 InheritedlineThrough : *
TextLayoutFormat: если значение равно true, применяет перечеркивание, размещая линию посередине строки.
FlowElement
 InheritedlinkActiveFormat : *
TextLayoutFormat: определяет атрибуты форматирования для ссылок в нормальном состоянии.
FlowElement
 InheritedlinkHoverFormat : *
TextLayoutFormat: определяет атрибуты форматирования, используемые для ссылок в состоянии наведения, когда указатель мыши находится в пределах ссылки.
FlowElement
 InheritedlinkNormalFormat : *
TextLayoutFormat: определяет атрибуты форматирования для ссылок в нормальном состоянии.
FlowElement
 InheritedlistAutoPadding : *
TextLayoutFormat: определяет автоотступ начального края списков, если значением заполнения этой стороны списка является auto.
FlowElement
 InheritedlistMarkerFormat : *
TextLayoutFormat: определяет маркеры для списка атрибутов форматирования.
FlowElement
 InheritedlistStylePosition : *
TextLayoutFormat: допустимы значения ListStylePosition.INSIDE, ListStylePosition.OUTSIDE, FormatValue.INHERIT. По умолчанию значение равно undefined, что указывает на то, что оно не установлено. Если значение равно undefined, в процессе каскада это свойство наследует свое значение от вышестоящего элемента.
FlowElement
 InheritedlistStyleType : *
TextLayoutFormat: допустимые значения: 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. По умолчанию значение равно undefined, что указывает на то, что оно не установлено. Если значение равно undefined, в процессе каскада это свойство наследует свое значение от вышестоящего элемента.
FlowElement
 Inheritedlocale : *
TextLayoutFormat: локаль текста.
FlowElement
 InheritedmxmlChildren : Array
Добавляет массив дочерних элементов к данному объекту.
FlowGroupElement
 InheritednumChildren : int
[только для чтения] Возвращает число дочерних элементов FlowElement у этого объекта FlowGroupElement.
FlowGroupElement
 InheritedpaddingBottom : *
TextLayoutFormat: нижний отступ в пикселах.
FlowElement
 InheritedpaddingLeft : *
TextLayoutFormat: левый отступ в пикселях.
FlowElement
 InheritedpaddingRight : *
TextLayoutFormat: правый отступ в пикселях.
FlowElement
 InheritedpaddingTop : *
TextLayoutFormat: верхний отступ в пикселях.
FlowElement
 InheritedparagraphEndIndent : *
TextLayoutFormat: число, определяющее величину отступа для конца абзаца, в пикселях.
FlowElement
 InheritedparagraphSpaceAfter : *
TextLayoutFormat: число, определяющее величину интервала в пикселях, оставляемого после абзаца.
FlowElement
 InheritedparagraphSpaceBefore : *
TextLayoutFormat: число, определяющее величину интервала в пикселях, оставляемого перед абзацем.
FlowElement
 InheritedparagraphStartIndent : *
TextLayoutFormat: число, определяющее величину отступа для начала абзаца, в пикселях.
FlowElement
 Inheritedparent : FlowGroupElement
[только для чтения] Возвращает родительский элемент этого объекта FlowElement.
FlowElement
 InheritedparentRelativeEnd : int
[только для чтения] Возвращает относительный конец этого объекта FlowElement в родительском элементе.
FlowElement
 InheritedparentRelativeStart : int
[только для чтения] Возвращает относительное начало этого объекта FlowElement в родительском элементе.
FlowElement
 InheritedrenderingMode : *
TextLayoutFormat: режим визуализации, используемый для данного текста.
FlowElement
 InheritedstyleName : *
TextLayoutFormat: присваивает элементу класс-идентификатор, позволяя задавать стиль для элемента путем ссылки на его styleName.
FlowElement
 Inheritedstyles : Object
[только для чтения] Возвращает стили в FlowElement.
FlowElement
 InheritedtabStops : *
TextLayoutFormat: указывает позиции табуляции, связанные с абзацем.
FlowElement
 InheritedtextAlign : *
TextLayoutFormat: выравнивание строк в абзаце относительно контейнера.
FlowElement
 InheritedtextAlignLast : *
TextLayoutFormat: выравнивание последней (или единственной) строки в абзаце относительно контейнера в выровненном тексте.
FlowElement
 InheritedtextAlpha : *
TextLayoutFormat: альфа-значение (прозрачности) для текста.
FlowElement
 InheritedtextDecoration : *
TextLayoutFormat: оформление текста.
FlowElement
 InheritedtextIndent : *
TextLayoutFormat: число, определяющее величину отступа первой строки абзаца в пикселях.
FlowElement
 InheritedtextJustify : *
TextLayoutFormat: указывает параметры выравнивания текста.
FlowElement
 InheritedtextLength : int
[только для чтения] Возвращает общую длину текста, принадлежащего этому объекту FlowElement и его дочерним элементам.
FlowElement
 InheritedtextRotation : *
TextLayoutFormat: указывает число градусов для поворота данного текста.
FlowElement
 Inheritedtracking : Object
[только для записи] Устанавливает трекинг и является синонимом свойства trackingRight.
FlowElement
 InheritedtrackingLeft : *
TextLayoutFormat: число в пикселях (или процент от fontSize, например, 120%), определяющее размер трекинга (ручного кернинга), применяемого слева от каждого символа.
FlowElement
 InheritedtrackingRight : *
TextLayoutFormat: число в пикселях (или процент от fontSize, например, 120%), определяющее размер трекинга (ручного кернинга), применяемого справа от каждого символа.
FlowElement
 InheritedtypeName : String
У каждого FlowElement есть typeName.
FlowElement
 InheritedtypographicCase : *
TextLayoutFormat: тип регистра текста, используемый для этого текста.
FlowElement
 InheriteduserStyles : Object
Позволяет считывать и записывать стили пользователя в объект FlowElement.
FlowElement
 InheritedverticalAlign : *
TextLayoutFormat: выравнивание по вертикали (принимает значение по умолчанию, если в процессе каскада было установлено значение undefined).
FlowElement
 InheritedwhiteSpaceCollapse : *
TextLayoutFormat: сворачивает или сохраняет пустое пространство при импорте текста в TextFlow.
FlowElement
 InheritedwordSpacing : *
TextLayoutFormat: указывает оптимальный, минимальный и максимальный интервал (как множитель к ширине обычного интервала) между словами для использования при выравнивании.
FlowElement
Общедоступные методы
 МетодОпределено
  
TextFlow(config:IConfiguration = null)
Конструктор создает новый экземпляр TextFlow.
TextFlow
 Inherited
Добавляет нижестоящий объект FlowElement.
FlowGroupElement
 Inherited
Добавляет нижестоящий объект FlowElement в заданной позиции индекса.
FlowGroupElement
  
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Регистрирует объект прослушивателя события на объекте EventDispatcher для получения прослушивателем уведомления о событии.
TextFlow
 Inherited
Отменяет указанный параметром styleProp стиль в этом объекте FlowElement.
FlowElement
 Inherited
deepCopy(relativeStart:int = 0, relativeEnd:int = -1):FlowElement
Выполняет полное копирование объекта FlowElement, включая любые дочерние элементы (при этом копируется содержимое между двумя позициями символов), и возвращает эту копию как объект FlowElement.
FlowElement
  
Посылает событие в поток событий.
TextFlow
 Inherited
Сравните userStyles этого с userStyles других элементов.
FlowElement
 Inherited
findChildIndexAtPosition(relativePosition:int):int
В случае относительного расположения текста, найдите индекс первого нижестоящего FlowElement, содержащего относительную позицию.
FlowGroupElement
 Inherited
findLeaf(relativePosition:int):FlowLeafElement
В случае относительного расположения текста, найдите элемент листа, содержащий позицию.
FlowGroupElement
 Inherited
Возвращает начальное местоположение элемента в текстовом потоке в виде абсолютного индекса.
FlowElement
 Inherited
getCharAtPosition(relativePosition:int):String
Возвращает символ в указанной позиции, относительно этого объекта FlowElement.
FlowElement
 Inherited
getCharCodeAtPosition(relativePosition:int):int
Возвращает код символа в указанной позиции, относительно этого FlowElement.
FlowElement
 Inherited
Возвращает нижестоящий элемент FlowElement с заданной позицией индекса.
FlowGroupElement
 Inherited
Выполняет поиск указанного объекта FlowElement по дочерним элементам и возвращает его позицию индекса.
FlowGroupElement
  
Возвращает элемент, свойство id которого соответствует параметру idName.
TextFlow
 Inherited
Возвращает начало этого элемента относительно предшествующего элемента.
FlowElement
  
Возвращает все элементы, styleName которых имеет значение styleNameValue.
TextFlow
  
Возвращает все элементы, typeName которых имеет значение typeNameValue.
TextFlow
 Inherited
Возвращает первого потомка FlowLeafElement в этой группе.
FlowGroupElement
 Inherited
Возвращает последнего потомка FlowLeafElement в этой группе.
FlowGroupElement
 Inherited
Возвращает следующий элемент одного с FlowElement уровня в иерархии текстового потока.
FlowElement
 Inherited
Возвращает объект ParagraphElement, связанный с этим элементом.
FlowElement
 Inherited
Возвращает предыдущий элемент одного с FlowElement уровня в иерархии текстового потока.
FlowElement
 Inherited
getStyle(styleProp:String):*
Возвращает значение стиля, заданного параметром styleProp, указывающим имя стиля, и имеющего возможность включать в себя любое имя стиля пользователя.
FlowElement
 Inherited
getText(relativeStart:int = 0, relativeEnd:int = -1, paragraphSeparator:String = " "):String
[переопределить]
FlowGroupElement
 Inherited
Поднимается вверх по иерархии текстового потока для возвращения корневого объекта TextFlow для элемента.
FlowElement
  
Проверяет, имеет ли объект EventDispatcher прослушиватели, зарегистрированные для определенного типа события.
TextFlow
 Inherited
Показывает, определено ли заданное свойство для объекта.
Object
 Inherited
Вызывается для объектов MXML после создания объекта реализации и инициализации всех свойств компонентов, указанных в теге MXML.
FlowElement
  
Признает недействительной всю информацию о форматировании для TextFlow, в результате чего форматирование должно быть принудительно пересчитано.
TextFlow
 Inherited
Показывает, есть ли экземпляр класса Object в цепи прототипов объекта, заданного в качестве параметра.
Object
 Inherited
Показывает наличие заданного свойства и его перечисляемость.
Object
 Inherited
Удаляет указанный нижестоящий объект FlowElement из данной группы.
FlowGroupElement
 Inherited
Удаляет нижестоящий объект FlowElement в заданной позиции.
FlowGroupElement
  
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Удаляет прослушиватель из объекта EventDispatcher.
TextFlow
 Inherited
replaceChildren(beginChildIndex:int, endChildIndex:int, ... rest):void
Заменяет нижестоящие элементы в группе указанными новыми элементами.
FlowGroupElement
 Inherited
Задает доступность динамического свойства для операций цикла.
Object
 Inherited
setStyle(styleProp:String, newValue:*):void
Устанавливает стиль, указанный параметром styleProp, для значения, указанного параметром newValue.
FlowElement
 Inherited
shallowCopy(relativeStart:int = 0, relativeEnd:int = -1):FlowElement
Создает копию этого объекта FlowElement, при этом копируется содержимое между двумя указанными позициями символов.
FlowElement
 Inherited
Разделяет этот объект в позиции, указанной параметром childIndex.
FlowGroupElement
 Inherited
splitAtPosition(relativePosition:int):FlowElement
Разделяет этот объект FlowElement в указанной параметром relativePosition позиции, которая является относительной текстовой позицией в этом элементе.
FlowElement
 Inherited
Возвращает строковое представление этого объекта, отформатированного в соответствии со стандартами, принятыми для данной локали.
Object
 Inherited
Возвращает строковое представление заданного объекта.
Object
 Inherited
Возвращает элементарное значение заданного объекта.
Object
  
Проверяет, зарегистрирован ли прослушиватель события для указанного типа события с данным объектом EventDispatcher или любым его предшественником.
TextFlow
События
 Событие Сводка Определено
  Передается при нажатии любой ссылки.TextFlow
  Передается после каждой перекомпоновки.TextFlow
  Передается объектом TextFlow при каждом повреждении. Это событие можно использовать для обнаружения изменения TextFlow, однако непосредственный доступ к TextFlow при отправке этого события невозможен.TextFlow
   Определяет значение свойства type объекта события flowOperationBegin.TextFlow
   Задает значение свойства type для объекта события flowOperationComplete.TextFlow
   Определяет значение свойства type объекта события flowOperationEnd.TextFlow
  Передается при изменении размера InlineGraphicElement вследствие установки для ширины или высоты значения auto или процентного значения после окончания загрузки изображения.TextFlow
  Передается при нажатии кнопки мыши над любой ссылкой.TextFlow
  Передается при прохождении указателя мыши над любой ссылкой.TextFlow
  Передается, когда указатель мыши находится над какой-либо ссылкой.TextFlow
  Передается при снятии указателя мыши с любой ссылки.TextFlow
  Передается при первом наведении указателя мыши на любую ссылку.TextFlow
  Передается объектом TextFlow после прокрутки текста в контейнере контроллера.TextFlow
  Передается при каждом изменении выбора.TextFlow
  Передается объектом TextFlow каждый раз при добавлении к контейнеру новых DisplayObject или обновлении их в результате создания.TextFlow
Сведения о свойстве

configuration

свойство
configuration:IConfiguration  [только для чтения]

Язык версии: ActionScript 3.0
Версии среды выполнения: Flash Player 10, AIR 1.5

Объект Configuration для данного объекта TextFlow. Объект Configuration указывает начальный формат символов и абзаца, начальный формат контейнера и атрибуты для выделения, ссылок, фокуса и прокрутки.

Если объект Configuration не указан, Text Layout Framework использует стандартный объект Configuration, на который ссылается свойство defaultConfiguration.



Реализация
    public function get configuration():IConfiguration

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

defaultConfiguration

свойство 
public static var defaultConfiguration:Configuration

Язык версии: ActionScript 3.0
Версии среды выполнения: Flash Player 10, AIR 1.5

Стандартная конфигурация, используемая для всех новых объектов TextFlow, если не указана иная настройка.

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

flowComposer

свойство 
flowComposer:IFlowComposer[переопределить]

Язык версии: ActionScript 3.0
Версии среды выполнения: Flash Player 10, AIR 1.5

Управляет контейнерами для этого элемента.

TextLines, созданные из элемента, отображаются как дочерние элементы контейнера. flowComposer управляет контейнерами, и по мере редактирования текста он добавляет и удаляет строки из контейнеров. flowComposer также отслеживает некоторые критические атрибуты, например, ширину и высоту для выполнения компоновки, активность прокручивания и т.д.

Контейнер и flowComposer являются близко связанными элементами. При сбросе flowComposer контейнер сбрасывается к новому контейнеру flowComposer. Аналогично, если контейнер сброшен, flowComposer сбрасывается к новому flowComposer контейнера.



Реализация
    override public function get flowComposer():IFlowComposer
    override public function set flowComposer(value:IFlowComposer):void

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

formatResolver

свойство 
formatResolver:IFormatResolver

Язык версии: ActionScript 3.0
Версии среды выполнения: Flash Player 10, AIR 1.5

Функция обратного вызова для разрешения стилей элемента. Ее можно использовать, например, для обеспечения моделирования с помощью стилей CSS или именованных стилей.



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

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

generation

свойство 
generation:uint  [только для чтения]

Язык версии: ActionScript 3.0
Версии среды выполнения: Flash Player 10, AIR 1.5

Номер генерации для этого объекта TextFlow. Операции отмены и повторения используют номер генерации для проверки допустимости отмены или повторения операции. Номера генераций должны совпадать.

Каждое изменение модели увеличивает generation на единицу. Таким образом, по изменению номера генерации можно судить об изменении модели TextFlow.



Реализация
    public function get generation():uint

hostFormat

свойство 
hostFormat:flashx.textLayout.formats:ITextLayoutFormat

Язык версии: ActionScript 3.0
Версии среды выполнения: Flash Player 10, AIR 1.5

Объект TextLayoutFormat для данного объекта TextFlow. Это обеспечивает некоторую оптимизацию для повторного использования форматов хоста. Например;

        textFlowA.hostFormat = textFlowB.hostFormat
        
Значения формата необходимо задать перед назначением объекта TextLayoutFormat элементу hostFormat. Например, в следующем коде не будет задано значение 24 размера шрифта, так как размер шрифта устанавливается после назначения объекта TextLayoutFormat элементу hostFormat.
        format = new TextLayoutFormat()
        textFlow.hostFormat = format
        format.fontSize = 24;
        



Реализация
    public function get hostFormat():flashx.textLayout.formats:ITextLayoutFormat
    public function set hostFormat(value:flashx.textLayout.formats:ITextLayoutFormat):void

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

interactionManager

свойство 
interactionManager:ISelectionManager

Язык версии: ActionScript 3.0
Версии среды выполнения: Flash Player 10, AIR 1.5

InteractionManager, связанный с данным объектом TextFlow.

Управляет всеми выделениями и редактированием текста. Если TextFlow не может быть выбран, interactionManager будет иметь значение null. Чтобы сделать TextFlow доступным для редактирования, назначьте interactionManager, являющийся одновременно и ISelectionManager, и IEditManager. Чтобы сделать TextFlow доступным только для чтения и выделения, назначьте interactionManager, являющийся только ISelectionManager.



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

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

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

TextFlow

()Конструктор
public function TextFlow(config:IConfiguration = null)

Язык версии: ActionScript 3.0
Версии среды выполнения: Flash Player 10, AIR 1.5

Конструктор создает новый экземпляр TextFlow.

Если предоставляется параметр config, содержимое объекта Configuration копируется, после чего внести изменения невозможно. Однако доступ к параметрам настройки конфигурации можно получить с помощью свойства configuration. Если параметр config имеет значение null, получить доступ к параметрам настройки стандартной конфигурации можно через свойство defaultConfiguration.

Объект Configuration предоставляет механизм для установки в TextFlow стандартных настраиваемых атрибутов. Несмотря на то, что внести изменения в объект Configuration невозможно, при необходимости стандартные атрибуты можно переопределить путем установки атрибутов TextFlow и его дочерних элементов.

Параметры
config:IConfiguration (default = null) — Указывает конфигурацию, используемую для этого объекта TextFlow. При значении null используйте TextFlow.defaultConfiguration для доступа к значениям конфигурации.

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

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

addEventListener

()метод
public function addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void

Язык версии: ActionScript 3.0
Версии среды выполнения: Flash Player 10, AIR 1.5

Регистрирует объект прослушивателя события на объекте EventDispatcher для получения прослушивателем уведомления о событии. Можно регистрировать прослушиватели событий в любом узле из списка отображения для каждого типа события, фазы и приоритета.

После успешной регистрации прослушивателя событий невозможно изменить его приоритет путем дополнительных вызовов addEventListener(). Для изменения приоритета прослушивателя следует вначале вызвать removeEventListener(). Затем можно снова зарегистрировать прослушиватель с новым приоритетом.

После регистрации прослушивателя последующие вызовы addEventListener() со значениями, отличающимися от type и useCapture приводят к его отдельной регистрации. Например, прослушиватель, изначально зарегистрированный со значением useCapture, равным true, прослушивает только во время фазы захвата. После повторного вызова addEventListener() с помощью аналогичного объекта прослушивания, но со значением useCapture, равным false, активными становятся два отдельных прослушивателя: один прослушивает во время фазы захвата, второй – во время целевой фазы и фазы восходящей цепочки.

Невозможно зарегистрировать прослушиватель события только для целевой фазы или для фазы восходящей цепочки. Эти фазы соединены при регистрации, поскольку восходящая цепочка применяется только к предшественникам целевого узла.

При отсутствии необходимости в прослушивателе события он может быть удален с помощью вызова EventDispatcher.removeEventListener(); в противном случае могут возникнуть проблемы с памятью. Объекты с зарегистрированными прослушивателями события автоматически не удаляются из памяти, поскольку сборщик мусора не удаляет объекты, на которые имеются ссылки.

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

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

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

Параметры

type:String — Тип события.
 
listener:Function — Функция прослушивателя, обрабатывающая событие. Эта функция принимает объект события как единственный параметр и ничего не возвращает, например:

function(evt:Event):void

Эта функция может иметь любое имя.
 
useCapture:Boolean (default = false) — Определяет, работает ли прослушиватель в фазе захвата или в целевой фазе и в фазе восходящей цепочки. Если значение useCapture равно true, прослушиватель обрабатывает событие только во время фазы захвата, но не во время целевой фазы или фазы восходящей цепочки. Если значение useCapture равно false, то прослушиватель обрабатывает событие только в целевой фазе или фазе восходящей цепочки. Для прослушивания события во всех трех фазах следует дважды вызвать addEventListener(), первый раз с useCapture, равным true, а второй раз с useCapture, равным false.
 
priority:int (default = 0) — Уровень приоритета прослушивателя событий. Приоритеты обозначены 32-разрядным целым числом. Чем больше число, тем выше приоритет. Все прослушиватели с приоритетом n обрабатываются перед обработкой прослушивателей с приоритетом n-1. Прослушиватели с одинаковым приоритетом обрабатываются в порядке их добавления. Значение приоритета по умолчанию равно 0.
 
useWeakReference:Boolean (default = false) — Определяет, является ли ссылка на прослушиватель «сильной» или «слабой». «Сильная» ссылка (по умолчанию) предотвращает удаление прослушивателя сборщиком мусора. «Слабая» ссылка позволяет удалить прослушиватель.

Функции элементов уровня класса не подлежат удалению в качестве мусора, вследствие чего можно установить useWeakReference равным true для функций элементов уровня класса, не подвергая их возможности подобного удаления. Если значение useWeakReference равно true для прослушивателя, являющегося вложенной внутренней функцией, такая функция может быть удалена в качестве мусора и перестанет быть устойчивой. При создании ссылок на внутреннюю функцию (возможно сохранение в другой переменной) она не будет собираться в качестве мусора и останется устойчивой.

dispatchEvent

()метод 
public function dispatchEvent(event:Event):Boolean

Язык версии: ActionScript 3.0
Версии среды выполнения: Flash Player 10, AIR 1.5

Посылает событие в поток событий. Адресатом события является объект EventDispatcher, в котором вызывается dispatchEvent().

Параметры

event:Event — Объект события, переданный в поток событий.

Возвращает
Boolean — Значение равно true до тех пор, пока preventDefault() не будет вызван для события; в этом случае возвращается значение false.

getBackgroundManager

()метод 
tlf_internal function getBackgroundManager():BackgroundManager

Возвращает
BackgroundManager

getElementByID

()метод 
public function getElementByID(idName:String):FlowElement

Язык версии: ActionScript 3.0
Версии среды выполнения: Flash Player 10, AIR 1.5

Возвращает элемент, свойство id которого соответствует параметру idName. Предоставляет возможность применения стиля на основе id.

Например, следующий код задает стилю color значение 0xFF0000 (красный) для элемента, имеющего id span1.

         textFlow.getElementByID("span1").setStyle("color", 0xFF0000);
         

Примечание. В нижеприведенном коде p.addChild(s) удаляет s из исходного вышестоящего элемента и добавляет его в новый вышестоящий элемент p.

         var s:SpanElement = new SpanElement();
         var p:ParagraphElement = new ParagraphElement();
         ...
         s = textFlow.getElementByID("span3") as SpanElement;
         p.addChild(s);
         textFlow.addChild(p);
         

Параметры

idName:String — Значение id искомого элемента.

Возвращает
FlowElement — Элемент, свойство id которого соответствует idName.

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


Пример  ( Использование этого примера )

В этом примере выполняется импорт разметки xml в объект TextFlow и вызов getElementByID() для обращения к фрагменту с идентификатором span3 и установки для него красного цвета.
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

()метод 
public function getElementsByStyleName(styleNameValue:String):Array

Язык версии: ActionScript 3.0
Версии среды выполнения: Flash Player 10, AIR 1.5

Возвращает все элементы, styleName которых имеет значение styleNameValue.

Параметры

styleNameValue:String — Имя стиля, используемое для поиска элементов с данным именем.

Возвращает
Array — Массив элементов, значение styleName которого соответствует styleNameValue. Например, все элементы, имеющие имя стиля color.

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

getElementsByTypeName

()метод 
public function getElementsByTypeName(typeNameValue:String):Array

Язык версии: ActionScript 3.0
Версии среды выполнения: Flash Player 10, AIR 1.5

Возвращает все элементы, typeName которых имеет значение typeNameValue.

Параметры

typeNameValue:String — Имя стиля, используемое для поиска элементов с данным именем.

Возвращает
Array — Массив элементов, значение typeName которых соответствует typeNameValue. Например, все элементы с именем типа "foo".

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

hasEventListener

()метод 
public function hasEventListener(type:String):Boolean

Язык версии: ActionScript 3.0
Версии среды выполнения: Flash Player 10, AIR 1.5

Проверяет, имеет ли объект EventDispatcher прослушиватели, зарегистрированные для определенного типа события. Это позволяет определить, где объект EventDispatcher изменил обработку типа события в иерархии потока событий. Для определения, действительно ли определенный тип события запускает прослушиватель события, следует использовать IEventDispatcher.willTrigger().

Различие между hasEventListener() и willTrigger() заключается в том, что hasEventListener() анализирует только объект, к которому он принадлежит, тогда как willTrigger() — весь поток событий для события, указанного параметром type.

Параметры

type:String — Тип события.

Возвращает
Boolean — Значение true, если прослушиватель указанного типа зарегистрирован; в противном случае – false.

invalidateAllFormats

()метод 
public function invalidateAllFormats():void

Язык версии: ActionScript 3.0
Версии среды выполнения: Flash Player 10, AIR 1.5

Признает недействительной всю информацию о форматировании для TextFlow, в результате чего форматирование должно быть принудительно пересчитано. Этот метод вызывается, если стили были изменены.

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

removeEventListener

()метод 
public function removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void

Язык версии: ActionScript 3.0
Версии среды выполнения: Flash Player 10, AIR 1.5

Удаляет прослушиватель из объекта EventDispatcher. При отсутствии прослушивателя, зарегистрированного с объектом EventDispatcher, вызов этого метода не оказывает эффекта.

Параметры

type:String — Тип события.
 
listener:Function — Удаляемый объект прослушивателя.
 
useCapture:Boolean (default = false) — Указывает, был ли слушатель зарегистрирован для фазы захвата или целевой фазы и фазы восходящей цепочки. Если прослушиватель был зарегистрирован для фазы захвата, целевой фазы и фазы восходящей цепочки, необходимо удалить оба вызова removeEventListener(): один вызов с useCapture, равным true, и второй вызов с useCapture, равным false.

willTrigger

()метод 
public function willTrigger(type:String):Boolean

Язык версии: ActionScript 3.0
Версии среды выполнения: Flash Player 10, AIR 1.5

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

Различие между hasEventListener() и willTrigger() заключается в том, что hasEventListener() анализирует только объект, к которому он принадлежит, тогда как willTrigger() — весь поток событий для события, указанного параметром type.

Параметры

type:String — Тип события.

Возвращает
Boolean — Значение равно true при запуске прослушивателя указанного типа; в противном случае значение равно false.
Сведения о событии

click

Событие
Тип объекта события: flashx.textLayout.events.FlowElementMouseEvent

Язык версии: ActionScript 3.0
Версии среды выполнения: Flash Player 10, AIR 1.5

Передается при нажатии любой ссылки.

compositionComplete

Событие  
Тип объекта события: flashx.textLayout.events.CompositionCompleteEvent

Язык версии: ActionScript 3.0
Версии среды выполнения: Flash Player 10, AIR 1.5

Передается после каждой перекомпоновки.

damage

Событие  
Тип объекта события: flashx.textLayout.events.DamageEvent

Язык версии: ActionScript 3.0
Версии среды выполнения: Flash Player 10, AIR 1.5

Отправляется объектом TextFlow при каждом повреждении. Это событие можно использовать для обнаружения изменения TextFlow, однако непосредственный доступ к TextFlow при отправке этого события невозможен. Это событие передается после частичного выполнения изменений TextFlow, таким образом, может наблюдаться несогласованное состояние: некоторые изменения уже внесены, тогда как другие изменения еще ожидают выполнения. Событие предоставляет необходимую информацию, и после возврата управления к приложению можно внести требуемые изменения.

flowOperationBegin

Событие  
Тип объекта события: flashx.textLayout.events.FlowOperationEvent
свойство FlowOperationEvent.type = flashx.textLayout.events.FlowOperationEvent.FLOW_OPERATION_BEGIN

Язык версии: ActionScript 3.0
Версии среды выполнения: Flash Player 10, AIR 1.5

Определяет значение свойства type объекта события flowOperationBegin, передаваемого перед выполнением операции. Отмена этого события приведет к блокировке операции.

flowOperationComplete

Событие  
Тип объекта события: flashx.textLayout.events.FlowOperationEvent
свойство FlowOperationEvent.type = flashx.textLayout.events.FlowOperationEvent.FLOW_OPERATION_COMPLETE

Язык версии: ActionScript 3.0
Версии среды выполнения: Flash Player 10, AIR 1.5

Задает значение свойства type для объекта события flowOperationComplete. Отправляется после завершения всех операций, включая ожидающие выполнения и составные, после завершения компоновки и прокрутки экрана.

flowOperationEnd

Событие  
Тип объекта события: flashx.textLayout.events.FlowOperationEvent
свойство FlowOperationEvent.type = flashx.textLayout.events.FlowOperationEvent.FLOW_OPERATION_END

Язык версии: ActionScript 3.0
Версии среды выполнения: Flash Player 10, AIR 1.5

Определяет значение свойства type объекта события flowOperationEnd, передаваемого после завершения операции. Все ошибки сохраняются в элементе OperationEvent.error. При возникновении ошибки отмена этого события приведет к блокировке повторного появления ошибки. Вообще говоря, все ошибки могут стать критическими с высокой степенью вероятности.

Изменение операции в этот момент времени (после ее выполнения) может завершиться отказом.

inlineGraphicStatusChanged

Событие  
Тип объекта события: flashx.textLayout.events.StatusChangeEvent

Язык версии: ActionScript 3.0
Версии среды выполнения: Flash Player 10, AIR 1.5

Передается при изменении размера InlineGraphicElement вследствие установки для ширины или высоты значения auto или процентного значения после окончания загрузки изображения.

mouseDown

Событие  
Тип объекта события: flashx.textLayout.events.FlowElementMouseEvent

Язык версии: ActionScript 3.0
Версии среды выполнения: Flash Player 10, AIR 1.5

Передается при нажатии кнопки мыши над любой ссылкой.

mouseMove

Событие  
Тип объекта события: flashx.textLayout.events.FlowElementMouseEvent

Язык версии: ActionScript 3.0
Версии среды выполнения: Flash Player 10, AIR 1.5

Передается при прохождении указателя мыши над любой ссылкой.

mouseUp

Событие  
Тип объекта события: flashx.textLayout.events.FlowElementMouseEvent

Язык версии: ActionScript 3.0
Версии среды выполнения: Flash Player 10, AIR 1.5

Передается, когда указатель мыши находится над какой-либо ссылкой.

rollOut

Событие  
Тип объекта события: flashx.textLayout.events.FlowElementMouseEvent

Язык версии: ActionScript 3.0
Версии среды выполнения: Flash Player 10, AIR 1.5

Передается при снятии указателя мыши с любой ссылки.

rollOver

Событие  
Тип объекта события: flashx.textLayout.events.FlowElementMouseEvent

Язык версии: ActionScript 3.0
Версии среды выполнения: Flash Player 10, AIR 1.5

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

scroll

Событие  
Тип объекта события: flashx.textLayout.events.TextLayoutEvent

Язык версии: ActionScript 3.0
Версии среды выполнения: Flash Player 10, AIR 1.5

Передается объектом TextFlow после прокрутки текста в контейнере контроллера.

selectionChange

Событие  
Тип объекта события: flashx.textLayout.events.SelectionEvent

Язык версии: ActionScript 3.0
Версии среды выполнения: Flash Player 10, AIR 1.5

Передается при каждом изменении выбора. Первоначально используется для обновления пользовательского интерфейса, зависимого от выбора. С его помощью также можно изменить выделенную область, однако изменить сам объект TextFlow нельзя.

updateComplete

Событие  
Тип объекта события: flashx.textLayout.events.UpdateCompleteEvent

Язык версии: ActionScript 3.0
Версии среды выполнения: Flash Player 10, AIR 1.5

Передается объектом TextFlow каждый раз при добавлении к контейнеру новых DisplayObject или обновлении их в результате создания.

TextFlowExample.as

Этот пример создает экземпляр TextFlow с начальной конфигурацией формата и добавляет объект ParagraphElement и объект SpanElement для отображения фразы Hello World.
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(); 
        }
    }
}





[ X ]Почему по-английски?
Содержимое Справочника ActionScript 3.0 отображается на английском языке

Не все части Справочника ActionScript 3.0 переводятся на все языки. Если какой-то текстовый элемент не переведен, он отображается на английском языке. Например, компонент ga.controls.HelpBox не переведен ни на один из языков. Это значит, что в русской версии справки компонент ga.controls.HelpBox будет отображаться на английском языке.