Packageorg.springextensions.actionscript.stage
SVN browsingIStageProcessorRegistry.as
FisheyeIStageProcessorRegistry.as
Interfacepublic interface IStageProcessorRegistry
ImplementorsFlashStageProcessorRegistry, MXMLApplicationContext, XMLApplicationContext

Describes an object that manages a collection of IStageProcessor instances.


Documentation reference: the istageprocessor interface

Sample project: stagewiring (source)

Public Properties
 PropertyDefined by
  enabled : Boolean
Determines if the current IStageProcessorRegistry is enabled.
IStageProcessorRegistry
  initialized : Boolean
[read-only] True if the current IStageProcessorRegistry has been initialized.
IStageProcessorRegistry
  numRegistrations : uint
[read-only] The number of IObjectSelector registrations.
IStageProcessorRegistry
  stage : Stage
[read-only]
IStageProcessorRegistry
Public Methods
 MethodDefined by
  
clear():void
Clears the all processor and context registrations in the current IStageProcessorRegistry
IStageProcessorRegistry
  
getAllObjectSelectors():Array
Retrieves a list of all the IObjectSelectors that have been registered with the current IStageProcessorRegistry.
IStageProcessorRegistry
  
getAllStageProcessors():Array
Retrieves a list of all the IStageProcessors that have been registered with the current IStageProcessorRegistry.
IStageProcessorRegistry
  
getObjectSelectorForStageProcessor(stageProcessor:IStageProcessor):IObjectSelector
Retrieves the IObjectSelector instance that is associated with the specified IStageProcessor instance.
IStageProcessorRegistry
  
getStageProcessorByName(name:String):Array
Retrieves a list of all the IStageProcessors with the specified name.
IStageProcessorRegistry
  
getStageProcessorsByType(type:Class):Array
Retrieves a list of all the IStageProcessors of the specified Class.
IStageProcessorRegistry
  
initialize():void
Performs initialization of the IStageProcessorRegistry.
IStageProcessorRegistry
  
processStage(startComponent:DisplayObject = null):void
Recursively loops through the stage displaylist and processes every object therein.
IStageProcessorRegistry
  
registerContext(parentDocument:Object, applicationContext:IApplicationContext):void
Registers the specified IApplicationContext with the current IStageProcessorRegistry by associating it with the specified parentDocument.
IStageProcessorRegistry
  
registerStageProcessor(name:String, stageProcessor:IStageProcessor, objectSelector:IObjectSelector):void
Adds the specified IStageProcessor instance to the collection.
IStageProcessorRegistry
  
unregisterContext(parentDocument:Object, applicationContext:IApplicationContext):void
Unregisters the specified IApplicationContext with the current IStageProcessorRegistry by removing its association it with the specified parentDocument.
IStageProcessorRegistry
  
unregisterStageProcessor(name:String, document:Object):void
Removes the IStageProcessor with the specified name.
IStageProcessorRegistry
Property detail
enabledproperty
enabled:Boolean  [read-write]

Determines if the current IStageProcessorRegistry is enabled.

Implementation
    public function get enabled():Boolean
    public function set enabled(value:Boolean):void
initializedproperty 
initialized:Boolean  [read-only]

True if the current IStageProcessorRegistry has been initialized.

Implementation
    public function get initialized():Boolean
numRegistrationsproperty 
numRegistrations:uint  [read-only]

The number of IObjectSelector registrations.

Implementation
    public function get numRegistrations():uint
stageproperty 
stage:Stage  [read-only]Implementation
    public function get stage():Stage
Method detail
clear()method
public function clear():void

Clears the all processor and context registrations in the current IStageProcessorRegistry

getAllObjectSelectors()method 
public function getAllObjectSelectors():Array

Retrieves a list of all the IObjectSelectors that have been registered with the current IStageProcessorRegistry.

Returns
Array — An Array of IObjectSelectors.

See also

IObjectSelector
getAllStageProcessors()method 
public function getAllStageProcessors():Array

Retrieves a list of all the IStageProcessors that have been registered with the current IStageProcessorRegistry.

Returns
Array — An Array of IStageProcessors.

See also

IStageProcessor
getObjectSelectorForStageProcessor()method 
public function getObjectSelectorForStageProcessor(stageProcessor:IStageProcessor):IObjectSelector

Retrieves the IObjectSelector instance that is associated with the specified IStageProcessor instance.

Parameters
stageProcessor:IStageProcessor — The specified IStageProcessor.

Returns
IObjectSelector — The IObjectSelector instance that is associated with the specified IStageProcessor, or null if none was found.
getStageProcessorByName()method 
public function getStageProcessorByName(name:String):Array

Retrieves a list of all the IStageProcessors with the specified name.

Parameters
name:String — The specified name

Returns
Array — An Array of IStageProcessors, or null if none was found.
getStageProcessorsByType()method 
public function getStageProcessorsByType(type:Class):Array

Retrieves a list of all the IStageProcessors of the specified Class.

Parameters
type:Class — the specified Class.

Returns
Array — An Array of IStageProcessors.
initialize()method 
public function initialize():void

Performs initialization of the IStageProcessorRegistry.

processStage()method 
public function processStage(startComponent:DisplayObject = null):void

Recursively loops through the stage displaylist and processes every object therein.

Parameters
startComponent:DisplayObject (default = null) — Optionally a start component can be specified that will be used as the root for recursion.
registerContext()method 
public function registerContext(parentDocument:Object, applicationContext:IApplicationContext):void

Registers the specified IApplicationContext with the current IStageProcessorRegistry by associating it with the specified parentDocument.

Parameters
parentDocument:Object — The specified parentDocument, if this is not a Module the specified IApplicationContext will be associated with the current Application.
 
applicationContext:IApplicationContext — The specified IApplicationContext.
registerStageProcessor()method 
public function registerStageProcessor(name:String, stageProcessor:IStageProcessor, objectSelector:IObjectSelector):void

Adds the specified IStageProcessor instance to the collection.

Parameters
name:String — The name of the IStageProcessor, if an instance by that name and with the same document property already exists in the collection it will be replaced.
 
stageProcessor:IStageProcessor — The specified IStageProcessor instance.
 
objectSelector:IObjectSelector
unregisterContext()method 
public function unregisterContext(parentDocument:Object, applicationContext:IApplicationContext):void

Unregisters the specified IApplicationContext with the current IStageProcessorRegistry by removing its association it with the specified parentDocument.

Parameters
parentDocument:Object — The specified parentDocument.
 
applicationContext:IApplicationContext — The specified IApplicationContext.
unregisterStageProcessor()method 
public function unregisterStageProcessor(name:String, document:Object):void

Removes the IStageProcessor with the specified name.

Parameters
name:String — The name of the IStageProcessor that will be removed
 
document:Object



Copyright 2007-2010 Spring Actionscript.