Packageru.antkarlov.anthill
Classpublic class AntLabel
InheritanceAntLabel Inheritance AntEntity Inheritance AntBasic Inheritance Object

Language Version : ActionScript 3
Since : 23.08.2012
Runtime Versions : AIR 1.0, Flash Player 9.0.0

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



Public Properties
 PropertyDefined By
 Inheritedacceleration : AntPoint
Ускорение сущности.
AntEntity
 Inheritedactive : Boolean
Определяет активность объекта.
AntBasic
  align : String
Определяет выравнивание текста.
AntLabel
 Inheritedalive : Boolean
Определяет "живой" объект или нет.
AntBasic
 InheritedallowDebugDraw : Boolean
Определяет следует ли для объекта выполнять отладочную отрисовку.
AntBasic
  alpha : Number
Определяет текущую прозрачность кэшированного битмапа текстовой метки.
AntLabel
 Inheritedangle : Number
Локальный угол поворота сущности.
AntEntity
 InheritedangularAcceleration : Number
Ускорение вращения сущности.
AntEntity
 InheritedangularDrag : Number
Замедление вращения сущности.
AntEntity
 InheritedangularVelocity : Number
Скорость вращения сущности.
AntEntity
 InheritedautoReviveChildren : Boolean
Флаг определяющий будут воскрешены вложенные сущности при вызове метода revive()
AntEntity
  autoSize : Boolean
Определяет изменяется ли текстовое поле автоматически исходя из количества текста.
AntLabel
  blend : String
Режим смешивания цветов.
AntLabel
  bold : Boolean
Определяет толщину начертания текста.
AntLabel
 Inheritedbounds : AntRect
Прямоугольник определяющий занимаемую область.
AntEntity
 Inheritedcameras : Array
Указатель на массив камер AntG.cameras.
AntBasic
 Inheritedchildren : Array
Массив дочерних сущностей.
AntEntity
  color : uint
Определяет текущий цвет кэшированного битмапа текстовой метки.
AntLabel
 Inherited_depth : int
Содержит номер объекта если он вложен в другую сущность.
AntEntity
 Inheriteddepth : int
[read-only] Возвращает глубину обработки и рендера для сущности.
AntEntity
 InheritedDEPTH_ID : int = 0
[static] Используется для автоматического рассчета номеров в очереди обработки объектов.
AntEntity
 Inheriteddrag : AntPoint
Замедление сущности.
AntEntity
 Inheritedexists : Boolean
Определеяет существование объекта.
AntBasic
 InheritedglobalAngle : Number
Глобальный угол поворота сущности.
AntEntity
 InheritedglobalX : Number
Глобальная позиция по X.
AntEntity
 InheritedglobalY : Number
Глобальная позиция по Y.
AntEntity
 Inheritedhealth : Number
Объем жизни сущности.
AntEntity
 Inheritedheight : Number
Размер по высоте.
AntEntity
 InheritedisGroup : Boolean
[read-only] Определяет имеются ли в сущности дочерние сущности.
AntEntity
 InheritedisScrolled : Boolean
Определяет реагирует ли сущность на позиционирование камеры.
AntEntity
 Inheritedmask : AntMask
Указатель на маску которая применена к сущности.
AntEntity
 InheritedmaxAngularVelocity : Number
Максимально допустимая скорость вращения сущности.
AntEntity
 InheritedmaxVelocity : AntPoint
Максимально допустимая скорость.
AntEntity
 Inheritedmoves : Boolean
Флаг определяющий является ли сущность движемым объектом.
AntEntity
  numChars : int
[read-only] Возвращает количество символов в тексте.
AntLabel
 InheritednumChildren : int
Количество дочерних сущностей.
AntEntity
  numLines : int
[read-only] Возвращает количество строк в тексте.
AntLabel
 InheritedNUM_OF_ACTIVE : int = 0
[static] Используется для автоматического подсчета активных объектов.
AntBasic
 InheritedNUM_OF_VISIBLE : int = 0
[static] Используется для автоматического подсчета видимых объектов.
AntBasic
 InheritedNUM_ON_SCREEN : int = 0
[static] Используется для автоматического подсчета количества объектов видимых камерами.
AntBasic
 Inheritedorigin : AntPoint
Осевая точка сущности.
AntEntity
 Inheritedparent : AntEntity
Указатель на родителя в которую была помещена сущность.
AntEntity
 InheritedscaleX : Number
Масштаб сущности по горизонтали.
AntEntity
 InheritedscaleY : Number
Масштаб сущности по вертикали.
AntEntity
 InheritedscrollFactorX : Number
