Packageorg.springextensions.actionscript.stage
SVN browsingStageProcessorRegistration.as
FisheyeStageProcessorRegistration.as
Classpublic class StageProcessorRegistration
ImplementsIObjectSelectorAware

Manages an IObjectSelector and its associated IStageProcessor instances.

See also

IObjectSelector
IStageProcessor


Sample project: stagewiring (source)


Public Properties
 PropertyDefined by
  names : Array
[read-only] An Array of Strings that represent the names of the associated IStageProcessor instances.
StageProcessorRegistration
  objectSelector : IObjectSelector
The IObjectSelector that determines if the associated IStageProcessor instances will be invoked or not.
StageProcessorRegistration
  processors : Dictionary
[read-only] A Dictionary lookup for the associated IStageProcessor instances.
StageProcessorRegistration
Public Methods
 MethodDefined by
  
StageProcessorRegistration(name:String = null, stageProcessor:IStageProcessor = null, objectSelector:IObjectSelector = null)
Creates a new StageProcessorRegistration instance.
StageProcessorRegistration
  
addStageProcessor(name:String, stageProcessor:IStageProcessor, objectSelector:IObjectSelector, overrideSelector:Boolean = false):void
Adds or override the IStageProcessor for the specified name.
StageProcessorRegistration
  
containsProcessor(stageProcessor:IStageProcessor):Boolean
Returns true if the current StageProcessorRegistration contains the specified IStageProcessor instance.
StageProcessorRegistration
  
StageProcessorRegistration
  
getProcessorsByDocument(document:Object):Array
StageProcessorRegistration
  
getProcessorsByName(name:String):Array
Returns the IStageProcessors for the specified name, or null if the name doesn't exist in the current StageProcessorRegistration instance.
StageProcessorRegistration
  
getProcessorsByType(type:Class):Array
Returns an Array of IStageProcessor instances of the specified Class
StageProcessorRegistration
  
hasProcessorWithName(name:String, stageProcessor:IStageProcessor):Boolean
Returns true if the current StageProcessorRegistration contains an IStageProcessor instance with the same name and document property as the specified IStageProcessor
StageProcessorRegistration
  
StageProcessorRegistration
  
removeStageProcessorByName(name:String, document:Object):void
Removes the IStageProcessor with the specified name.
StageProcessorRegistration
Protected Methods
 MethodDefined by
  
StageProcessorRegistration
  
StageProcessorRegistration
Property detail
namesproperty
names:Array  [read-only]

An Array of Strings that represent the names of the associated IStageProcessor instances.

This list also determines the order in which the IStageProcessor instances will be invoked.

Implementation
    public function get names():Array
objectSelectorproperty 
objectSelector:IObjectSelector  [read-write]

The IObjectSelector that determines if the associated IStageProcessor instances will be invoked or not.

Implementation
    public function get objectSelector():IObjectSelector
    public function set objectSelector(value:IObjectSelector):void
processorsproperty 
processors:Dictionary  [read-only]

A Dictionary lookup for the associated IStageProcessor instances.

Implementation
    public function get processors():Dictionary
Constructor detail
StageProcessorRegistration()constructor
public function StageProcessorRegistration(name:String = null, stageProcessor:IStageProcessor = null, objectSelector:IObjectSelector = null)

Creates a new StageProcessorRegistration instance.

Parameters
name:String (default = null) — Optional name for an initial IStageProcessor
 
stageProcessor:IStageProcessor (default = null) — Optional initial IStageProcessor that will be added.
 
objectSelector:IObjectSelector (default = null)
Method detail
addProcessorToDocumentLookup()method
protected function addProcessorToDocumentLookup(stageProcessor:IStageProcessor):voidParameters
stageProcessor:IStageProcessor
addStageProcessor()method 
public function addStageProcessor(name:String, stageProcessor:IStageProcessor, objectSelector:IObjectSelector, overrideSelector:Boolean = false):void

Adds or override the IStageProcessor for the specified name. If the objectSelector property is null the objectSelector of the specified IStageProcessor will be assigned. Unless the overrideSelector is set to true, in which case the objectSelector property assignement is forced.

Parameters
name:String — The name associated with the specified IStageProcessor.
 
stageProcessor:IStageProcessor — The IStageProcessor that will be added.
 
objectSelector:IObjectSelector — If true the objectSelector property will be assigned regardless whether its null or not.
 
overrideSelector:Boolean (default = false)
containsProcessor()method 
public function containsProcessor(stageProcessor:IStageProcessor):Boolean

Returns true if the current StageProcessorRegistration contains the specified IStageProcessor instance.

Parameters
stageProcessor:IStageProcessor — The specified IStageProcessor instance.

Returns
Boolean
getAllProcessors()method 
public function getAllProcessors():Array

Returns
Array
getProcessorsByDocument()method 
public function getProcessorsByDocument(document:Object):ArrayParameters
document:Object

Returns
Array
getProcessorsByName()method 
public function getProcessorsByName(name:String):Array

Returns the IStageProcessors for the specified name, or null if the name doesn't exist in the current StageProcessorRegistration instance.

Parameters
name:String — The specifed name

Returns
Array — An Array of IStageProcessors for the specified name, or null if the name doesn't exist.
getProcessorsByType()method 
public function getProcessorsByType(type:Class):Array

Returns an Array of IStageProcessor instances of the specified Class

Parameters
type:Class — The specified Class

Returns
Array — An Array of IStageProcessor instances, or null if no instances of the specified Class exist.
hasProcessorWithName()method 
public function hasProcessorWithName(name:String, stageProcessor:IStageProcessor):Boolean

Returns true if the current StageProcessorRegistration contains an IStageProcessor instance with the same name and document property as the specified IStageProcessor

Parameters
name:String
 
stageProcessor:IStageProcessor

Returns
Boolean
removeProcessorFromDocumentLookup()method 
protected function removeProcessorFromDocumentLookup(stageProcessor:IStageProcessor):voidParameters
stageProcessor:IStageProcessor
removeStageProcessor()method 
public function removeStageProcessor(stageProcessor:IStageProcessor):voidParameters
stageProcessor:IStageProcessor
removeStageProcessorByName()method 
public function removeStageProcessorByName(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