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

Configuration  - AS3

Пакетflashx.textLayout.elements
Классpublic class Configuration
НаследованиеConfiguration Inheritance Object
Реализует IConfiguration

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

Класс Configuration — основной пункт интеграции между Text Layout Framework и приложением. При создании нового экземпляра TextFlow объект Configuration можно включить в качестве параметра в конструктор TextFlow(). Это позволяет приложению с самого начала управлять поведением Text Layout Framework.

Класс Configuration позволяет настраивать начальный формат, а также форматы абзаца и контейнера для текстового потока посредством свойства textFlowInitialFormat. Он также позволяет настраивать атрибуты начального формата для ссылок, выделения, прокрутки и обработки клавиш Tab и Enter.

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

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



Общедоступные свойства
 СвойствоОпределено
 Inheritedconstructor : Object
Ссылка на объект класса или функцию конструктора для данного экземпляра объекта.
Object
  defaultLinkActiveFormat : flashx.textLayout.formats:ITextLayoutFormat
Указывает активные атрибуты формата символов, которые первоначально применяются ко всем ссылкам (объектам LinkElement) в текстовом потоке.
Configuration
  defaultLinkHoverFormat : flashx.textLayout.formats:ITextLayoutFormat
Указывает первоначальные атрибуты формата символов, которые применяются к ссылке (LinkElement) в текстовом потоке при наведении на нее курсора.
Configuration
  defaultLinkNormalFormat : flashx.textLayout.formats:ITextLayoutFormat
Указывает первоначальные атрибуты ссылки для всех объектов LinkElement в текстовом потоке.
Configuration
  defaultListMarkerFormat : IListMarkerFormat
Указывает активные атрибуты формата символов, которые первоначально применяются ко всем объектам ListItem в текстовом потоке.
Configuration
  enableAccessibility : Boolean
Указывает, включена поддержка специальных возможностей или нет.
Configuration
  flowComposerClass : Class
Указывает тип компоновщика потока, присоединяемого к новому объекту TextFlow по умолчанию.
Configuration
  focusedSelectionFormat : SelectionFormat
Начальный формат выделения (SelectionFormat) текстового потока (TextFlow), окно которого находится в фокусе.
Configuration
  inactiveSelectionFormat : SelectionFormat
Начальный формат выделения (SelectionFormat) текстового потока (TextFlow), окно которого неактивно.
Configuration
  inlineGraphicResolverFunction : Function
Указывает обратный вызов, используемый для разрешения встроенного графического элемента.
Configuration
  manageEnterKey : Boolean
Указывает, введена ли клавиша Enter/Return как текст классом Text Layout Framework, например для разделения абзаца, либо это событие обрабатывается кодом клиента.
Configuration
  manageTabKey : Boolean
Указывает, введена ли клавиша Tab как текст классом Text Layout Framework, либо Flash Player или AIR обрабатывают это событие и преобразуют его в событие панели с вкладками.
Configuration
  overflowPolicy : String
Политика, используемая для того, чтобы определить, попадает последняя строка контейнера в контейнер или выходит за его пределы.
Configuration
  releaseLineCreationData : Boolean
Передает запрос на выпуск процессом создания текста данных о создании строки после создания каждого абзаца.
Configuration
  scrollDragDelay : Number
Указывает определенную задержку между каждой прокруткой для предотвращения чрезмерно быстрого прокручивания.
Configuration
  scrollDragPixels : Number
Указывает количество прокручиваемых по умолчанию пикселей при инициировании пользователем автоматической прокрутки путем перетаскивания выделенного фрагмента.
Configuration
  scrollMouseWheelMultiplier : Number
Указывает количество прокручиваемых по умолчанию пикселей для событий колесика мыши.
Configuration
  scrollPagePercentage : Number
Указывает процент прокручиваемого по умолчанию текстового потока при прокрутке страниц.
Configuration
  textFlowInitialFormat : flashx.textLayout.formats:ITextLayoutFormat
Указывает начальный формат конфигурации TextLayoutFormat для текстового потока (объект TextFlow).
Configuration
  unfocusedSelectionFormat : SelectionFormat
Начальный формат выделения, используемый Text Layout Framework для отображения выделения в случае, если окно активно, но ни один из контейнеров в TextFlow не находится в фокусе.
Configuration
Общедоступные методы
 МетодОпределено
  
Configuration(initializeWithDefaults:Boolean = true)
Конструктор создает стандартную конфигурацию.
Configuration
  
Создает клон объекта Configuration.
Configuration
 Inherited
Показывает, определено ли заданное свойство для объекта.
Object
 Inherited
Показывает, есть ли экземпляр класса Object в цепи прототипов объекта, заданного в качестве параметра.
Object
 Inherited
Показывает наличие заданного свойства и его перечисляемость.
Object
 Inherited
Задает доступность динамического свойства для операций цикла.
Object
 Inherited
Возвращает строковое представление этого объекта, отформатированного в соответствии со стандартами, принятыми для данной локали.
Object
 Inherited
Возвращает строковое представление заданного объекта.
Object
 Inherited
