com.adobe.icc.editors.model

# ContainerLayoutAssignmentModel - AS3 Asset Composer

Package | com.adobe.icc.editors.model
Class | public class ContainerLayoutAssignmentModel
Inheritance | ContainerLayoutAssignmentModel EventDispatcher Object

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10

Runtime Versions: | AIR (unsupported), Flash Player 10.2

The ContainerLayoutAssignmentModel class represents the domain object for the assets of type ContainerLayoutAssignment. Domain objects can be leveraged to build presentation on top of them. They ease the process of coding views by abstracting all the service calls and maintaining meaningful states.

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | constructor : Object A reference to the class object or constructor function for a given object instance. | Object
|  | containerLayout : FragmentLayoutModel The domain object of the fragmentLayout associated with this containerLayoutAssignment. | ContainerLayoutAssignmentModel
|  | fieldAssignments : IList The list of field assignments of this ContainerLayoutAssignment. | ContainerLayoutAssignmentModel
|  | letterModel : LetterModel The domain object of the letter that this assignment belongs to | ContainerLayoutAssignmentModel
|  | path : String Represents the path of container layout assignment relative to base layout. | ContainerLayoutAssignmentModel
|  | targetAreaAssignments : IList The list of target area assignments in this ContainerLayoutAssignment. | ContainerLayoutAssignmentModel
|  | vo : ContainerLayoutAssignment The instance of ContainerLayoutAssignment being currently used. | ContainerLayoutAssignmentModel

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | ContainerLayoutAssignmentModel(vo:ContainerLayoutAssignment = null) Constructor. | ContainerLayoutAssignmentModel
|  | 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
|  | createFromVO(containerLayoutAssignmentVO:ContainerLayoutAssignment):ContainerLayoutAssignmentModel [static] Creates the domain object from the corresponding value object. | ContainerLayoutAssignmentModel
|  | dispatchEvent(event:Event):Boolean Dispatches an event into the event flow. | EventDispatcher
|  | getTargetAreaAssignment(area:*):com.adobe.icc.editors.model:TargetAreaAssignmentModel Returns the target area assignment domain object for the passed target area. | ContainerLayoutAssignmentModel
|  | 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
|  | 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
|  | onFieldAssignmentChange(e:Event):void Dispataches an event when the Field's assignment is changed. | ContainerLayoutAssignmentModel
|  | onModuleAssignmentChange(e:DynamicEvent):void Dispatches an event when module assignment is changed in the working target area. | ContainerLayoutAssignmentModel
|  | propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable. | Object
|  | removeAssignmentsFromContainerLayout():void Function called when assignment from the container layout is removed | ContainerLayoutAssignmentModel
|  | removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object. | EventDispatcher
|  | setFragmentLayout(fragmentLayout:FragmentLayoutModel, resetAssignments:Boolean = true):void Sets the fragmentLayout for this containerLayoutAssignment. | ContainerLayoutAssignmentModel
|  | 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

| Event | 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
|  | fieldAssignmentsChange | Dispatched when a field assignment is changed. | ContainerLayoutAssignmentModel
|  | moduleAssignmentAdd | Dispatched when a module assignment is added to any of the target area assignments. | ContainerLayoutAssignmentModel
|  | moduleAssignmentRemove | Dispatched when a module assignment is removed from any of the target area assignments. | ContainerLayoutAssignmentModel

Property Detail

### containerLayout

property

`containerLayout:FragmentLayoutModel`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10

Runtime Versions: | AIR (unsupported), Flash Player 10.2

The domain object of the fragmentLayout associated with this containerLayoutAssignment.

This property can be used as the source for data binding. When this property is modified, it dispatches the `propertyChange` event.

Implementation
`public function get containerLayout():FragmentLayoutModel`
`public function set containerLayout(value:FragmentLayoutModel):void`

### fieldAssignments

property

`fieldAssignments:IList`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10

Runtime Versions: | AIR (unsupported), Flash Player 10.2

The list of field assignments of this ContainerLayoutAssignment.

This property can be used as the source for data binding. When this property is modified, it dispatches the `propertyChange` event.

Implementation
`public function get fieldAssignments():IList`
`public function set fieldAssignments(value:IList):void`

### letterModel

property

`letterModel:LetterModel`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10

Runtime Versions: | AIR (unsupported), Flash Player 10.2

The domain object of the letter that this assignment belongs to

Implementation
`public function get letterModel():LetterModel`
`public function set letterModel(value:LetterModel):void`

### path

property

`path:String`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10.0

Runtime Versions: | AIR (unsupported), Flash Player 10.2

Represents the path of container layout assignment relative to base layout.

This property can be used as the source for data binding. When this property is modified, it dispatches the `propertyChange` event.

