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

This interface has to be implemented by the FlashEff button effect patterns.


Public Properties
 PropertyDefined by
  component : IFlashEff
Reference to the FlashEff component instance using the current ButtonEffect pattern.
IFlashEffButtonEffect
  easeType : String
The types of easing that will be applied by the pattern.
IFlashEffButtonEffect
  target : DisplayObject
The target object to which the effect will be associated with.
IFlashEffButtonEffect
  tweenDuration : Number
The time duration of the action, measured in seconds.
IFlashEffButtonEffect
  tweenType : String
The type of tween animation used by the pattern.
IFlashEffButtonEffect
Public Methods
 MethodDefined by
  
apply():void
Reapplies the ButtonEffect pattern on the target object, after it has been removed with the remove() method.
IFlashEffButtonEffect
  
buttonPress():void
Manually applies the mouse press state on the target object, without the mouse press action, and dispatches the FLASHEFFEvents.MOUSE_DOWN event.
IFlashEffButtonEffect
  
buttonRelease():void
Manually applies the mouse release state on the target object, without the mouse release action, and dispatches the FLASHEFFEvents.MOUSE_UP event.
IFlashEffButtonEffect
  
buttonRollOut():void
Manually applies the roll out state on the target object, without the mouse moving out of it, and dispatches the FLASHEFFEvents.ROLL_OUT event.
IFlashEffButtonEffect
  
buttonRollOver():void
Manually applies the roll over state on the target object, without the mouse getting over it, and dispatches the FLASHEFFEvents.ROLL_OVER event.
IFlashEffButtonEffect
  
remove():void
Removes the current pattern from the target object but not from the FlashEff instance.
IFlashEffButtonEffect
Property detail
componentproperty
component:IFlashEff  [read-write]

Reference to the FlashEff component instance using the current ButtonEffect pattern.

Implementation
    public function get component():IFlashEff
    public function set component(value:IFlashEff):void

See also

IFlashEff
easeTypeproperty 
easeType:String  [read-write]

The types of easing that will be applied by the pattern. Supported values are "easeIn", "easeOut", "easeInOut" and "easeNone".

Implementation
    public function get easeType():String
    public function set easeType(value:String):void
targetproperty 
target:DisplayObject  [read-write]

The target object to which the effect will be associated with. The effect will be applied only on the event it is associated with: rollOver, rollOut, press and release.

Implementation
    public function get target():DisplayObject
    public function set target(value:DisplayObject):void
tweenDurationproperty 
tweenDuration:Number  [read-write]

The time duration of the action, measured in seconds.

Implementation
    public function get tweenDuration():Number
    public function set tweenDuration(value:Number):void
tweenTypeproperty 
tweenType:String  [read-write]

The type of tween animation used by the pattern. Supported values are "Regular", "Strong", "Back", "Bounce", "Elastic" and "None".

Implementation
    public function get tweenType():String
    public function set tweenType(value:String):void
Method detail
apply()method
public function apply():void

Reapplies the ButtonEffect pattern on the target object, after it has been removed with the remove() method.

See also

remove()
buttonPress()method 
public function buttonPress():void

Manually applies the mouse press state on the target object, without the mouse press action, and dispatches the FLASHEFFEvents.MOUSE_DOWN event. This is useful when the component should visually change the state of the target object but not as a result of mouse interraction.

See also

buttonRollOver()
buttonRollOut()
buttonRelease()
buttonRelease()method 
public function buttonRelease():void

Manually applies the mouse release state on the target object, without the mouse release action, and dispatches the FLASHEFFEvents.MOUSE_UP event. This is useful when the component should visually change the state of the target object but not as a result of mouse interraction.

See also

buttonRollOut()
buttonPress()
buttonRelease()
buttonRollOut()method 
public function buttonRollOut():void

Manually applies the roll out state on the target object, without the mouse moving out of it, and dispatches the FLASHEFFEvents.ROLL_OUT event. This is useful when the component should visually change the state of the target object but not as a result of mouse interraction.

See also

buttonRollOver()
buttonPress()
buttonRelease()
buttonRollOver()method 
public function buttonRollOver():void

Manually applies the roll over state on the target object, without the mouse getting over it, and dispatches the FLASHEFFEvents.ROLL_OVER event. This is useful when the component should visually change the state of the target object but not as a result of mouse interraction.

See also

buttonRollOut()
buttonPress()
buttonRelease()
remove()method 
public function remove():void

Removes the current pattern from the target object but not from the FlashEff instance.

See also

apply()