Определяет коэффициент смещения сущности по горизонтали относительно смещения камеры.
AntEntity
 InheritedscrollFactorY : Number
Коэффициент смещения сущности по вертикали относительно смещения камеры.
AntEntity
  smoothing : Boolean
Сглаживание.
AntLabel
 Inheritedtag : int
Любое пользовательское значение которое может идентифицировать объект.
AntBasic
  text : String
Определяет текст для текстовой метки.
AntLabel
 InheriteduserData : Object
Указатель на любые пользовательские данные.
AntBasic
 Inheritedvelocity : AntPoint
Скорость движения сущности.
AntEntity
 Inheritedvertices : Vector.<AntPoint>
Массив вершин определяющих прямоугольник сущности исходя из положения и размеров с учетом угла поворота.
AntEntity
 Inheritedvisible : Boolean
Определяет видимость объекта.
AntBasic
 Inheritedwidth : Number
Размер по ширине.
AntEntity
  wordWrap : Boolean
Определяет возможен ли перенос строк.
AntLabel
 Inheritedx : Number
Локальная позициия по X.
AntEntity
 Inheritedy : Number
Локальная позиция по Y.
AntEntity
 Inheritedz : int
Аналог атрибута tag в AntBasic.
AntEntity
Protected Properties
 PropertyDefined By
  _align : String
Текущее выравнивание текста.
AntLabel
  _alpha : Number
Текущая прозрачность.
AntLabel
  _autoSize : Boolean
Определяет авто обновление размера текстовой метки в зависимости от объема текста.
AntLabel
  _buffer : BitmapData
Внутренний буфер в который производится растеризация текста.
AntLabel
  _canRedraw : Boolean
Флаг определяющий возможно ли пересчитать растровый кадр при изменений данных.
AntLabel
  _color : uint
Текущий цвет.
AntLabel
  _colorTransform : ColorTransform
Цветовая трансформация.
AntLabel
  _flashPoint : Point
Внутренний помошник для отрисовки графического контента.
AntLabel
  _flashPointZero : Point
Внутренний помошник для отрисовки графического контента.
AntLabel
  _flashRect : Rectangle
Внутренний помошник для отрисовки графического контента.
AntLabel
 Inherited_helperPoint : AntPoint
Помошник для работы с вершинами.
AntEntity
  _matrix : Matrix
Внутренний помошник для отрисовки графического контента.
AntLabel
 Inherited_oldAngle : Number
Содержит старое значение угла поворота.
AntEntity
 Inherited_oldPosition : AntPoint
Содержит старое значение положения сущности.
AntEntity
 Inherited_oldScale : AntPoint
Содержит старое значение масштабирования.
AntEntity
 Inherited_oldSize : AntPoint
Содержит старое значение размера сущности.
AntEntity
 Inherited_scrollFactorX : Number
Коэффициент смещения сущности по горизонтали относительно смещения камеры.
AntEntity
 Inherited_scrollFactorY : Number
Коэффициент смещения сущности по вертикали относительно смещения камеры.
AntEntity
 Inherited_sortOrder : int
Помошник для сортировки вложенных сущностей.
AntEntity
 Inherited_sortProperty : String
Помошник для сортировки вложенных сущностей.
AntEntity
  _textField : TextField
Стандартное текстовое поле которое используется для растеризации текста.
AntLabel
  _textFormat : TextFormat
Стандартное текстовое форматирование которое используется для применения к тексту какого-либо оформления.
AntLabel
Public Methods
 MethodDefined By
  
AntLabel(aFontName:String, aFontSize:int = 8, aColor:uint = 0xFFFFFF, aEmbedFont:Boolean = true)
AntLabel
 Inherited
Добавляет дочернюю сущность.
AntEntity
  
applyFilters(aFiltersArray:Array):void
Применяет массив указанных фильтров к текстовому полю и перерасчитывает растр.
AntLabel
  
Запрещает обновление текста до тех пор пока не будет вызван endChange().
AntLabel
 Inherited
callAll(aFunctionName:String, aArgs:Array = null, aRecurse:Boolean = true):void
Вызывает метод по его имени для всех вложенных объектов.
AntEntity
 Inherited
contains(aEntity:AntEntity):Boolean
Проверяет является ли указанная сущность ребенком текущей.
AntEntity
 Inherited
debugDraw(aCamera:AntCamera):void
[override] Отладочная отрисовка.
AntEntity
  
destroy():void
[override] Используется для уничтожения объекта и освобождения занимаемых им ресурсов.
AntLabel
  