Implementation
`public function get path():String`
`public function set path(value:String):void`

### targetAreaAssignments

property

`targetAreaAssignments:IList`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10

Runtime Versions: | AIR (unsupported), Flash Player 10.2

The list of target area assignments in this ContainerLayoutAssignment.

This property can be used as the source for data binding. When this property is modified, it dispatches the `propertyChange` event.

Implementation
`public function get targetAreaAssignments():IList`
`public function set targetAreaAssignments(value:IList):void`

### vo

property

`vo:ContainerLayoutAssignment`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10

Runtime Versions: | AIR (unsupported), Flash Player 10.2

The instance of ContainerLayoutAssignment being currently used.

Implementation
`public function get vo():ContainerLayoutAssignment`
`public function set vo(value:ContainerLayoutAssignment):void`
Constructor Detail

### ContainerLayoutAssignmentModel

()
Constructor

`public function ContainerLayoutAssignmentModel(vo:ContainerLayoutAssignment = null)`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10.0

Runtime Versions: | AIR (unsupported), Flash Player 10.2

Constructor.

Parameters

| `vo:ContainerLayoutAssignment` (default = `null`)`` — The ContainerLayoutAssignment object associated with this ContainerLayoutAssignmentModel instance

Method Detail

### createFromVO

()
method

`public static function createFromVO(containerLayoutAssignmentVO:ContainerLayoutAssignment):ContainerLayoutAssignmentModel`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10.0

Runtime Versions: | AIR (unsupported), Flash Player 10.2

Creates the domain object from the corresponding value object.

Value Objects are pure data entities mostly acting as parameters to the server apis. Domain objects are build atop to provide more meaningful business data and behavior thereby enabling faster and convenient UI view development.

Parameters

| `containerLayoutAssignmentVO:ContainerLayoutAssignment` — The value object of the type ContainerLayoutAssignment

Returns

| `ContainerLayoutAssignmentModel` — The ContainerLayoutAssignment domain object corresponding the passed containerLayoutAssignment value object.

### getTargetAreaAssignment

()
method

`public function getTargetAreaAssignment(area:*):com.adobe.icc.editors.model:TargetAreaAssignmentModel`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10

Runtime Versions: | AIR (unsupported), Flash Player 10.2

Returns the target area assignment domain object for the passed target area.

Parameters

| `area:*` — The target area

Returns

| `com.adobe.icc.editors.model:TargetAreaAssignmentModel` — The target area assignment domain object

### onFieldAssignmentChange

()
method

`public function onFieldAssignmentChange(e:Event):void`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10.0

Runtime Versions: | AIR (unsupported), Flash Player 10.2

Dispataches an event when the Field's assignment is changed.

Parameters

| `e:Event` — The event dispatched.

### onModuleAssignmentChange

()
method

`public function onModuleAssignmentChange(e:DynamicEvent):void`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10.0

Runtime Versions: | AIR (unsupported), Flash Player 10.2

Dispatches an event when module assignment is changed in the working target area.

Parameters

| `e:DynamicEvent` — The DynamicEvent dispatched.

### removeAssignmentsFromContainerLayout

()
method

`public function removeAssignmentsFromContainerLayout():void`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10.0

Runtime Versions: | AIR (unsupported), Flash Player 10.2

Function called when assignment from the container layout is removed

### setFragmentLayout

()
method

`public function setFragmentLayout(fragmentLayout:FragmentLayoutModel, resetAssignments:Boolean = true):void`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10.0

Runtime Versions: | AIR (unsupported), Flash Player 10.2

Sets the fragmentLayout for this containerLayoutAssignment.

Parameters

| `fragmentLayout:FragmentLayoutModel` — The domain object of the fragmentLayout that needs to be associated with this ContainerLayoutAssignment
| `resetAssignments:Boolean` (default = `true`)`` — Whether the various assignment lists should be reset or not.

Event Detail

### fieldAssignmentsChange

Event

Event Object Type: `mx.events.DynamicEvent`
property DynamicEvent.type = `mx.events.DynamicEvent`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10

Runtime Versions: | AIR (unsupported), Flash Player 10.2

Dispatched when a field assignment is changed.

### moduleAssignmentAdd

Event

Event Object Type: `flash.events.Event`
property Event.type = `flash.events.Event`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10

Runtime Versions: | AIR (unsupported), Flash Player 10.2

Dispatched when a module assignment is added to any of the target area assignments.

### moduleAssignmentRemove

Event

Event Object Type: `flash.events.Event`
property Event.type = `flash.events.Event`

Language Version: | ActionScript 3.0

Product Version: | Asset Composer Building Block 10

Runtime Versions: | AIR (unsupported), Flash Player 10.2

Dispatched when a module assignment is removed from any of the target area assignments.

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00