pegas.transitions.FrameEngine

	Property	Defined by
		channel : String Indicates the channel of this dispatcher if this instance is global.	CoreEventDispatcher
		isGlobal : Boolean (read-only) Returns the value of the isGlobal flag of this model.	CoreEventDispatcher
		running : Boolean (read-only) Indicates `true` if the process is in progress.	SimpleAction

Public Methods

	Method		Defined by
		FrameEngine(bGlobal:Boolean = false, sChannel:String = null) Creates a new FrameEngine instance.	FrameEngine
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0.0, useWeakReference:Boolean = false):void Allows the registration of event listeners on the event target.	CoreEventDispatcher
		clone():* Returns a shallow copy of this object.	SimpleAction
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	CoreEventDispatcher
		getEventDispatcher():EventDispatcher Returns the internal `EventDispatcher` reference.	CoreEventDispatcher
		getInstance():FrameEngine [static] Returns the singleton reference of the class.	FrameEngine
		getIsGlobal():Boolean Returns the value of the isGlobal flag of this model.	CoreEventDispatcher
		getLogger():ILogger Returns the internal `ILogger` reference of this `ILogable` object.	CoreObject
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	CoreEventDispatcher
		hashCode():uint Returns a hashcode value for the object.	CoreObject
		initEventDispatcher():EventDispatcher Creates and returns the internal `EventDispatcher` reference (this method is invoked in the constructor).	CoreEventDispatcher
		isLocked():Boolean Returns `true` if the object is locked.	CoreEventDispatcher
		lock():void Locks the object.	CoreEventDispatcher
		notifyFinished():void Notify an ActionEvent when the process is finished.	SimpleAction
		notifyStarted():void Notify an ActionEvent when the process is started.	SimpleAction
		registerEventListener(type:String, listener:Boolean, useCapture:int = false, priority:Boolean = 0, useWeakReference:* = false):void Allows the registration of event listeners on the event target (Function or EventListener).	CoreEventDispatcher
		release():void [static] Release the singleton reference of the class.	FrameEngine
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	CoreEventDispatcher
		run(... arguments):void Run the process.	SimpleAction
		setEventDispatcher(e:EventDispatcher):void Sets the internal `EventDispatcher` reference.	CoreEventDispatcher
		setGlobal(flag:Boolean = false, channel:String = null):void Sets if the instance use a global `EventDispatcher` to dispatch this events, if the `flag` value is `false` the instance use a local EventDispatcher.	CoreEventDispatcher
		setLogger(log:ILogger = null):void Sets the internal `ILogger` reference of this `ILogable` object.	CoreObject
		start():void Start the process.	FrameEngine
		stop():void Stop the process.	FrameEngine
		toSource(indent:int = 0):String Returns the string representation the source code of the object.	CoreEventDispatcher
		toString():String Returns the string representation of this instance.	CoreObject
		unlock():void Unlocks the display.	CoreEventDispatcher
		unregisterEventListener(type:String, listener:Boolean, useCapture:* = false):void Removes a listener (Function or EventListener object) from the EventDispatcher object.	CoreEventDispatcher
		willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.	CoreEventDispatcher

	Method	Defined by
		setRunning(b:Boolean):void Changes the running property value.	SimpleAction

	Event	Summary	Defined by
		onFinished	Dispatched when a process is finished.	SimpleAction
		onStarted	Dispatched when a process is started.	SimpleAction

Constructor detail

FrameEngine

()

constructor

public function FrameEngine(bGlobal:Boolean = false, sChannel:String = null)

Creates a new FrameEngine instance.

Parameters

	`bGlobal:Boolean` (default = `false`) — the flag to use a global event flow or a local event flow.

	`sChannel:String` (default = `null`) — the name of the global event flow if the `bGlobal` argument is `true`.

Method detail

getInstance

()

method

public static function getInstance():FrameEngine

Returns the singleton reference of the class.

Returns

FrameEngine — the singleton reference of the class.

release

()

method

public static function release():void

Release the singleton reference of the class.

start

()

method

public function start():void

Start the process.

stop

()

method

public function stop():void

Stop the process.

VEGAS AS3 Reference	All Packages \| All Classes \| Index \| Frames No Frames
Class FrameEngine	Properties \| Methods \| Events

Package	pegas.transitions
Class	public class FrameEngine
Inheritance	FrameEngine SimpleAction CoreEventDispatcher CoreObject