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

TargetAreaAssignmentModel  - AS3 Asset Composer
Packagecom.adobe.icc.editors.model
Classpublic class TargetAreaAssignmentModel
InheritanceTargetAreaAssignmentModel Inheritance EventDispatcher Inheritance Object

Language Version: ActionScript 3.0
Product Version: Asset Composer Building Block 9.5
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

The domain class representing the target area assignments in Letters.

Related API Elements

com.adobe.icc.editors.model.LetterModel.targetAreaAssignments

Public Properties
 PropertyDefined By
  allowFreeText : Boolean
Flag to indicate if this assignment allows adding free text.
TargetAreaAssignmentModel
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  containerLayoutAssignment : ContainerLayoutAssignmentModel
Container layout assignments within this target area assignment.
TargetAreaAssignmentModel
  fragmentName : String
[read-only] Fetches the name of the fragment associated with the target area.
TargetAreaAssignmentModel
  isTableTargetArea : Boolean
The table name property.
TargetAreaAssignmentModel
  letterModel : LetterModel
The domain object of the letter that this assignment belongs to
TargetAreaAssignmentModel
  moduleAssignments : IList
The list of module assignments within this target area assignment.
TargetAreaAssignmentModel
  ordered : Boolean
Flag to indicate if this assignment is ordered.
TargetAreaAssignmentModel
  path : String
Represents the path of target area relative to base layout.
TargetAreaAssignmentModel
  position : int
[read-only] Fetches the position of the target area with respect to other target areas.
TargetAreaAssignmentModel
  rowName : String
The row name property.
TargetAreaAssignmentModel
  tableName : String
The table name property.
TargetAreaAssignmentModel
  targetArea : com.adobe.icc.vo:TargetArea
The target area associated with this assignment.
TargetAreaAssignmentModel
  vo : com.adobe.icc.vo:TargetAreaAssignment
The underlying target area assignment value object.
TargetAreaAssignmentModel
Public Methods
 MethodDefined By
 Inherited
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
  
addModuleAssignment(value:ModuleAssignmentModel, addAt:int = -1):void
Adds a module assignment to this target area assignment object.
TargetAreaAssignmentModel
  
createFromVO(vo:com.adobe.icc.vo:TargetAreaAssignment):com.adobe.icc.editors.model:TargetAreaAssignmentModel
[static] Constructs the domain object from its value object counterpart.
TargetAreaAssignmentModel
  
createFromVOAndPath(vo:com.adobe.icc.vo:TargetAreaAssignment, path:String):com.adobe.icc.editors.model:TargetAreaAssignmentModel
[static] Constructs the domain object from its value object counterpart.
TargetAreaAssignmentModel
 Inherited
dispatchEvent(event:Event):Boolean
Dispatches an event into the event flow.
EventDispatcher
 Inherited
hasEventListener(type:String):Boolean
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
EventDispatcher
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
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
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
EventDispatcher
  
removeModuleAssignment(value:ModuleAssignmentModel):int
Removes a module assignment from this target area assignment.
TargetAreaAssignmentModel
  
setContainerLayoutAssignment(value:ContainerLayoutAssignmentModel):void
Adds a container layout assignment to this target area assignment object.
TargetAreaAssignmentModel
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
toLocaleString():String
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
toString():String
Returns the string representation of the specified object.
Object
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
 Inherited
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
 Event Summary Defined By
 Inherited
