artcustomer.framework.context.FlashContext

Public Methods

	Method		Defined By
		FlashContext() Constructor	FlashContext
		addComponent(componentClass:Class, modelClass:Class, commandClass:Class):void Add new FlashComponent.	FlashContext
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Add an eventListener.	EventContext
		addLayer3D(context3dClass:Class):Layer3D Add Layer3D.	FlashContext
		addLayerVideo(contextvideoClass:Class):LayerVideo Add LayerVideo.	FlashContext
		addManager(managerClass:Class, id:String):void Add new Manager.	FlashContext
		allowDomain(... rest):void Allow a domain in application.	ServiceContext
		allowInsecureDomain(... rest):void Allow an insecure domain in application.	ServiceContext
		debug():String Get Debug version of Context.	FlashContext
		destroy():void [override] Destroy the context.	FlashContext
		dispatchEvent(e:Event):Boolean Dispatch an event.	EventContext
		dumpParameters():String Get properties and values of Flash parameters in String format.	ServiceContext
		exitPlayer(code:uint = 0):void Exit Flash Player.	ServiceContext
		getComponent(id:String):FlashComponent Get FlashComponent.	FlashContext
		getLayer3dAt(index:int):Layer3D Get Layer3D.	FlashContext
		getLayerVideoAt(index:int):LayerVideo Get LayerVideo.	FlashContext
		getManager(id:String):AbstractManager Get Manager.	FlashContext
		getParameter(name:String):Object Get Flash parameter by name.	ServiceContext
		hasComponent(id:String):Boolean Test if FlashComponent exists.	FlashContext
		hasEventListener(type:String):Boolean Test an eventlistener.	EventContext
		hasLayer3dAt(index:int):Boolean Test Layer3D.	FlashContext
		hasLayerVideoAt(index:int):Boolean Test LayerVideo.	FlashContext
		hideLogo():void Hide Framework logo.	InteractiveContext
		hideMenu():void Hide Framework context menu.	InteractiveContext
		infos():String Get Debug version of Player.	BaseContext
		loadPolicyFile(url:String):void Load policy file (XML Crossdomain).	ServiceContext
		move(x:int = 0, y:int = 0):void Move the context view.	InteractiveContext
		moveLogo(align:String, verticalMargin:int = 0, horizontalMargin:int = 0):void Move Framework logo.	InteractiveContext
		pausePlayer():void Pause Flash Player	ServiceContext
		refreshView():void Refresh the context view.	InteractiveContext
		releaseMemory():void Force the garbage collection process.	ServiceContext
		removeComponent(id:String):void Remove FlashComponent.	FlashContext
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Remove an eventlistener.	EventContext
		removeLayer3D(layer3d:Layer3D):void Remove instance of Layer3D.	FlashContext
		removeLayer3DAt(index:int):void Remove instance of Layer3D at index.	FlashContext
		removeLayerVideo(layervideo:LayerVideo):void Remove instance of LayerVideo	FlashContext
		removeLayerVideoAt(index:int):void Remove instance of LayerVideo at index	FlashContext
		removeManager(id:String):void Remove Manager.	FlashContext
		reset():void Reset the context.	BaseContext
		resumePlayer():void Resume Flash Player	ServiceContext
		setup():void [override] Setup the context.	FlashContext
		showLogo():void Show Framework logo.	InteractiveContext
		showMenu():void Show Framework context menu.	InteractiveContext
		swapComponents(comp1:FlashComponent, comp2:FlashComponent):void Swap FlashComponents (z-order in stack).	FlashContext
		throwCustomError(error:Class, message:, id: = 0):void Throw a custom Error.	BaseContext
		throwError(message:, id: = 0):void Throw an Error.	BaseContext
		toggleFullScreen():void Switch Normal / FullScreen mode	InteractiveContext
		willTrigger(type:String):Boolean Test event trigger.	EventContext

	Method	Defined By
		focus():void When FlashPlayer receive focus.	InteractiveContext
		render():void [override] Called by RenderEngine during rendering.	FlashContext
		resize():void [override] Called by InteractiveContext during resizing.	FlashContext
		unfocus():void When FlashPlayer lose focus.	InteractiveContext

Constructor Detail

FlashContext

()

Constructor

public function FlashContext()

Constructor

Method Detail

addComponent

()

method

public final function addComponent(componentClass:Class, modelClass:Class, commandClass:Class):void

Add new FlashComponent.

Parameters

	`componentClass:Class` — : FlashComponent

	`modelClass:Class` — : Model of the component

	`commandClass:Class` — : Command of the component

addLayer3D

()

method

public final function addLayer3D(context3dClass:Class):Layer3D

Add Layer3D.

Parameters

context3dClass:Class — : Class of the instance of Layer3D.

Returns

Layer3D — the instance created.

addLayerVideo

()

method

public final function addLayerVideo(contextvideoClass:Class):LayerVideo

Add LayerVideo.

Parameters

contextvideoClass:Class — : Class of the instance of LayerVideo.

Returns

LayerVideo — the instance created.

addManager

()

method

public final function addManager(managerClass:Class, id:String):void

Add new Manager.

Parameters

	`managerClass:Class` — : AbstractManager

	`id:String` — : ID of the Manager.

debug

()