draw(aCamera:AntCamera):void
[override] Вызывается каждый кадр после вызова метода postUpdate() для отрисовки объекта.
AntLabel
  
endChange():void
Разрешает обновление текста.
AntLabel
 Inherited
getAlive(aClass:Class = null):AntEntity
Извлекает первую попавшуюся существующую и "живую" сущность.
AntEntity
 Inherited
getAvailable(aClass:Class = null):AntEntity
Извлекает первую попавшующся свободную сущность соответствующую указанному классу.
AntEntity
 Inherited
Извлекает дочернюю сущность по её тэгу.
AntEntity
 Inherited
getDead(aClass:Class = null):AntEntity
Извлекает первую попавшуюся "мертвую" сущность.
AntEntity
 Inherited
getExtant(aClass:Class = null):AntEntity
Извлекает первую попавшуюся существующую сущность
AntEntity
 Inherited
getRandom(aClass:Class = null, aExistsOnly:Boolean = true):AntEntity
Извлекает случайную дочернюю сущность.
AntEntity
 Inherited
getScreenPosition(aCamera:AntCamera = null, aResult:AntPoint = null):AntPoint
Вычисляет экранные координаты сущности для указанной камеры.
AntEntity
  
highlightText(aText:String, aColor:uint):void
Подсвечивает указанный текст указанным цветом.
AntLabel
 Inherited
hitTest(aX:Number, aY:Number, aPixelFlag:Boolean = false):Boolean
Проверяет попадает ли указанные координаты в прямоугольник сущности.
AntEntity
 Inherited
hitTestPoint(aPoint:AntPoint, aPixelFlag:Boolean = false):Boolean
Проверяет попадает ли указанная точка в прямоугольник сущности.
AntEntity
 Inherited
hurt(aDamage:Number):Boolean
Наносит урон.
AntEntity
 Inherited
kill():void
[override] Вызывается когда объект необходимо временно "убить" и освободить для повторного использования.
AntEntity
 Inherited
numDead():int
Определяет количество "мертвых" дочерних сущностей.
AntEntity
 Inherited
numLiving():int
Определяет количество "живых" дочерних сущностей.
AntEntity
 Inherited
onEventBubbled(aEvent:IEvent):Boolean
Обработчик для всплывающего события.
AntEntity
 Inherited
onScreen(aCamera:AntCamera = null):Boolean
Проверяет попадает ли сущность на экран указанной камеры.
AntEntity
 Inherited
postUpdate():void
Вызывается каждый кадр сразу после вызова метода update();
AntBasic
 Inherited
preUpdate():void
[override] Вызывается каждый кадр перед вызовом метода update().
AntEntity
 Inherited
queryByTag(aTag:int, aResult:Array = null):Array
Извлекает массив дочерних сущностей по их тэгу.
AntEntity
 Inherited
recycle(aClass:Class = null):AntEntity
Переиспользование дочерних сущностей.
AntEntity
 Inherited
remove(aEntity:AntEntity, aSplice:Boolean = false):AntEntity
Удаляет дочернюю сущность.
AntEntity
 Inherited
removeAll(aDestroy:Boolean = true):void
Удаляет все вложенные сущности.
AntEntity
 Inherited
replace(aOldEntity:AntEntity, aNewEntity:AntEntity):AntEntity
Заменяет указанную сущность на новую.
AntEntity
 Inherited
reset(aX:Number = 0, aY:Number = 0, aAngle:Number = 0):void
Устанавливает (сбрасывает) позицию и угол.
AntEntity
 Inherited
revive():void
[override] Воскрешает объект после "убийства" для повторного использования.
AntEntity
 Inherited
setAll(aVariableName:String, aValue:Object, aRecurse:Boolean = true):void
Устанавливает значение переменной по её имени для всех вложенных объектов.
AntEntity
  
setColor(aColor:uint, aStartIndex:int = -1, aEndIndex:int = -1):void
Задает цвет текста для всего текстового поля или для указанного диапазона символов.
AntLabel
  
setSize(aWidth:int, aHeight:int):void
Устанавливает размер текстового поля в ручную.
AntLabel
  
setStroke(aColor:uint = 0xFF000000):void
Устанавливает однопиксельную обводку для текстового поля.
AntLabel
 Inherited
sort(aIndex:String = y, aOrder:int):void
Сортировка дочерних сущностей по указанному атрибуту.
AntEntity
 Inherited
swap(aEntityA:AntEntity, aEntityB:AntEntity):void
Меняет указанные сущности местами.
AntEntity
 Inherited