activate
[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.EventDispatcher
  
containerLayoutAssignmentChange
The event dispatched on the container layout assignment change.TargetAreaAssignmentModel
 Inherited
deactivate
[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.EventDispatcher
  
fieldAssignmentsChange
The event dispatched when the Field's assignment is changed.TargetAreaAssignmentModel
  
moduleAssignmentAdd
Dispatched when a module assignment is added to any of the target area assignments.TargetAreaAssignmentModel
  
moduleAssignmentRemove
Dispatched when a module assignment is removed from any of the target area assignments.TargetAreaAssignmentModel
Property Detail

allowFreeText

property
allowFreeText:Boolean

Language Version: ActionScript 3.0
Product Version: Asset Composer Building Block 10
Runtime Versions: AIR (unsupported), Flash Player 10.2

Flag to indicate if this assignment allows adding free text.

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



Implementation
    public function get allowFreeText():Boolean
    public function set allowFreeText(value:Boolean):void

containerLayoutAssignment

property 
containerLayoutAssignment:ContainerLayoutAssignmentModel

Language Version: ActionScript 3.0
Product Version: Asset Composer Building Block 10
Runtime Versions: AIR (unsupported), Flash Player 10.2

Container layout assignments within this target area assignment. Container layout assignment must not be set directly. Instead, the method setContainerLayoutAssignment() and removeContainerLayoutAssignment() should be used.

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



Implementation
    public function get containerLayoutAssignment():ContainerLayoutAssignmentModel
    public function set containerLayoutAssignment(value:ContainerLayoutAssignmentModel):void

fragmentName

property 
fragmentName:String  [read-only]

Language Version: ActionScript 3.0
Product Version: Asset Composer Building Block 10
Runtime Versions: AIR (unsupported), Flash Player 10.2

Fetches the name of the fragment associated with the target area.

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



Implementation
    public function get fragmentName():String

isTableTargetArea

property 
isTableTargetArea:Boolean

Language Version: ActionScript 3.0
Product Version: Asset Composer Building Block 10
Runtime Versions: AIR (unsupported), Flash Player 10.2

The table name property.

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



Implementation
    public function get isTableTargetArea():Boolean
    public function set isTableTargetArea(value:Boolean):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

moduleAssignments

property 
moduleAssignments:IList

Language Version: ActionScript 3.0
Product Version: Asset Composer Building Block 9.5
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

The list of module assignments within this target area assignment. Module assignments must not be added to this list directly. Instead, the methods addModuleAssignment() and removeModuleAssignment() should be used.

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



Implementation
    public function get moduleAssignments():IList
    public function set moduleAssignments(value:IList):void

ordered

property 
ordered:Boolean

Language Version: ActionScript 3.0
Product Version: Asset Composer Building Block 9.5
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

Flag to indicate if this assignment is ordered.

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



Implementation
    public function get ordered():Boolean
    public function set ordered(value:Boolean):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 target area 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

position

property 
position:int  [read-only]

Language Version: ActionScript 3.0
Product Version: Asset Composer Building Block 10
Runtime Versions: AIR (unsupported), Flash Player 10.2

Fetches the position of the target area with respect to other target areas.



Implementation
    public function get position():int

rowName

property 
rowName:String

Language Version: ActionScript 3.0
Product Version: Asset Composer Building Block 10
Runtime Versions: AIR (unsupported), Flash Player 10.2

The row name property.

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



Implementation
    public function get rowName():String
    public function set rowName(value:String):void

tableName

property 
tableName:String

Language Version: ActionScript 3.0
Product Version: Asset Composer Building Block 10
Runtime Versions: AIR (unsupported), Flash Player 10.2

The table name property.

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



Implementation
    public function get tableName():String
    public function set tableName(value:String):void

targetArea

property 
targetArea:com.adobe.icc.vo:TargetArea

Language Version: ActionScript 3.0
Product Version: Asset Composer Building Block 9.5
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

The target area associated with this assignment.



Implementation
    public function get targetArea():com.adobe.icc.vo:TargetArea
    public function set targetArea(value:com.adobe.icc.vo:TargetArea):void

vo

property 
vo:com.adobe.icc.vo:TargetAreaAssignment

Language Version: ActionScript 3.0
Product Version: Asset Composer Building Block 9.5
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

The underlying target area assignment value object.



Implementation
    public function get vo():com.adobe.icc.vo:TargetAreaAssignment
    public function set vo(value:com.adobe.icc.vo:TargetAreaAssignment):void
Method Detail

addModuleAssignment

()method
public function addModuleAssignment(value:ModuleAssignmentModel, addAt:int = -1):void

Language Version: ActionScript 3.0
Product Version: Asset Composer Building Block 9.5
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

Adds a module assignment to this target area assignment object.

Parameters

value:ModuleAssignmentModel — The module assignment object that needs to be added
 
addAt:int (default = -1) — The position the module assignment should be inserted at in the moduleAssignments list

createFromVO

()method 
public static function createFromVO(vo:com.adobe.icc.vo:TargetAreaAssignment):com.adobe.icc.editors.model:TargetAreaAssignmentModel

Language Version: ActionScript 3.0
Product Version: Asset Composer Building Block 9.5
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

Constructs the domain object from its value object counterpart.

Parameters

vo:com.adobe.icc.vo:TargetAreaAssignment — The target area assignment value object.

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

createFromVOAndPath

()method 
public static function createFromVOAndPath(vo:com.adobe.icc.vo:TargetAreaAssignment, path:String):com.adobe.icc.editors.model:TargetAreaAssignmentModel

Language Version: ActionScript 3.0
Product Version: Asset Composer Building Block 10.0
Runtime Versions: AIR (unsupported), Flash Player 10.2

Constructs the domain object from its value object counterpart.

Parameters

vo:com.adobe.icc.vo:TargetAreaAssignment — The target area assignment value object.
 
path:String — path of this target area assignment.

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

removeModuleAssignment

()method 
public function removeModuleAssignment(value:ModuleAssignmentModel):int

Language Version: ActionScript 3.0
Product Version: Asset Composer Building Block 9.5
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

Removes a module assignment from this target area assignment.

Parameters

value:ModuleAssignmentModel — The module assignment domain object that needs to be removed

Returns
int — The index at which the removed module assignment resided.

setContainerLayoutAssignment

()method 
public function setContainerLayoutAssignment(value:ContainerLayoutAssignmentModel):void

Language Version: ActionScript 3.0
Product Version: Asset Composer Building Block 10.0
Runtime Versions: AIR (unsupported), Flash Player 10.2

Adds a container layout assignment to this target area assignment object.

Parameters

value:ContainerLayoutAssignmentModel — The container layout assignment object that needs to be added
Event Detail

containerLayoutAssignmentChange

 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

The event dispatched on the container layout assignment change.

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

The event dispatched when the Field's assignment is changed.

moduleAssignmentAdd

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

Language Version: ActionScript 3.0
Product Version: Asset Composer Building Block 9.5
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

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

moduleAssignmentRemove

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

Language Version: ActionScript 3.0
Product Version: Asset Composer Building Block 9.5
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

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




© 2014 Adobe Systems Incorporated. All rights reserved.
Thu Dec 4 2014, 05:50 PM -08:00
 

 

Legal Notices | Online Privacy Policy