method

public function debug():String

Get Debug version of Context.

Returns

String —

destroy

()

method

override public function destroy():void

Destroy the context. Must be overrided and called at end.

getComponent

()

method

public final function getComponent(id:String):FlashComponent

Get FlashComponent.

Parameters

id:String — : Name of the FlashComponent in order to find it in the stack.

Returns

FlashComponent — the FlashComponent corresponding to the ID or null if ID ins't exist in the stack

getLayer3dAt

()

method

public final function getLayer3dAt(index:int):Layer3D

Get Layer3D.

Parameters

index:int — : Index of the Layer3D in order to find it in the stack

Returns

Layer3D — the Layer3D corresponding to the index or null if index ins't exist in the stack

getLayerVideoAt

()

method

public final function getLayerVideoAt(index:int):LayerVideo

Get LayerVideo.

Parameters

index:int — : Index of the LayerVideo in order to find it in the stack

Returns

LayerVideo — the LayerVideo corresponding to the index or null if index ins't exist in the stack

getManager

()

method

public final function getManager(id:String):AbstractManager

Get Manager.

Parameters

id:String — : Name of the Manager in order to find it in the stack.

Returns

AbstractManager — the Manager corresponding to the ID or null if ID ins't exist in the stack.

hasComponent

()

method

public final function hasComponent(id:String):Boolean

Test if FlashComponent exists.

Parameters

id:String — : Name of the Component in order to find it in the stack.

Returns

Boolean —

hasLayer3dAt

()

method

public final function hasLayer3dAt(index:int):Boolean

Test Layer3D.

Parameters

index:int — : Index of the Layer3D in order to find it in the stack.

Returns

Boolean — True if Layer3D exists / False if Layer3D isn't exists

hasLayerVideoAt

()

method

public final function hasLayerVideoAt(index:int):Boolean

Test LayerVideo.

Parameters

index:int — : Index of the LayerVideo in order to find it in the stack

Returns

Boolean — True if LayerVideo exists / False if LayerVideo isn't exists

removeComponent

()

method

public final function removeComponent(id:String):void

Remove FlashComponent.

Parameters

id:String — : Name of the Component in order to find it in the stack.

removeLayer3D

()

method

public final function removeLayer3D(layer3d:Layer3D):void

Remove instance of Layer3D.

Parameters

layer3d:Layer3D — : Instance of Layer3D

removeLayer3DAt

()

method

public final function removeLayer3DAt(index:int):void

Remove instance of Layer3D at index.

Parameters

index:int — : index of the Layer3D in order to find it in the stack.

removeLayerVideo

()

method

public final function removeLayerVideo(layervideo:LayerVideo):void

Remove instance of LayerVideo

Parameters

layervideo:LayerVideo — : Instance of LayerVideo

removeLayerVideoAt

()

method

public final function removeLayerVideoAt(index:int):void

Remove instance of LayerVideo at index

Parameters

index:int — : index of the LayerVideo in order to find it in the stack.

removeManager

()

method

public final function removeManager(id:String):void

Remove Manager.

Parameters

id:String — : Name of the Manager in order to find it in the stack.

render

()

method

override protected function render():void

Called by RenderEngine during rendering.

resize

()

method

override protected function resize():void

Called by InteractiveContext during resizing.

setup

()

method

override public function setup():void

Setup the context. Must be overrided and called at first.

swapComponents

()

method

public final function swapComponents(comp1:FlashComponent, comp2:FlashComponent):void

Swap FlashComponents (z-order in stack).

Parameters

	`comp1:FlashComponent` — The index position of the first Component.

	`comp2:FlashComponent` — The index position of the second Component.

Mercredi Juin 19 2013, 03:25 AM +02:00

Artcustomer Framework 3.0.0.0 beta 'Limon'	All Packages \| All Classes \| Index \| Frames No Frames
FlashContext	Methods \| Events

Package	artcustomer.framework.context
Class	public class FlashContext
Inheritance	FlashContext BaseContext ServiceContext CrossPlatformInputsContext InteractiveContext EventContext Object

	Event		Summary	Defined By
		contextDestroy		BaseContext
		contextReset		BaseContext
		contextSetup		BaseContext
		displayFullScreen		InteractiveContext
		displayNormalScreen		InteractiveContext
		error		InteractiveContext
		frameworkError		InteractiveContext
		illegalError		InteractiveContext
		inputKeyFastRepeat		CrossPlatformInputsContext
		inputKeyRelease		CrossPlatformInputsContext
		inputKeyRepeat		CrossPlatformInputsContext
		inputMouseClick		CrossPlatformInputsContext
		inputMouseDoubleClick		CrossPlatformInputsContext
		inputMouseDown		CrossPlatformInputsContext
		inputMouseLeave		CrossPlatformInputsContext
		inputMouseMove		CrossPlatformInputsContext
		inputMouseOut		CrossPlatformInputsContext
		inputMouseOver		CrossPlatformInputsContext
		inputMouseRollOut		CrossPlatformInputsContext
		inputMouseRollOver		CrossPlatformInputsContext
		inputMouseUp		CrossPlatformInputsContext
		inputMouseWheelDown		CrossPlatformInputsContext
		inputMouseWheelUp		CrossPlatformInputsContext