ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
com.adobe.mosaic.om.interfaces 

ILayout  - AS3 ADEP Composite Application

Packagecom.adobe.mosaic.om.interfaces
Interfacepublic interface ILayout

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 9.5
Runtime Versions: AIR 2.6, Flash Player 10.2

The ILayout interface provides the interface for describing the layout of a container.



Public Properties
 PropertyDefined By
  name : String
[read-only] The name of the layout.
ILayout
  uniqueID : String
[read-only] The generated, unique identifier of the node.
ILayout
Public Methods
 MethodDefined By
  
Retrieves the value of the specified attribute key from the Layout object.
ILayout
  
Retrieves an array of objects.
ILayout
  
Allows the setting of any attribute key/value pair on the layout object.
ILayout
Property Detail

name

property
name:String  [read-only]

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 9.5
Runtime Versions: AIR 2.6, Flash Player 10.2

The name of the layout. Can be a short name for a built-in layout or a fully-qualified class name.



Implementation
    public function get name():String

uniqueID

property 
uniqueID:String  [read-only]

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 9.5
Runtime Versions: AIR 2.6, Flash Player 10.2

The generated, unique identifier of the node. The unique identifier is only constant during a single run of the application.



Implementation
    public function get uniqueID():String
Method Detail

getAttribute

()method
public function getAttribute(key:String):String

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
Runtime Versions: AIR 2.6, Flash Player 10.2

Retrieves the value of the specified attribute key from the Layout object.

Parameters

key:String — Specifies any attribute that is used by the Layout.

Returns
String — The value associated with the key. Null if the attribute is not found.

getAttributePairs

()method 
public function getAttributePairs():Array

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
Runtime Versions: AIR 2.6, Flash Player 10.2

Retrieves an array of objects. The array contains a name and value formatted as: name:String value:* which represents the attributes of a given layout and their values. These values allows iteration of the attributes on a layout.

Returns
Array — An array of objects. For example, when the value is a string value: {name:String, value:String}

setAttribute

()method 
public function setAttribute(key:String, value:String):void

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
Runtime Versions: AIR 2.6, Flash Player 10.2

Allows the setting of any attribute key/value pair on the layout object.

Parameters

key:String — Specifies any attribute that is used by the Layout as a property.
 
value:String — Specifies any value that is used by the Layout, associate with the key provided.