Packagecom.jumpeye.flashEff.core.interfaces
Interfacepublic interface IFlashEffText extends IFlashEffSymbolText

This interface has to be implemented by all the FlashEff text patterns.



Public Properties
 PropertyDefined by
 Inheritedcomponent : IFlashEff
Reference to the FlashEff component instance using the current pattern.
IFlashEffSymbolText
 InheritedeaseType : String
The types of easing that will be applied by the pattern.
IFlashEffSymbolText
  partialBlurAmount : Number
The amount of the blur filter applied on the elements of the secondary animation (the ones that are not included in the main effect).
IFlashEffText
  partialGroup : String
The elements into which the text will be broken for the partial effect.
IFlashEffText
  partialPercent : Number
The percentage of elements on which the effect will be applied.
IFlashEffText
  partialStart : Number
The value represents the difference, in percentage of the main effect duration (100%), between the moment when the main effect starts and the moment when the secondary animation starts.
IFlashEffText
  selectedStrings : Array
A set of strings from the target text on which the effect will be applied.
IFlashEffText
  target : TextField
Reference to the target text field on which the effect will be applied.
IFlashEffText
 InheritedtweenDuration : Number
The time duration of the show or hide transition, measured in seconds.
IFlashEffSymbolText
 InheritedtweenType : String
The type of tween animation used by the pattern.
IFlashEffSymbolText
Public Methods
 MethodDefined by
 Inherited
hide():void
Start the transition which turns the text from a visible state to invisible.
IFlashEffSymbolText
 Inherited
remove():void
Stops and removes the show or hide transition but without removing the pattern object from the FlashEff component instance.
IFlashEffSymbolText
 Inherited
show():void
Start the transition which turns the target object from an invisible state to visible.
IFlashEffSymbolText
Property detail
partialBlurAmountproperty
partialBlurAmount:Number  [read-write]

The amount of the blur filter applied on the elements of the secondary animation (the ones that are not included in the main effect).

Implementation
    public function get partialBlurAmount():Number
    public function set partialBlurAmount(value:Number):void

See also

partialGroupproperty 
partialGroup:String  [read-write]

The elements into which the text will be broken for the partial effect. Supported values are "letters", "words", "lines" and "selectedStrings". The selected effect (main animation) will be applied only on that group of elements and the elements left outside of the effect will have an alpha fade applied on them (secondary animation), together with a blur filter, if the blurAmount property has a value larger than 0.

Implementation
    public function get partialGroup():String
    public function set partialGroup(value:String):void

See also

partialPercentproperty 
partialPercent:Number  [read-write]

The percentage of elements on which the effect will be applied. If partialGroup is "words" and partialPercent has a value of 50, it means that the effect will be applied only on half of the words from the target text. Those elements are selected randomly.

Implementation
    public function get partialPercent():Number
    public function set partialPercent(value:Number):void

See also

partialStartproperty 
partialStart:Number  [read-write]

The value represents the difference, in percentage of the main effect duration (100%), between the moment when the main effect starts and the moment when the secondary animation starts. A value of 0% means that the secondary animation begins at the same time as the main effect. A value of 50% means that the secondary animation begins when 50% of the main effect has already been played.

Implementation
    public function get partialStart():Number
    public function set partialStart(value:Number):void

See also

selectedStringsproperty 
selectedStrings:Array  [read-write]

A set of strings from the target text on which the effect will be applied.

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

See also

targetproperty 
target:TextField  [read-write]

Reference to the target text field on which the effect will be applied.

Implementation
    public function get target():TextField
    public function set target(value:TextField):void