Возвращает элементарное значение заданного объекта.
Object
Сведения о свойстве

defaultLinkActiveFormat

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

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

Указывает активные атрибуты формата символов, которые первоначально применяются ко всем ссылкам (объектам LinkElement) в текстовом потоке. Они задаются по умолчанию для новых объектов LinkElement, не указывающих значения для этих атрибутов.

Значением по умолчанию является null.



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

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

defaultLinkHoverFormat

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

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

Указывает первоначальные атрибуты формата символов, которые применяются к ссылке (LinkElement) в текстовом потоке при наведении на нее курсора. Они задаются по умолчанию для новых объектов LinkElement, не указывающих значения для этих атрибутов.

Значением по умолчанию является null.



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

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

defaultLinkNormalFormat

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

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

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



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

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

defaultListMarkerFormat

свойство 
defaultListMarkerFormat:IListMarkerFormat

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

Указывает активные атрибуты формата символов, которые первоначально применяются ко всем объектам ListItem в текстовом потоке. Они задаются по умолчанию для новых объектов ListItemElement, не указывающих значения для этих атрибутов.

Значением по умолчанию является null.



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

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

enableAccessibility

свойство 
enableAccessibility:Boolean

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

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

Значением по умолчанию является false.



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

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

flowComposerClass

свойство 
flowComposerClass:Class

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

Указывает тип компоновщика потока, присоединяемого к новому объекту TextFlow по умолчанию. Значением по умолчанию является StandardFlowComposer.



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

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

focusedSelectionFormat

свойство 
focusedSelectionFormat:SelectionFormat

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

Начальный формат выделения (SelectionFormat) текстового потока (TextFlow), окно которого находится в фокусе. Text Layout Framework выполняет отображение выделения с использованием focusedSelectionFormat, если окно активно и один из контейнеров в TextFlow находится в фокусе. При необходимости этот формат можно переопределить с помощью SelectionManager.focusedSelectionFormat.

Класс SelectionFormat указывает значения по умолчанию, инвертирующие цвет текста и его фона.



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

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

inactiveSelectionFormat

свойство 
inactiveSelectionFormat:SelectionFormat

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

Начальный формат выделения (SelectionFormat) текстового потока (TextFlow), окно которого неактивно. Если окно неактивно, Text Layout Framework выполняет отображение выделения с использованием inactiveSelectionFormat. При необходимости этот формат можно переопределить с помощью SelectionManager.inactiveSelectionFormat.

Если свойство unfocusedSelectionFormat не переопределяется, используются следующие значения SelectionFormat:

  • color = 0xffffff (белый)
  • alpha = 0
  • blendMode = flash.display.BlendMode.DIFFERENCE

В результате выделение не отображается.



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

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

inlineGraphicResolverFunction

свойство 
inlineGraphicResolverFunction:Function

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

Указывает обратный вызов, используемый для анализа встроенного графического элемента. Обратный вызов принимает объект flashx.textLayout.elements.InlineGraphicElement и возвращает значение для использования в качестве элемента flashx.textLayout.elements.InlineGraphicElement#source. Этот обратный вызов предоставляет механизм для задержки предоставления встроенного графического элемента до тех пор, пока он не будет составлен.

Примечание. Данный обратный вызов осуществляется только в том случае, если источник заполнителя типа String уже установлен. Более того, он может вызываться неоднократно.



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

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

manageEnterKey

свойство 
manageEnterKey:Boolean

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

Указывает, введена ли клавиша Enter/Return как текст классом Text Layout Framework, например для разделения абзаца, либо это событие обрабатывается кодом клиента. Код клиента может обработать это событие, например путем передачи формы, имеющей для этой цели кнопку по умолчанию.

Значением по умолчанию является true.



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

manageTabKey

свойство 
manageTabKey:Boolean

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

Указывает, введена ли клавиша Tab как текст классом Text Layout Framework, либо Flash Player или AIR обрабатывают это событие и преобразуют его в событие панели с вкладками.

Значением по умолчанию является false.



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

overflowPolicy

свойство 
overflowPolicy:String

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

Политика, используемая для того, чтобы определить, попадает последняя строка контейнера в контейнер или выходит за его пределы. Для определения этого свойства используются константы класса OverflowPolicy.

Значением по умолчанию является OverflowPolicy.FIT_DESCENDERS, что обеспечивает расположение строки в области компоновки, если область от верхнего края до базовой линии для этого подходит.



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

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

releaseLineCreationData

свойство 
releaseLineCreationData:Boolean

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

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

Значением по умолчанию является false.



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

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

scrollDragDelay

свойство 
scrollDragDelay:Number

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

Указывает определенную задержку между каждой прокруткой для предотвращения чрезмерно быстрого прокручивания. Это значение указывает время задержки (в миллисекундах). По умолчанию используется значение 35.



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

scrollDragPixels

свойство 
scrollDragPixels:Number

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

Указывает количество прокручиваемых по умолчанию пикселей при инициировании пользователем автоматической прокрутки путем перетаскивания выделенного фрагмента. По умолчанию используется значение 20.



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

