Packagecom.jumpeye.flashEff.core.interfaces
Interfacepublic interface IFeChar

This interface should not be implemented by third party patterns. This interface is only presented for documentation purposes. The FlashEff component may break the target text into FeChar elements, for text based patterns. The FeChar objects contain characters from the target text.



Public Properties
 PropertyDefined by
  bottomPosition : Number
Used by the FlashEff instance to align all the FeChar elements to bottom - all the FeChar objects will have the same bottom position.
IFeChar
  htmlText : String
The html text contained by the target text field (with all the text formatting).
IFeChar
  id : Number
The index of the current element in the list of elements (characters) the text was broken into.
IFeChar
  properties : Object
All the properties of the current element, including information about its bounds.
IFeChar
  text : String
The entire text on which the text pattern is applied.
IFeChar
  textField : TextField
The text field that contains one of the characters from the target text, after it was broken apart.
IFeChar
  type : String
[read-only] The type of the current object, basically a String representing the name of the class ("FeChar").
IFeChar
Public Methods
 MethodDefined by
  
applyTextFormat(tfm:TextFormat):void
Applies text formatting on the current FeChar element.
IFeChar
Property detail
bottomPositionproperty
bottomPosition:Number  [read-write]

Used by the FlashEff instance to align all the FeChar elements to bottom - all the FeChar objects will have the same bottom position.

Implementation
    public function get bottomPosition():Number
    public function set bottomPosition(value:Number):void
htmlTextproperty 
htmlText:String  [read-write]

The html text contained by the target text field (with all the text formatting).

Implementation
    public function get htmlText():String
    public function set htmlText(value:String):void
idproperty 
id:Number  [read-write]

The index of the current element in the list of elements (characters) the text was broken into. White spaces are not taken into consideration when the list is built.

Implementation
    public function get id():Number
    public function set id(value:Number):void
propertiesproperty 
properties:Object  [read-write]

All the properties of the current element, including information about its bounds.

Implementation
    public function get properties():Object
    public function set properties(value:Object):void
textproperty 
text:String  [read-write]

The entire text on which the text pattern is applied.

Implementation
    public function get text():String
    public function set text(value:String):void
textFieldproperty 
textField:TextField  [read-write]

The text field that contains one of the characters from the target text, after it was broken apart.

Implementation
    public function get textField():TextField
    public function set textField(value:TextField):void
typeproperty 
type:String  [read-only]

The type of the current object, basically a String representing the name of the class ("FeChar").

Implementation
    public function get type():String
Method detail
applyTextFormat()method
public function applyTextFormat(tfm:TextFormat):void

Applies text formatting on the current FeChar element.

Parameters
tfm:TextFormat — The TextFormat object that will be applied.