| Package | com.jumpeye.flashEff.core.interfaces |
| Interface | public interface IFeGroup |
FeGroup elements,
for text based patterns. The FeGroup objects contain words from the target text or lines of
text.
| Property | Defined by | ||
|---|---|---|---|
| childs : Array
A list of
Sprite objects containing the elements that the target text was broken into. | IFeGroup | ||
| id : Number
The index of the current element in the list of elements (words or lines) the text was broken into.
| IFeGroup | ||
| properties : Object
All the properties of the current element, including information about its bounds.
| IFeGroup | ||
| text : String
The entire text on which the text pattern is applied.
| IFeGroup | ||
| type : String [read-only]
The type of the current object, basically a
String representing the name of the class ("FeGroup");
| IFeGroup | ||
| Method | Defined 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). | IFeGroup | ||
|
pushChild(arg:Object):Object
Creates and inserts a new
FeGroup object to the end of the childs list. | IFeGroup | ||
|
removeChildAtIndex(index:uint):Object
Removes from the
childs list the child object found at the position
specified by the index parameter. | IFeGroup | ||
|
removeChilds():void
Removes all the children from
childs. | IFeGroup | ||
| childs | property |
childs:Array [read-write]
A list of Sprite objects containing the elements that the target text was broken into. One such a
Sprite object could contain a word, if the text was broken into words, or a line of text, if the text
was broken into lines.
public function get childs():Array
public function set childs(value:Array):void
| id | property |
id:Number [read-write]The index of the current element in the list of elements (words or lines) the text was broken into.
Implementation public function get id():Number
public function set id(value:Number):void
| properties | property |
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
| text | property |
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
| type | property |
type:String [read-only]
The type of the current object, basically a String representing the name of the class ("FeGroup");
public function get type():String
| 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 a partial effect, 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.
arg:Object — The object containing all the properties of the new FeGroup object.
|
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.
index:uint — The 0 based position of the target child object in the list.
|
Object — The child object that was removed from the list.
|
| removeChilds | () | method |
public function removeChilds():void
Removes all the children from childs.