scrollMouseWheelMultiplier

свойство 
scrollMouseWheelMultiplier:Number

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

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



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

scrollPagePercentage

свойство 
scrollPagePercentage:Number

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

Указывает процент прокручиваемого по умолчанию текстового потока при прокрутке страниц. Значением по умолчанию является 7,0 / 8,0 или 0,875.



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

textFlowInitialFormat

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

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

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

Значением по умолчанию является null.



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

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

unfocusedSelectionFormat

свойство 
unfocusedSelectionFormat:SelectionFormat

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

Начальный формат выделения, используемый Text Layout Framework для отображения выделения в случае, если окно активно, но ни один из контейнеров в TextFlow не находится в фокусе. При необходимости этот формат можно переопределить с помощью SelectionManager.unfocusedSelectionFormat.

Если свойство unfocusedSelectionFormat не переопределяется, используются следующие значения SelectionFormat:

  • color = 0xffffff (белый)
  • alpha = 0
  • blendMode = flash.display.BlendMode.DIFFERENCE

В результате выделение не отображается.



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

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

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

Configuration

()Конструктор
public function Configuration(initializeWithDefaults:Boolean = true)

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

Конструктор создает стандартную конфигурацию.

Параметры
initializeWithDefaults:Boolean (default = true) — Указывает, следует ли выполнять инициализацию конфигурации со значениями по умолчанию. Значение по умолчанию — true. Если задано значение false, инициализация выполняется без значений по умолчанию, что позволяет сохранить некоторые объекты. Метод clone() задает для него значение false и копирует свойства из исходного объекта.

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

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

clone

()метод
public function clone():Configuration

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

Создает клон объекта Configuration.

Возвращает
Configuration
Сведения о константе

hasTouchScreen

Константа
tlf_internal static const hasTouchScreen:Boolean

ConfigurationExample.as

В этом примере выполняется создание начальной настройки формата, которая применяется к TextFlow, состоящему из абзаца и ссылки.
package flashx.textLayout.elements.examples {
    import flash.display.Sprite;
    import flash.text.engine.FontPosture;
    import flash.text.engine.Kerning;
    
    import flashx.textLayout.container.ContainerController;
    import flashx.textLayout.edit.SelectionFormat;
    import flashx.textLayout.edit.SelectionManager;
    import flashx.textLayout.elements.Configuration;
    import flashx.textLayout.elements.LinkElement;
    import flashx.textLayout.elements.ParagraphElement;
    import flashx.textLayout.elements.SpanElement;
    import flashx.textLayout.elements.TextFlow;
    import flashx.textLayout.formats.TextAlign;
    import flashx.textLayout.formats.TextDecoration;
    import flashx.textLayout.formats.TextLayoutFormat;

    public class ConfigurationExample extends Sprite
    {
        public function ConfigurationExample()
        {    
            //create container for the text and add to stage
            var textContainer:Sprite = new Sprite();
            textContainer.x = 50;
            textContainer.y = 20;
            this.stage.addChild( textContainer );
            
            // create Configuration, set properties for it and add to TextFlow
            var config:Configuration = new Configuration();
            var textLayoutFormat:TextLayoutFormat = new TextLayoutFormat();
            textLayoutFormat.fontFamily = "Arial, Helvetica, _sans";
            textLayoutFormat.fontSize = 16;
            textLayoutFormat.kerning = Kerning.ON;
            textLayoutFormat.fontStyle = FontPosture.ITALIC;
            textLayoutFormat.textAlign = TextAlign.CENTER;
            config.textFlowInitialFormat = textLayoutFormat;
            var linkNormalFormat:TextLayoutFormat = new TextLayoutFormat();
            // make links red and underlined
            linkNormalFormat.color = 0xFF0000;
            linkNormalFormat.textDecoration = TextDecoration.UNDERLINE;
            config.defaultLinkNormalFormat = linkNormalFormat;
            // set selection color to light blue
              var selectionFormat:SelectionFormat = new SelectionFormat(0x333300);
              config.focusedSelectionFormat = selectionFormat;
            var textFlow:TextFlow = new TextFlow(config);
            // make text selectable
            var selectionManager:SelectionManager = new SelectionManager();
            textFlow.interactionManager = selectionManager;
            
            // create paragraph, a span of text, and a link
            var p:ParagraphElement = new ParagraphElement();
            var span:SpanElement = new SpanElement();
            var linkSpan:SpanElement = new SpanElement();
            var link:LinkElement = new LinkElement();
            link.href = "http://www.adobe.com";
            linkSpan.text = "Adobe's website";
            link.addChild(linkSpan);
            span.text = "The best place to go for information about Adobe products is: ";
            
            // Add span and link to paragraph; add paragraph to TextFlow
            p.addChild(span);
            p.addChild(link);
            textFlow.addChild(p);
            
            // Add a controller for the container; specify container width and height
            textFlow.flowComposer.addController(new ContainerController(textContainer, 80, 300));
            textFlow.flowComposer.updateAllControllers(); 
        }
    }
}




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

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