TextFlow  - AS3

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

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

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

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

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

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

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

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

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

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

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

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

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

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

        textFlowA.hostFormat = textFlowB.hostFormat
        

        format = new TextLayoutFormat()
        textFlow.hostFormat = format
        format.fontSize = 24;
        

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Параметры

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

Параметры

Возвращает элемент, свойство 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);
         

Параметры

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

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();
        }
    }
}

            
            

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

Параметры

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

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

Параметры

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

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

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

Параметры

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

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

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

Параметры

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

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

Параметры

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

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

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

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

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

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

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

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

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

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

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

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

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