Главная / Action Script 3
Пакетflash.text
Классpublic class TextSnapshot
НаследованиеTextSnapshot Inheritance Object

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Объекты TextSnapshot позволяют работать со статическим текстом во фрагменте ролика. Их можно использовать, например, для более точной раскладки текста, чем позволяет динамический текст, не отменяя доступа к нему "только для чтения".

Не создавайте объект TextSnapshot с помощью конструктора. Он возвращается свойством flash.display.DisplayObjectContainer.textSnapshot.

См. также

flash.display.DisplayObjectContainer.textSnapshot


Общедоступные свойства
 СвойствоОпределено
  charCount : int
[только для чтения] Число знаков в объекте TextSnapshot.
TextSnapshot
 Inheritedconstructor : Object
Ссылка на объект класса или функцию конструктора для данного экземпляра объекта.
Object
 Inheritedprototype : Object
[статические] Ссылка на модель объекта класса или функции.
Object
Общедоступные методы
 МетодОпределено
  
findText(beginIndex:int, textToFind:String, caseSensitive:Boolean):int
Выполняет поиск по объекту TextSnapshot и возвращает положение первого вхождения textToFind, обнаруженного в положении beginIndex или после него.
TextSnapshot
  
getSelected(beginIndex:int, endIndex:int):Boolean
Возвращает логическое значение, показывающее, содержит ли объект TextSnapshot выделенный текст в заданном диапазоне.
TextSnapshot
  
getSelectedText(includeLineEndings:Boolean = false):String
Возвращает строку, содержащую все символы, заданные соответствующим методом setSelected().
TextSnapshot
  
getText(beginIndex:int, endIndex:int, includeLineEndings:Boolean = false):String
Возвращает строку, содержащую все символы, заданные параметрами beginIndex и endIndex.
TextSnapshot
  
getTextRunInfo(beginIndex:int, endIndex:int):Array
Возвращает массив объектов, содержащий сведения о непрерывной последовательности текста.
TextSnapshot
 Inherited
Показывает, определено ли заданное свойство для объекта.
Object
  
Позволяет определить, какой символ в пределах объекта TextSnapshot находится в точке с заданными координатами x, y или рядом с ней во фрагменте ролика, содержащем текст в объекте TextSnapshot.
TextSnapshot
 Inherited
Показывает, есть ли экземпляр класса Object в цепи прототипов объекта, заданного в качестве параметра.
Object
 Inherited
Показывает наличие заданного свойства и его перечисляемость.
Object
 Inherited
Задает доступность динамического свойства для операций цикла.
Object
  
setSelectColor(hexColor:uint = 0xFFFF00):void
Задает цвет для выделения символов, выбранных с помощью метода setSelected().
TextSnapshot
  
setSelected(beginIndex:int, endIndex:int, select:Boolean):void
Задает диапазон символов в объекте TextSnapshot для выбора или отмены выбора.
TextSnapshot
 Inherited
Возвращает строковое представление заданного объекта.
Object
 Inherited
Возвращает элементарное значение заданного объекта.
Object
Сведения о свойстве
charCountсвойство
charCount:int  [только для чтения]

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Число знаков в объекте TextSnapshot.



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

См. также

Сведения о методе
findText()метод
public function findText(beginIndex:int, textToFind:String, caseSensitive:Boolean):int

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Выполняет поиск по объекту TextSnapshot и возвращает положение первого вхождения textToFind, обнаруженного в положении beginIndex или после него. Если значение textToFind не найдено, метод возвращает -1.

Параметры

beginIndex:int — Задает начальную точку для поиска заданного текста.
 
textToFind:String — Задает искомый текст. Если вместо переменной типа String задается литерал строки, то строку необходимо заключить в кавычки.
 
caseSensitive:Boolean — Указывает, должен ли при поиске учитываться регистр текста строки в textToFind.

Возвращает
int — Отсчитываемая от нуля позиция индекса первого вхождения заданного текста или -1.

См. также

getSelected()метод 
public function getSelected(beginIndex:int, endIndex:int):Boolean

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

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

