TextFormat  - AS3

Обозначает выравнивание абзаца. Допустимыми значениями являются константы TextFormatAlign.

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

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

Указывает отступ блока в пикселях. Отступ блока применяется ко всему блоку текста, то есть, ко всем его строкам текста. Обычный отступ (TextFormat.indent), напротив, применяется только к первой строке каждого абзаца. Если это свойство имеет значение null, объект TextFormat не задает отступ блока (он равен 0).

Определяет, является ли текст полужирным. Значение по умолчанию — null, т.е. полужирное начертание не используется. Если значение — true, тогда отображается полужирный текст.

Показывает, что текст является частью маркированного списка. В маркированном списке отступ применяется к каждому абзацу. Слева от первой строки каждого абзаца отображается маркер списка. Значение по умолчанию — null, т.е. маркированный список не используется.

Указывает цвет текста. Число, содержащее три 8-разрядных компонента RGB; например, 0xFF0000 — красный, 0x00FF00 — зеленый. Значение по умолчанию — null, т.е. проигрыватель Flash Player использует черный цвет (0x000000).

Имя шрифта для текста в данном текстовом формате (в виде строки). Значение по умолчанию — null, т.е. проигрыватель Flash Player использует для текста шрифт Times New Roman.

Указывает отступ от левого поля до первого символа в абзаце. Значение по умолчанию — null, т.е. отступ не используется.

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

Показывает, выделен ли текст в данном текстовом формате курсивом. Значение по умолчанию — null, т.е. курсивное начертание не используется.

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

Определенные шрифты, такие как Verdana, и моноширинные шрифты, такие как Courier New, не поддерживают кернинг.

Значение по умолчанию — null, т.е. кернинг выключен.

Целое число, представляющее величину промежутка между строками по вертикали (так называемый междустрочный интервал). Значение по умолчанию — null, т.е. величина междустрочного интервала равна 0.

Левое поле абзаца (в пикселях). Значение по умолчанию — null, т.е. левое поле равно 0 пикселей.

Число, представляющее величину пространства, равномерно распределяемого между всеми символами. Это значение задает количество пикселей, добавляемых после каждого символа. Значение по умолчанию — null, т.е. используется нулевой интервал между буквами. Можно использовать дробные значения, например 1,75.

Правое поле абзаца (в пикселях). Значение по умолчанию — null, т.е. правое поле равно 0 пикселей.

Размер текста в пикселях в данном текстовом формате. Значением по умолчанию является null, которое обозначает использование кегля 12.

Задает пользовательские позиции табуляции в виде массива неотрицательных целых чисел. Каждая точка табуляции задается в пикселях. Если не заданы пользовательские точки табуляции (null), по умолчанию используется значение 4 (средняя ширина символа).

Указывает целевое окно, где отображается гиперссылка. Если целевое окно представлено пустой строкой, текст отображается в целевом окне по умолчанию, _self. Можно выбрать пользовательское имя или один из следующих четырех вариантов: _self задает текущий фрейм в текущем окне, _blank задает новое окно, _parent задает родительский элемент текущего фрейма, и _top задает фрейм верхнего уровня в текущем окне. Если параметр TextFormat.url представлен пустой строкой или значением null, это свойство можно получить или задать, но оно не будет иметь силы.

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

Показывает, является ли текст в этом текстовом формате подчеркнутым: да (true) или нет (false). Это подчеркивание похоже на подчеркивание с помощью тега <U>, но последнее не является истинным подчеркиванием, так как не пропускает буквы с нижним выносным элементом. Значение по умолчанию — null, т.е. подчеркивание не используется.

Указывает целевой URL-адрес для текста в данном текстовом формате. Если свойство url представлено пустой строкой, текст не имеет гиперссылки. Значение по умолчанию — null, т.е. текст не имеет гиперссылки.

Примечание. Чтобы гиперссылка работала, для текста с назначенным форматом должно быть задано свойство htmlText.

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

Создает объект TextFormat с заданными свойствами. Затем можно изменить свойства объекта TextFormat, чтобы изменить форматирование текстовых полей.

Любому параметру можно задать значение null, чтобы указать, что он не определен. Все параметры являются необязательными, опущенные параметры имеют значение null.