update():void
[override] Вызывается каждый кадр.
AntEntity
 Inherited
Обновляет положение и размеры прямоугольника определяющего занимаемую область в игровом мире.
AntEntity
Protected Methods
 MethodDefined By
 Inherited
calcBounds():void
Простой рассчет занимаемого сущностью прямоугольника без учета угла поворота.
AntEntity
  
calcFrame():void
Растеризация векторного TextField в битмап.
AntLabel
 Inherited
drawChildren(aCamera:AntCamera):void
Отрисовка дочерних сущностей.
AntEntity
  
drawText(aCamera:AntCamera):void
Отрисовка текста в буффер указанной камеры.
AntLabel
 Inherited
Инвертирует вершины если необходимо.
AntEntity
 Inherited
locate(aX:Number, aY:Number, aAngle:Number):void
Перерасчитывает глобальное позиционирование сущности согласно родительским координатам и углу.
AntEntity
 Inherited
moveBounds():void
Простой перерассчет занимаемого сущностью прямоугольника при условии что угол и размеры сущности не изменились.
AntEntity
  
Сброс помошников и обновление битмапа.
AntLabel
  
[override] Полный перерассчет занимаемого сущностью прямоугольника с учетом угла, размеров и положения.
AntLabel
 Inherited
Сохраняет предыдущие значения положения и угла для оптимизации рассчетов.
AntEntity
 Inherited
sortHandler(aEntity1:AntEntity, aEntity2:AntEntity):int
Помошник для сортировки вложенных сущностей.
AntEntity
 Inherited
toScreenPosition(aX:Number, aY:Number, aCamera:AntCamera = null, aResult:AntPoint = null):AntPoint
Переводит указанные координаты в экранные.
AntEntity
 Inherited
Обработка дочерних сущностей.
AntEntity
 Inherited
Рассчет скорости движения и вращения сущности.
AntEntity
Public Constants
 ConstantDefined By
 InheritedASCENDING : int = -1
[static] Константа для определения способа сортировки по возрастанию.
AntEntity
  CENTER : String = center
[static]
AntLabel
 InheritedDESCENDING : int = 1
[static] Констатна для определения способа сортировки по убыванию.
AntEntity
  JUSTIFY : String = justify
[static]
AntLabel
  LEFT : String = left
[static]
AntLabel
  RIGHT : String = right
[static]
AntLabel
Property Detail
_alignproperty
protected var _align:String

Текущее выравнивание текста.

The default value is ALIGN_LEFT.

_alphaproperty 
protected var _alpha:Number

Текущая прозрачность.

The default value is 1.

_autoSizeproperty 
protected var _autoSize:Boolean

Определяет авто обновление размера текстовой метки в зависимости от объема текста.

The default value is true.

_bufferproperty 
protected var _buffer:BitmapData

Внутренний буфер в который производится растеризация текста.

_canRedrawproperty 
protected var _canRedraw:Boolean

Флаг определяющий возможно ли пересчитать растровый кадр при изменений данных.

_colorproperty 
protected var _color:uint

Текущий цвет.

The default value is 0x00FFFFFF.

_colorTransformproperty 
protected var _colorTransform:ColorTransform

Цветовая трансформация. Инициализируется автоматически если задан цвет отличный от 0x00FFFFFF.

The default value is null.

_flashPointproperty 
protected var _flashPoint:Point

Внутренний помошник для отрисовки графического контента.

_flashPointZeroproperty 
protected var _flashPointZero:Point

Внутренний помошник для отрисовки графического контента.

_flashRectproperty 
protected var _flashRect:Rectangle

Внутренний помошник для отрисовки графического контента.

_matrixproperty 
protected var _matrix:Matrix

Внутренний помошник для отрисовки графического контента.

_textFieldproperty 
protected var _textField:TextField

Стандартное текстовое поле которое используется для растеризации текста.

_textFormatproperty 
protected var _textFormat:TextFormat

Стандартное текстовое форматирование которое используется для применения к тексту какого-либо оформления.

alignproperty 
align:String

Определяет выравнивание текста.


Implementation
    public function get align():String
    public function set align(value:String):void
alphaproperty 
alpha:Number

Определяет текущую прозрачность кэшированного битмапа текстовой метки.


Implementation
    public function get alpha():Number
    public function set alpha(value:Number):void
autoSizeproperty 
autoSize:Boolean

Определяет изменяется ли текстовое поле автоматически исходя из количества текста. Выравнивание текста не работает при авто изменении размера поля.


Implementation
    public function get autoSize():Boolean
    public function set autoSize(value:Boolean):void
