mx.core.DesignLayer - Adobe® Flex® 4 Language Reference (Flex 4)

Package	mx.core
Class	public class DesignLayer
Inheritance	DesignLayer EventDispatcher Object
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

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		alpha : Number The alpha for this design layer instance, between 0.0 and 1.0.	DesignLayer
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		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
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object
		visible : Boolean The visibility for this design layer instance.	DesignLayer

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		DesignLayer() Constructor.	DesignLayer
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.	EventDispatcher
		addLayer(value:DesignLayer):void Adds a DesignLayer child to this layer.	DesignLayer
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	EventDispatcher
		getLayerAt(index:int):DesignLayer Returns the DesignLayer child at the specified index.	DesignLayer
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	EventDispatcher
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		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
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	EventDispatcher
		removeLayer(value:DesignLayer):void Removes a DesignLayer child from this layer.	DesignLayer
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		valueOf():Object Returns the primitive value of the specified object.	Object
		willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.	EventDispatcher

Events

Click for more information on events

Hide Inherited Events

Show Inherited Events

	Summary	Defined By
activate	[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.	EventDispatcher
deactivate	[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.	EventDispatcher
layerPropertyChange	Dispatched by the layer when either effectiveVisibility or effectiveAlpha changes.	DesignLayer

Property Detail

alpha

property

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

effectiveAlpha

property

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

effectiveVisibility

property

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

id

property

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

numLayers

property

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

parent

property

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

visible

property

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.

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.