| Package | com.adobe.icc.vo |
| Class | public class Document |
| Inheritance | Document  Object |
| Implements | IEventDispatcher |
| Subclasses | ConditionalDocument |
| 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 | ||
|---|---|---|---|
| activeEndDate : Date
Specifies the date when the document was archived. | Document | ||
| activeStartDate : Date
Specifies the date when the document was activated. | Document | ||
| comment : String
Specifies the comment associated with the last change or update to the document. | Document | ||
 | constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| desc : String
Specifies the description for the document. | Document | ||
| docContent : ByteArray
Specifies the byte array content of the document. | Document | ||
| docReference : String
Specifies the reference for the document. | Document | ||
| docSource : String
Specifies one of the DOCSOURCE constants. | Document | ||
| extendedProperties : Object
Specifies the extendedProperties map. | Document | ||
| id : String
Specifies a unique identifier for the document. | Document | ||
| lastChangeBy : String
Specifies the last user who completed a change. | Document | ||
| lcat : Category
Specifies the subcategory for the document. | Document | ||
| name : String
Specifies the document name. | Document | ||
| state : int
Specifies the state of the document. | Document | ||
| ucat : Category
Specifies the main category for the document. | Document | ||
| version : int
Specifies the version of the document. | Document | ||
| Method | Defined By | ||
|---|---|---|---|
Document()
Constructor. | Document | ||
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. | Document | ||
Dispatches an event into the event flow. | Document | ||
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | Document | ||
|
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. | Document | ||
|
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 | |
|
Returns the string representation of the specified object. | Object | |
|
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. | Document | ||
| Constant | Defined By | ||
|---|---|---|---|
| DOCSOURCE_FILE : String = "FILE" [static]
Specifies a constant for a document that references a static file. | Document | ||
| DOCSOURCE_LETTER : String = "LETTER" [static]
Specifies a constant for a document that references a Letter template. | Document | ||
activeEndDate | property |
activeEndDate:Date| 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 date when the document was archived. That is, when state was set to Archive.
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 activeEndDate():Date public function set activeEndDate(value:Date):voidactiveStartDate | property |
activeStartDate:Date| 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 date when the document was activated. That is, when state was set to Active.
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 activeStartDate():Date public function set activeStartDate(value:Date):voidcomment | property |
comment: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 comment associated with the last change or update to the document.
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 comment():String public function set comment(value:String):voiddesc | property |
desc: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 description for the document.
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 desc():String public function set desc(value:String):voiddocContent | property |
docContent:ByteArray| 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 byte array content of the document. That is, the resolved byte array content.
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 docContent():ByteArray public function set docContent(value:ByteArray):voiddocReference | property |
docReference: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 reference for the document. That is, the globally unique identifier or GUID. Only applies if docSource is not FILE.
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 docReference():String public function set docReference(value:String):voiddocSource | property |
docSource: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 one of the DOCSOURCE constants.
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 docSource():String public function set docSource(value:String):voidextendedProperties | property |
extendedProperties:Object| 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 extendedProperties map. Used with a backend Asset Manager building block.
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 extendedProperties():Object public function set extendedProperties(value:Object):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 a unique identifier for the document.
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):voidlastChangeBy | property |
lastChangeBy: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 last user who completed a change.
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 lastChangeBy():String public function set lastChangeBy(value:String):voidlcat | property |
lcat:Category| 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 subcategory for the document.
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 lcat():Category public function set lcat(value:Category):voidname | property |
name: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 document name.
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 name():String public function set name(value:String):voidstate | property |
state: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 state of the document.
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 state():int public function set state(value:int):voiducat | property |
ucat:Category| 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 main category for the document.
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 ucat():Category public function set ucat(value:Category):voidversion | property |
version: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 version of the document.
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 version():int public function set version(value:int):voidDocument | () | Constructor |
public function Document()| 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.
|
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.
|
DOCSOURCE_FILE | Constant |
public static const DOCSOURCE_FILE:String = "FILE"| 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 a constant for a document that references a static file.
DOCSOURCE_LETTER | Constant |
public static const DOCSOURCE_LETTER:String = "LETTER"| 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 a constant for a document that references a Letter template.
Wed Nov 21 2018, 06:34 AM -08:00