package {
    import flash.display.Sprite;
    import flash.text.TextField;
    import flash.text.TextFormat;
    import flash.text.TextFieldAutoSize;
    import flash.events.MouseEvent;
    import flash.text.TextFormatAlign;
    
    public class TextFormat_constructorExample extends Sprite {
        private var contentTextField:TextField = new TextField();
        private var formatTextField:TextField = new TextField();
        private var newFormat:TextFormat = new TextFormat();
        
        public function TextFormat_constructorExample() {
            contentTextField.x = 10;
            contentTextField.y = 10;
            contentTextField.background = true;
            contentTextField.border = true;
            contentTextField.multiline = true;
            contentTextField.wordWrap = true;
            contentTextField.selectable = false;
            contentTextField.width = 250;
            contentTextField.height = 120; 
  
            contentTextField.htmlText = "<p>The TextFormat class represents character formatting "
                + "information. Use the TextFormat class to create specific text formatting "
                + "for text fields." + 
                " </p><br>" + "\tTab One" + "\tTab Two<br>";
              
            formatTextField.x = 10;
            formatTextField.y = 140;
            formatTextField.background = true;
            formatTextField.border = true;
            formatTextField.autoSize = TextFieldAutoSize.LEFT;
            
            formatTextField.text = "align: right\n" + "blockIndent: 10 pixels\n" + "bold:\n" + "bullet:\n" + "color: red\n"
                                + "font: Arial\n" + "indent: 20 pixels\n" + "italic:\n" + "leading: 5 spaces\n" 
                                + "leftMargin: 20 pixels\n" + "letterSpacing: 4 pixels\n" + "rightMargin: 20 pixels\n" 
                                + "size: 16 point\n" + "target: new window\n" + "tabStops: 50 and 150 pixel\n" 
                                + "underline:\n" + "url: Adobe Flex page\n";

            formatTextField.addEventListener(MouseEvent.CLICK, formatTextFieldClickHandler);
            
            contentTextField.addEventListener(MouseEvent.CLICK, contentTextFieldClickHandler);
            
            this.addChild(contentTextField);
            this.addChild(formatTextField);
        }

        private function formatTextFieldClickHandler(e:MouseEvent):void {
                var value:String= "";
                var i:uint = 0;
                var index:int = formatTextField.getLineIndexAtPoint(e.localX, e.localY);
                var line:String = formatTextField.getLineText(index);;

                line = line.substr(0, (line.indexOf(":")));

                switch(line) {
                    case "align":
                        newFormat.align = TextFormatAlign.RIGHT;
                        break;
                    case "blockIndent":
                        newFormat.blockIndent = 10;
                        break;
                    case "bold":
                        newFormat.bold = true;
                        break;
                    case "bullet":
                        newFormat.bullet = true;
                        break;
                    case "color":
                        newFormat.color = 0xFF0000;        
                        break;
                    case "font":
                        newFormat.font = "Arial";
                        break;
                    case "indent":
                        newFormat.indent = 20;
                        break;
                    case "italic":
                        newFormat.italic = true;
                        break;
                    case "leading":
                        newFormat.leading = 5;
                        break;
                    case "leftMargin":
                        newFormat.leftMargin = 20;
                        break;
                    case "letterSpacing":
                        newFormat.letterSpacing = 4;
                        break;
                    case "rightMargin":
                        newFormat.rightMargin = 20;
                        break;
                    case "size":
                        newFormat.size = 16;
                        break;
                    case "tabStops":                
                        newFormat.tabStops = [50, 150];
                        break;
                    case "target":
                        newFormat.url = "http://www.adobe.com/products/flex/";    
                        newFormat.target = "_blank";
                        break;    
                    case "underline":
                        newFormat.underline = true;
                        break;
                    case "url":
                        newFormat.url = "http://www.adobe.com/products/flex/";    
                        break;
                }    

                contentTextField.setTextFormat(newFormat);
        }

        private function contentTextFieldClickHandler(e:MouseEvent):void {
            contentTextField.setTextFormat(contentTextField.defaultTextFormat);
            newFormat = contentTextField.defaultTextFormat;
        }
    }
}

1. Создается свойство label типа TextField.
2. Конструктор класса вызывает функцию configureLabel().
3. Метод configureLabel() сначала создает новый объект TextField и назначает его свойству label, а затем задает для него следующие параметры
   • Полная выключка текстового поля по левому краю
   • Включить заливку фона
   • Включить рамку
4. Затем метод configureLabel() создает локальную переменную, format, назначает ее новому экземпляру TextFormat и задает для нее следующие параметры:
   • Font type = Verdana
   • Font Color = solid red
   • Font size = 10
   • Font underline = true.
5. Свойству defaultTextFormat свойства label задается значение format, и экземпляр label добавляется в список отображения, который сначала показывает на монтажном столе текстовое поле без текста (крошечное поле с белым фоном).
6. В завершение, метод конструктора setLabel() передает для отображения текст объекта label — Hello World and welcome to the show (Здравствуйте все, и добро пожаловать на представление) — в точке с координатами x = 0, y = 0.

 package {
    import flash.display.Sprite;
    import flash.text.TextField;
    import flash.text.TextFieldAutoSize;
    import flash.text.TextFormat;


    public class TextFormatExample extends Sprite {
        private var label:TextField;

        public function TextFormatExample() {
            configureLabel();
            setLabel("Hello World and welcome to the show");
        }

        public function setLabel(str:String):void {
            label.text = str;
        }

        private function configureLabel():void {
            label = new TextField();
            label.autoSize = TextFieldAutoSize.LEFT;
            label.background = true;
            label.border = true;

            var format:TextFormat = new TextFormat();
            format.font = "Verdana";
            format.color = 0xFF0000;
            format.size = 10;
            format.underline = true;

            label.defaultTextFormat = format;
            addChild(label);
        }
    }
}