blendproperty 
public var blend:String

Режим смешивания цветов.

The default value is null.

boldproperty 
bold:Boolean

Определяет толщину начертания текста.


Implementation
    public function get bold():Boolean
    public function set bold(value:Boolean):void
colorproperty 
color:uint

Определяет текущий цвет кэшированного битмапа текстовой метки.


Implementation
    public function get color():uint
    public function set color(value:uint):void
numCharsproperty 
numChars:int  [read-only]

Возвращает количество символов в тексте.


Implementation
    public function get numChars():int
numLinesproperty 
numLines:int  [read-only]

Возвращает количество строк в тексте.


Implementation
    public function get numLines():int
smoothingproperty 
public var smoothing:Boolean

Сглаживание.

The default value is true.

textproperty 
text:String

Определяет текст для текстовой метки.


Implementation
    public function get text():String
    public function set text(value:String):void
wordWrapproperty 
wordWrap:Boolean

Определяет возможен ли перенос строк.


Implementation
    public function get wordWrap():Boolean
    public function set wordWrap(value:Boolean):void
Constructor Detail
AntLabel()Constructor
public function AntLabel(aFontName:String, aFontSize:int = 8, aColor:uint = 0xFFFFFF, aEmbedFont:Boolean = true)

Parameters
aFontName:String
 
aFontSize:int (default = 8)
 
aColor:uint (default = 0xFFFFFF)
 
aEmbedFont:Boolean (default = true)
Method Detail
applyFilters()method
public function applyFilters(aFiltersArray:Array):void

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

Parameters

aFiltersArray:Array — Массив фильтров которые необходимо применить к тексту.

beginChange()method 
public function beginChange():void

Запрещает обновление текста до тех пор пока не будет вызван endChange(). Следует вызывать перед тем как необходимо применить сразу много сложных операций к тексту.

Пример использования:

label.beginChange(); label.setSize(200, 50); label.text = "some big text here"; label.setColor(0x00FF00, 0, 4); label.endChange();

calcFrame()method 
protected function calcFrame():void

Растеризация векторного TextField в битмап.

destroy()method 
override public function destroy():void

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

draw()method 
override public function draw(aCamera:AntCamera):void

Вызывается каждый кадр после вызова метода postUpdate() для отрисовки объекта.

Parameters

aCamera:AntCamera

drawText()method 
protected function drawText(aCamera:AntCamera):void

Отрисовка текста в буффер указанной камеры.

Parameters

aCamera:AntCamera — Камера в буффер которой необходимо отрисовать текст.

endChange()method 
public function endChange():void

Разрешает обновление текста. Обязательно вызывать после того как был вызван метод beginChange().

highlightText()method 
public function highlightText(aText:String, aColor:uint):void

Подсвечивает указанный текст указанным цветом.

Parameters

aText:String — Текст который необходимо подсветить.
 
aColor:uint — Цвет которым необходимо подсветить.

resetHelpers()method 
protected function resetHelpers():void

Сброс помошников и обновление битмапа.

rotateBounds()method 
override protected function rotateBounds():void

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

setColor()method 
public function setColor(aColor:uint, aStartIndex:int = -1, aEndIndex:int = -1):void

Задает цвет текста для всего текстового поля или для указанного диапазона символов.

Примичание: Цвет указанный через setColor() применяется непосредственно к стандартному текстовому полю и не имеет отношения к значению . То есть если вы укажете цвет через setColor(), а потом зададите другой цвет через color - то цвета будут смешаны.

Parameters

aColor:uint — Цвет в который необходимо перекрасить текст.
 
aStartIndex:int (default = -1) — Начальный индекс символа скоторого начинать красить.
 
aEndIndex:int (default = -1) — Конечный индекс символа до которого красить.

setSize()method 
public function setSize(aWidth:int, aHeight:int):void

Устанавливает размер текстового поля в ручную. Если autoSize = true то размеры будут автоматически изменены при обновлении текста.

Parameters

aWidth:int — Размер текстового поля по ширине.
 
aHeight:int — Размер текстового поля по высоте.

setStroke()method 
public function setStroke(aColor:uint = 0xFF000000):void

Устанавливает однопиксельную обводку для текстового поля.

Parameters

aColor:uint (default = 0xFF000000) — Цвет обводки.

Constant Detail
CENTERConstant
public static const CENTER:String = center

JUSTIFYConstant 
public static const JUSTIFY:String = justify

LEFTConstant 
public static const LEFT:String = left

RIGHTConstant 
public static const RIGHT:String = right