Чтобы выполнить поиск по всем символам, передайте значение 0 для start и charCount (или любое очень большое число) для end. Чтобы выполнить поиск по одному символу, передайте параметру end значение, которое на одну единицу больше параметра start.

Параметры

beginIndex:int — Указывает позицию первого рассматриваемого символа. Допустимые значения beginIndex находятся в диапазоне от 0 до TextSnapshot.charCount — 1. Если в качестве beginIndex выбрано отрицательное значение, используется 0 .
 
endIndex:int — Значение, которое на одну единицу больше индекса последнего рассматриваемого символа. Действительные значения параметра endIndex находятся в диапазоне от 0 до charCount. Символ, индексированный параметром endIndex, не включен в извлеченную строку. Если этот параметр опущен, используется параметр charCount. Если это значение меньше или равно значению beginIndex, используется beginIndex + 1.

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

См. также

getSelectedText()метод 
public function getSelectedText(includeLineEndings:Boolean = false):String

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9.

Возвращает строку, содержащую все символы, заданные соответствующим методом setSelected(). Если символы не заданы (методом setSelected()), возвращается пустая строка.

Если параметр includeLineEndings имеет значение true, символы новой строки вставляются в возвращаемую строку, которая может оказаться длиннее, чем введенный диапазон. Если параметр includeLineEndings имеет значение false или опущен, метод возвращает выделенный текст, не добавляя никаких символов.

Параметры

includeLineEndings:Boolean (default = false) — Необязательное логическое значение, указывающее, вставляются ли символы новой строки в возвращенную строку, где это уместно. Значение по умолчанию равно false.

Возвращает
String — Строка, содержащая все символы, заданные соответствующим методом setSelected().

См. также

getText()метод 
public function getText(beginIndex:int, endIndex:int, includeLineEndings:Boolean = false):String

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9.

Возвращает строку, содержащую все символы, заданные параметрами beginIndex и endIndex. Если нет выделенных символов, возвращается пустая строка.

Чтобы метод вернул все символы, передайте значение 0 для beginIndex и charCount (или любое очень большое число) для endIndex. Чтобы метод вернул один символ, передайте значение beginIndex + 1 для параметра endIndex.

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

Параметры

beginIndex:int — Указывает позицию первого символа, который должен быть включен в возвращаемую строку. Допустимые значения beginIndex находятся в диапазоне от 0 до charCount — 1. Если в качестве beginIndex выбрано отрицательное значение, используется 0 .
 
endIndex:int — Значение, которое на одну единицу больше индекса последнего рассматриваемого символа. Действительные значения параметра endIndex находятся в диапазоне от 0 до charCount. Символ, индексированный параметром endIndex, не включен в извлеченную строку. Если этот параметр опущен, используется параметр charCount. Если это значение меньше или равно значению beginIndex, используется beginIndex + 1.
 
includeLineEndings:Boolean (default = false) — Необязательное логическое значение, которое указывает, вставляются символы новой строки (true) или нет (false) в возвращаемую строку. Значение по умолчанию равно false.

Возвращает
String — Строка, содержащая символы заданного диапазона, или пустая строка, если в этом диапазоне нет символов.

См. также

getTextRunInfo()метод 
public function getTextRunInfo(beginIndex:int, endIndex:int):Array

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9

Возвращает массив объектов, содержащий сведения о непрерывной последовательности текста. Каждый объект соответствует одному символу из диапазона, заданного двумя параметрами метода.

Примечание. При использовании метода getTextRunInfo() для большого диапазона текста может быть возвращен большой объект. Adobe рекомендует ограничивать диапазон текста параметрами beginIndex и endIndex.

Параметры

beginIndex:int — Значение индекса первого символа в диапазоне в объекте TextSnapshot.
 
endIndex:int — Значение индекса последнего символа в диапазоне в объекте TextSnapshot.

