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

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 (characters) and FeGroup elements (words or lines of text), for text based patterns. The instances of this class are lists of FeChar or FeGroup elements.



Public Properties
 PropertyDefined by
  childs : Array
A list of FeGroup objects that the target text was broken into.
IFeTable
  type : String
[read-only] The type of the current object, basically a String with the name of the class ("FeTable").
IFeTable
Public Methods
 MethodDefined by
  
cleanMe():void
Goes through the entire childs list and removes all the elements that are empty (do not contain any characters from the text).
IFeTable
  
pushChild(arg:Object):Object
Creates and inserts a new FeGroup object to the end of the childs list.
IFeTable
  
removeChildAtIndex(index:uint):Object
Removes from the childs list the child object found at the position specified by the index parameter.
IFeTable
  
removeChilds():void
Removes all the children from childs.
IFeTable
Property detail
childsproperty
childs:Array  [read-write]

A list of FeGroup objects that the target text was broken into. If the text was broken into characters, then the generated FeChar are placed inside FeGroup objects and only the FeGroup elements are placed inside this list.

Implementation
    public function get childs():Array
    public function set childs(value:Array):void

See also

typeproperty 
type:String  [read-only]

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

Implementation
    public function get type():String
Method detail
cleanMe()method
public function cleanMe():void

Goes through the entire childs list and removes all the elements that are empty (do not contain any characters from the text). Some of the elements from the childs list may get empty if a partial effect is applied on the text. In case of partial effects, a part of the characters from the text will be removed from this list and placed into a second list, so the target text will be separated into two tables: a table will contain characters used for the main animation (partial effect) and the other one for the secondary animation.

See also

pushChild()method 
public function pushChild(arg:Object):Object

Creates and inserts a new FeGroup object to the end of the childs list.

Parameters
arg:Object — The object containing all the properties of the new FeGroup object.

Returns
Object — The FeGroup object that was just added.
removeChildAtIndex()method 
public function removeChildAtIndex(index:uint):Object

Removes from the childs list the child object found at the position specified by the index parameter.

Parameters
index:uint — The 0 based position of the target child object in the list.

Returns
Object — The FeGroup object that was removed from the list.
removeChilds()method 
public function removeChilds():void

Removes all the children from childs.