| Package | com.adobe.icc.vo |
| Class | public class ModuleAssignment |
| Inheritance | ModuleAssignment  Object |
| Implements | IEventDispatcher |
| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
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 | |
| dataModule : DataModule
Specifies the module assigned to the target. | ModuleAssignment | ||
| editable : Boolean
Specifies whether the module's value can be edited at runtime. | ModuleAssignment | ||
| expression : String
Specifies an inline expression for the module that is included at runtime. | ModuleAssignment | ||
| hasConflict : Boolean
[Applicable during reload]
True if there is a conflict in reloading the content. | ModuleAssignment | ||
| hasContentRemoved : Boolean
[Applicable during reload]
True if the target is a container (condition/list), and there were some modules removed from it, when using latest definition; may be due to modules
no longer being assigned, or due to container being closed now (but there were some extra content added earlier). | ModuleAssignment | ||
| hasNewContent : Boolean
True if the target is a container (condition/list), and if there were some modules added to it in its latest definition;
may be due to new modules being assigned. | ModuleAssignment | ||
| id : String
Specifies the globally unique identifier, that is, the GUID. | ModuleAssignment | ||
| indentationLevel : Number
Specifies the indentation level for the target data module. | ModuleAssignment | ||
| newMandatory : Boolean
True if this is a "new" mandatory module in its target. | ModuleAssignment | ||
| nonEditableOverride : Boolean
[Applicable during reload]
True if this module was edited, but is not editable in its latest definition. | ModuleAssignment | ||
| optional : Boolean
Specifies whether the module is not required to be selected in the target. | ModuleAssignment | ||
| position : int
Specifies the zero-based position of the module within the target it is assigned to. | ModuleAssignment | ||
| preSelected : Boolean
Specifies whether the module is preselected in the target at runtime. | ModuleAssignment | ||
| removed : Boolean
True if the module is removed in the newer target. | ModuleAssignment | ||
| stale : Boolean
True if an older version of the module is assigned, while a more recent version exists. | ModuleAssignment | ||
| updated : Boolean
If the data module is assigned was updated (as a result of using the latest version of the module)
This is inline with the feature of producing a Letter template with the latest versions of assets used in it. | ModuleAssignment | ||
| Method | Defined By | ||
|---|---|---|---|
Constructor. | ModuleAssignment | ||
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, weakRef:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener
receives notification of an event. | ModuleAssignment | ||
Dispatches an event into the event flow. | ModuleAssignment | ||
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | ModuleAssignment | ||
|
Indicates whether an object has a specified property defined. | Object | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
Removes a listener from the EventDispatcher object. | ModuleAssignment | ||
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
Specifies a string representation of this object. | ModuleAssignment | ||
|
Returns the primitive value of the specified object. | Object | |
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type. | ModuleAssignment | ||
dataModule | property |
dataModule:DataModule| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Specifies the module assigned to the target.
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 dataModule():DataModule public function set dataModule(value:DataModule):voideditable | property |
editable:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Specifies whether the module's value can be edited at runtime. If the value is true, the module can be edited at runtime.
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 editable():Boolean public function set editable(value:Boolean):voidexpression | property |
expression:String| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Specifies an inline expression for the module that is included at runtime. If the value for the expression after evaluation is true, the inclusion of the module in the
target is determined by its preSelected property settings, optional property settings, or both. If the value for the expression after evaluation is
false, the module is not included in the target.
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 expression():String public function set expression(value:String):voidhasConflict | property |
hasConflict:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
[Applicable during reload] True if there is a conflict in reloading the content. Perhaps due to the fact that the module was edited (on a given version), while a newer version is now available. Client-only. (For notifications when creating correspondence)
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 hasConflict():Boolean public function set hasConflict(value:Boolean):voidhasContentRemoved | property |
hasContentRemoved:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
[Applicable during reload] True if the target is a container (condition/list), and there were some modules removed from it, when using latest definition; may be due to modules no longer being assigned, or due to container being closed now (but there were some extra content added earlier). Client-only. (For notifications when creating correspondence)
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 hasContentRemoved():Boolean public function set hasContentRemoved(value:Boolean):voidhasNewContent | property |
hasNewContent:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
True if the target is a container (condition/list), and if there were some modules added to it in its latest definition; may be due to new modules being assigned. Client-only. (For notifications when creating correspondence)
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 hasNewContent():Boolean public function set hasNewContent(value:Boolean):voidid | property |
id:String| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Specifies the globally unique identifier, that is, the GUID. Do not set on client.
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 id():String public function set id(value:String):voidindentationLevel | property |
indentationLevel:Number| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Specifies the indentation level for the target data module.
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 indentationLevel():Number public function set indentationLevel(value:Number):voidnewMandatory | property |
newMandatory:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
True if this is a "new" mandatory module in its target. This may be true if the associated module was not included as a mandatory module (in its target) in the original assignment, but introduced later as a mandatory one. Client-only. (For notifications when creating correspondence)
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 newMandatory():Boolean public function set newMandatory(value:Boolean):voidnonEditableOverride | property |
nonEditableOverride:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
[Applicable during reload] True if this module was edited, but is not editable in its latest definition. Client-only. (For notifications when creating correspondence)
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 nonEditableOverride():Boolean public function set nonEditableOverride(value:Boolean):voidoptional | property |
optional:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Specifies whether the module is not required to be selected in the target. If the value is true, the module is not required to be selected in the target.
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 optional():Boolean public function set optional(value:Boolean):voidposition | property |
position:int| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Specifies the zero-based position of the module within the target it is assigned to.
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 position():int public function set position(value:int):voidpreSelected | property |
preSelected:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Specifies whether the module is preselected in the target at runtime. If the value is true, the module is preselected at runtime.
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 preSelected():Boolean public function set preSelected(value:Boolean):voidremoved | property |
removed:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
True if the module is removed in the newer target. Client-only. (For notifications when creating correspondence)
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 removed():Boolean public function set removed(value:Boolean):voidstale | property |
stale:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
True if an older version of the module is assigned, while a more recent version exists. Client-only. (For notifications when creating correspondence)
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 stale():Boolean public function set stale(value:Boolean):voidupdated | property |
updated:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
If the data module is assigned was updated (as a result of using the latest version of the module) This is inline with the feature of producing a Letter template with the latest versions of assets used in it.
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 updated():Boolean public function set updated(value:Boolean):voidModuleAssignment | () | Constructor |
public function ModuleAssignment()| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Constructor.
addEventListener | () | method |
public function addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, weakRef:Boolean = false):voidRegisters an event listener object with an EventDispatcher object so that the listener receives notification of an event. You can register event listeners on all nodes in the display list for a specific type of event, phase, and priority.
After you successfully register an event listener, you cannot change its priority
through additional calls to addEventListener(). To change a listener's priority, you
must first call removeEventListener(). Then you can register the listener again with the new
priority level.
After the listener is registered, subsequent calls to
addEventListener() with a different value for either type or useCapture result in the
creation of a separate listener registration. For example, if you first register a
listener with useCapture set to true, it listens only during the capture phase. If you
call addEventListener() again using the same listener object, but with useCapture set to
false, you have two separate listeners: one that listens during the capture phase, and
another that listens during the target and bubbling phases.
You cannot register an event listener for only the target phase or the bubbling phase. Those phases are coupled during registration because bubbling applies only to the ancestors of the target node.
When you no longer need an event listener, remove it by calling EventDispatcher.removeEventListener(); otherwise, memory problems might result. Objects
with registered event listeners are not automatically removed from memory because the
garbage collector does not remove objects that still have references.
Copying an EventDispatcher instance does not copy the event listeners attached to it. (If your newly created node needs an event listener, you must attach the listener after creating the node.) However, if you move an EventDispatcher instance, the event listeners attached to it move along with it.
If the event listener is being registered on a node while an event is also being processed on this node, the event listener is not triggered during the current phase but may be triggered during a later phase in the event flow, such as the bubbling phase.
If an event listener is removed from a node while an event is being processed on the node, it is still triggered by the current actions. After it is removed, the event listener is never invoked again (unless it is registered again for future processing).
Parameters
type:String — The type of event.
| |
listener:Function — The listener function that processes the event. This function must accept an event object
as its only parameter and must return nothing, as this example shows:
| |
useCapture:Boolean (default = false)useCapture is set to true, the
listener processes the event only during the capture phase and not in the target or
bubbling phase. If useCapture is false, the listener processes the event only
during the target or bubbling phase. To listen for the event in all three phases, call
addEventListener() twice, once with useCapture set to true,
then again with useCapture set to false.
| |
priority:int (default = 0) | |
weakRef:Boolean (default = false)Class-level member functions are not subject to garbage
collection, so you can set |
dispatchEvent | () | method |
public function dispatchEvent(event:Event):Boolean
Dispatches an event into the event flow. The event target is the
EventDispatcher object upon which dispatchEvent() is called.
Parameters
event:Event — The event object dispatched into the event flow.
|
Boolean — A value of true unless preventDefault() is called on the event,
in which case it returns false.
|
hasEventListener | () | method |
public function hasEventListener(type:String):Boolean
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. This allows you to determine where an EventDispatcher object has altered handling of an event type in the event flow hierarchy. To determine whether
a specific event type will actually trigger an event listener, use IEventDispatcher.willTrigger().
The difference between hasEventListener() and willTrigger() is that hasEventListener() examines only the object to which it belongs, whereas willTrigger() examines the entire event flow for the event specified by the type parameter.
Parameters
type:String — The type of event.
|
Boolean — A value of true if a listener of the specified type is registered; false otherwise.
|
removeEventListener | () | method |
public function removeEventListener(type:String, listener:Function, useCapture:Boolean = false):voidRemoves a listener from the EventDispatcher object. If there is no matching listener registered with the EventDispatcher object, a call to this method has no effect.
Parameters
type:String — The type of event.
| |
listener:Function — The listener object to remove.
| |
useCapture:Boolean (default = false)removeEventListener() are required to remove both: one call with useCapture set to true, and another call with useCapture set to false.
|
toString | () | method |
willTrigger | () | method |
public function 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. This method returns true if an event listener is triggered during any phase of the event flow when an event of the specified type is dispatched to this EventDispatcher object or any of its descendants.
The difference between hasEventListener() and willTrigger() is that hasEventListener() examines only the object to which it belongs, whereas willTrigger() examines the entire event flow for the event specified by the type parameter.
Parameters
type:String — The type of event.
|
Boolean — A value of true if a listener of the specified type will be triggered; false otherwise.
|
Wed Nov 21 2018, 06:34 AM -08:00