Packagemx.core
Classpublic class DesignLayer
InheritanceDesignLayer Inheritance flash.events.EventDispatcher
Implements IMXMLObject

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

The DesignLayer class represents a visibility group that can be associated with one or more IVisualElement instances at runtime. DesignLayer instances support a visible and alpha property that when set will propagate to the associated layer children.



Public Properties
 PropertyDefined By
  alpha : Number
The alpha for this design layer instance, between 0.0 and 1.0.
DesignLayer
  effectiveAlpha : Number
[read-only] Property that returns the effective alpha, between 0.0 and 1.0, of this design layer.
DesignLayer
  effectiveVisibility : Boolean
[read-only] Returns the effective visibility of this design layer.
DesignLayer
  id : String
ID of the layer component.
DesignLayer
  numLayers : int
[read-only] The number of DesignLayer children directly parented by this layer.
DesignLayer
  parent : DesignLayer
[read-only] This layer's parent layer.
DesignLayer
  visible : Boolean
The visibility for this design layer instance.
DesignLayer
Public Methods
 MethodDefined By
  
Constructor.
DesignLayer
  
addLayer(value:DesignLayer):void
Adds a DesignLayer child to this layer.
DesignLayer
  
Returns the DesignLayer child at the specified index.
DesignLayer
  
initialized(document:Object, id:String):void
Called after the implementing object has been created and all component properties specified on the MXML tag have been initialized.
DesignLayer
  
Removes a DesignLayer child from this layer.
DesignLayer
Events
 Event Summary Defined By
  Dispatched by the layer when either effectiveVisibility or effectiveAlpha changes.DesignLayer
Property Detail
alphaproperty
alpha:Number

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

The alpha for this design layer instance, between 0.0 and 1.0.

When updated, the appropriate change event for effectiveAlpha will be dispatched to all layerPropertyChange listeners for this layer, as well as those of affected descendant layers if any.

The default value is 1.0.


Implementation
    public function get alpha():Number
    public function set alpha(value:Number):void
effectiveAlphaproperty 
effectiveAlpha:Number  [read-only]

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

Property that returns the effective alpha, between 0.0 and 1.0, of this design layer. This value multiplies the alpha of this layer by the alpha of any ancestor layers.

The default value is 1.0.


Implementation
    public function get effectiveAlpha():Number
effectiveVisibilityproperty 
effectiveVisibility:Boolean  [read-only]

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

Returns the effective visibility of this design layer. This value takes into consideration the visibility of this layer and any ancestor layers.

The default value is true.


Implementation
    public function get effectiveVisibility():Boolean
idproperty 
id:String

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

ID of the layer component. This value becomes the instance name of the layer and as such, should not contain any white space or special characters.


Implementation
    public function get id():String
    public function set id(value:String):void
numLayersproperty 
numLayers:int  [read-only]

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

The number of DesignLayer children directly parented by this layer.

The default value is 0.


Implementation
    public function get numLayers():int
parentproperty 
parent:DesignLayer  [read-only]

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

This layer's parent layer.

The default value is null.


Implementation
    public function get parent():DesignLayer
visibleproperty 
visible:Boolean

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

The visibility for this design layer instance.

When updated, the appropriate change event for effectiveVisibility will be dispatched to all layerPropertyChange listeners for this layer, as well as those of affected descendant layers if any.

The default value is true.


Implementation
    public function get visible():Boolean
    public function set visible(value:Boolean):void
Constructor Detail
DesignLayer()Constructor
public function DesignLayer()

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

Constructor.

Method Detail
addLayer()method
public function addLayer(value:DesignLayer):void

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

Adds a DesignLayer child to this layer.

Parameters

value:DesignLayer — The layer child to add.

getLayerAt()method 
public function getLayerAt(index:int):DesignLayer

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

Returns the DesignLayer child at the specified index.

Note that the order of DesignLayer children is insignificant. The getLayerAt method is meant to be used in conjunction with numLayers to iterate over the child list.

Parameters

index:int — The 0-based index of a DesignLayer child.

Returns
DesignLayer — The specified DesignLayer child if index is between 0 and numLayers - 1. Returns null if the index is invalid.

See also

numLayers
initialized()method 
public function initialized(document:Object, id:String):void

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

Called after the implementing object has been created and all component properties specified on the MXML tag have been initialized.

Parameters

document:Object — The MXML document that created this object.
 
id:String — The identifier used by document to refer to this object. If the object is a deep property on document, id is null.

removeLayer()method 
public function removeLayer(value:DesignLayer):void

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

Removes a DesignLayer child from this layer.

Parameters

value:DesignLayer — The layer child to remove.

Event Detail
layerPropertyChange Event
Event Object Type: mx.events.PropertyChangeEvent

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

Dispatched by the layer when either effectiveVisibility or effectiveAlpha changes.