Возвращает
Array — Массив объектов, каждый из которых содержит сведения о конкретном символе в диапазоне, заданном параметрами beginIndex и endIndex. Каждый объект содержит следующие одиннадцать свойств.
  • Свойство indexInRun — отсчитываемый от нуля индекс символа, представленный целым числом (определяется относительно всей строки, а не выделенного фрагмента текста).
  • Свойство selected — логическое значение, указывающее на то, что символ выделен true или не выделен false.
  • Свойство font — имя шрифта символа.
  • Свойство color — комбинированное значение прозрачности и цвета для символа. Первые две шестнадцатеричные цифры представляют значение альфа-канала, а остальные — цвет.
  • Свойство height — высота символа (в пикселах).
  • Свойства matrix_a, matrix_b, matrix_c, matrix_d, matrix_tx и matrix_ty — значения матрицы, определяющие геометрическое преобразование символа. Обычный вертикальный текст всегда имеет матрицу вида [1 0 0 1 x y], где x и y — это позиция символа в родительском фрагменте ролика независимо от высоте текста. Матрица находится в системе координат родительского фрагмента ролика и не включает преобразований, которые может иметь сам фрагмент ролика (или его предок).
  • Свойства corner0x, corner0y, corner1x, corner1y, corner2x, corner2y, corner3x и corner3y — углы ограничительного блока символа на основе системы координат родительского фрагмента ролика. Эти значения доступны, только если используемый символом шрифт встроен в SWF-файл.

См. также

hitTestTextNearPos()метод 
public function hitTestTextNearPos(x:Number, y:Number, maxDistance:Number = 0):Number

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9.

Позволяет определить, какой символ в пределах объекта TextSnapshot находится в точке с заданными координатами x, y или рядом с ней во фрагменте ролика, содержащем текст в объекте TextSnapshot.

Если опустить свойство maxDistance или передать ему значение 0, место, заданное координатами x, y, может находится внутри ограничительного блока объекта TextSnapshot.

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

Параметры

x:Number — Число, представляющее координату x фрагмента ролика, содержащего текст.
 
y:Number — Число, представляющее координату y фрагмента ролика, содержащего текст.
 
maxDistance:Number (default = 0) — (Необязательно) число, представляющее максимальное расстояние от точки с координатами x, yна котором может выполняться поиск текста. Расстояние отмеряется от центральной точки каждого символа. Значение по умолчанию — 0.

Возвращает
Number — Число, представляющее значение индекса символа, который находится ближе остальных к заданной точке с координатами x, y. Возвращает -1, если такой символ не найден, либо если шрифт не содержит информации о метриках символа.

См. также

setSelectColor()метод 
public function setSelectColor(hexColor:uint = 0xFFFF00):void

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9.

Задает цвет для выделения символов, выбранных с помощью метода setSelected(). Цвет всегда непрозрачный. Значение прозрачности задать нельзя.

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

Параметры

hexColor:uint (default = 0xFFFF00) — Шестнадцатеричное значение цвета, используемый для рамки вокруг символов, выбранных соответствующей командой setSelected() (0xRRGGBB).

См. также

setSelected()метод 
public function setSelected(beginIndex:int, endIndex:int, select:Boolean):void

Язык версии : ActionScript 3.0
Версии среды выполнения:  1.0 9.

Задает диапазон символов в объекте TextSnapshot для выбора или отмены выбора. Выделенные символы помечаются цветным фоном по размеру их ограничительного блока. Цвет ограничительного блока определяется методом setSelectColor().

Чтобы метод выделил все символы или отменил выделение всех символов, передайте значение 0 для beginIndex и charCount (или любое очень большое число) для endIndex. Чтобы задать один символ, передайте значение beginIndex + 1 для параметра endIndex.

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

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

Параметры

beginIndex:int — Указывает позицию первого символа для выделения. Допустимые значения beginIndex находятся в диапазоне от 0 до charCount - 1. Если в качестве beginIndex выбрано отрицательное значение, используется 0 .
 
endIndex:int — Целое число, которое на одну единицу больше индекса последнего рассматриваемого символа. Действительные значения параметра end находятся в диапазоне от 0 до charCount. Символ, индексированный параметром end, не включен в извлеченную строку. Если этот параметр опущен, используется TextSnapshot.charCount. Если значение endIndex меньше или равно значению beginIndex, используется beginIndex + 1.
 
select:Boolean — Логическое значение, указывающее, должен текст выделяться (true) или нет (false).

См. также