Packagevegas.managers
Classpublic class ProtectorManager
InheritanceProtectorManager Inheritance Object

This manager control a Protector display.

Example :

     import flash.display.StageAlign ;
     import flash.display.StageScaleMode ;
     
     import vegas.display.Protector ;
     import vegas.managers.ProtectorManager ;
     
     import graphics.FillStyle ;
     
     stage.align     = StageAlign.TOP_LEFT ;
     stage.scaleMode = StageScaleMode.NO_SCALE ;
     
     var protector:Protector      = new Protector() ;
     
     protector.cursor = new Cursor() ;
     protector.fill   = new FillStyle( 0xD97BD0 , 0.2 ) ;
     
     var manager:ProtectorManager = new ProtectorManager( protector , this ) ;
     
     manager.enabled = true ;
     
     var onKeyDown:Function = function(e:KeyboardEvent):void
     {
         manager.enabled = ! manager.enabled ;
     }
     
     stage.addEventListener( KeyboardEvent.KEY_DOWN , onKeyDown ) ;
     



Public Properties
 PropertyDefined By
  depth : Number
The optional depth to insert or remove the protector.
ProtectorManager
  enabled : Boolean
Determinates if the protector display is enabled or not.
ProtectorManager
  protector : Protector
The protector reference of the manager.
ProtectorManager
  root : DisplayObjectContainer
The root reference of the manager.
ProtectorManager
Public Methods
 MethodDefined By
  
ProtectorManager(protector:Protector = null, root:DisplayObjectContainer = null, cursorPolicy:Boolean = true)
Creates a new ProtectorManager instance.
ProtectorManager
  
fixEnabled():void
Resets the enabled counter and clean the manager.
ProtectorManager
Protected Methods
 MethodDefined By
  
addedToStage(e:Event):void
Invoked when the protector register in this manager is added to the stage.
ProtectorManager
  
removedFromStage(e:Event):void
Invoked when the protector register in this manager is removed from the stage.
ProtectorManager
Property Detail
depthproperty
public var depth:Number

The optional depth to insert or remove the protector.

enabledproperty 
enabled:Boolean

Determinates if the protector display is enabled or not.


Implementation
    public function get enabled():Boolean
    public function set enabled(value:Boolean):void
protectorproperty 
protector:Protector

The protector reference of the manager.


Implementation
    public function get protector():Protector
    public function set protector(value:Protector):void
rootproperty 
public var root:DisplayObjectContainer

The root reference of the manager.

Constructor Detail
ProtectorManager()Constructor
public function ProtectorManager(protector:Protector = null, root:DisplayObjectContainer = null, cursorPolicy:Boolean = true)

Creates a new ProtectorManager instance.

Parameters
protector:Protector (default = null) — The protector reference of this manager.
 
root:DisplayObjectContainer (default = null) — The display list root reference to insert the protector when the protector manager is enabled.
 
cursorPolicy:Boolean (default = true) — The policy of the cursor in the protector (visible or not).
Method Detail
addedToStage()method
protected function addedToStage(e:Event):void

Invoked when the protector register in this manager is added to the stage.

Parameters

e:Event

fixEnabled()method 
public function fixEnabled():void

Resets the enabled counter and clean the manager.

removedFromStage()method 
protected function removedFromStage(e:Event):void

Invoked when the protector register in this manager is removed from the stage.

Parameters

e:Event