Package | com.adobe.incopy |
Class | public class Assignment |
Inheritance | Assignment ![]() ![]() |
Since : | CS5 |
Property | Defined By | ||
---|---|---|---|
assignedStories : AssignedStories [read-only]
A collection of assigned stories. | Assignment | ||
documentPath : File [read-only]
The path to the document that the hyperlink destination points to. | Assignment | ||
eventListeners : EventListeners [read-only]
A collection of event listeners. | Assignment | ||
events : Events [read-only]
A collection of events. | Assignment | ||
exportOptions : AssignmentExportOptions [read-only]
The content to export in the assignment. | Assignment | ||
filePath : String [read-only]
The file path (colon delimited on the Mac OS). | Assignment | ||
frameColor : Object [read-only]
The color of the assignment's frames. | Assignment | ||
![]() | hostObjectDelegate : HostObject Getter for the delegate | CSHostObject | |
id : Number [read-only]
The unique ID of the Assignment. | Assignment | ||
includeLinksWhenPackage : Boolean
If true, includes linked files when packaging the assignment. | Assignment | ||
index : Number [read-only]
The index of the Assignment within its containing object. | Assignment | ||
isValid : Boolean [read-only]
Returns true if the object specifier resolves to valid objects. | Assignment | ||
label : String
A property that can be set to any string. | Assignment | ||
name : String [read-only]
The name of the Assignment. | Assignment | ||
packaged : Boolean [read-only]
If true, the assignment is packaged. | Assignment | ||
packageUpToDate : Boolean [read-only]
If true, the assignment package is up to date. | Assignment | ||
parent : Document [read-only]
The parent of the Assignment (a Document). | Assignment | ||
properties : Object
A property that allows setting of several properties at the same time. | Assignment | ||
userName : String [read-only]
The user name to assign to tracked changes and notes. | Assignment |
Method | Defined By | ||
---|---|---|---|
addEventListenerAssignment(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | Assignment | ||
createPackage(filePathParam:File = null, packageTypeParam:PackageType = null, submitParam:Boolean = true, includeAddedParam:Boolean = true, withPropertiesParam:Object = null):File
Creates an assignment package. | Assignment | ||
extractLabel(keyParam:String = null):String
Gets the label value associated with the specified key. | Assignment | ||
![]() | filterArgsForHBAPI(args:Array):Array [static]
Function to clean up the argument list and put it into a format that
makes sense for HBAPI. | CSHostObject | |
![]() | filterSingleObjectForHBAPI(value:Object):Object [static]
| CSHostObject | |
![]() | getClassObjectForName(className:String):HostObject [static] This returns a "Class" object, meaning, a HostObject that can be used
to make static function calls or get static properties
| CSHostObject | |
getElements():Object
Resolves the object specifier, creating an array of object references. | Assignment | ||
![]() | getSpecialTranslation(className:String, ho:HostObject, expectedReturnType:Class, ownerName:String):* [static] | CSHostObject | |
![]() | hostCall(name:String, expectedReturnType:Class, rawargs:Array):*
Encapsulates a function call to the host
| CSHostObject | |
![]() | hostCallStatic(className:String, methodName:String, expectedReturnType:Class, rawargs:Array):* [static]
Implements a safe call of a static method on the host
| CSHostObject | |
![]() | hostGet(name:String, expectedReturnType:Class):*
Encapsulates a property get to the host
| CSHostObject | |
![]() | hostGetIndex(idx:Object, expectedReturnType:Class):*
Encapsulates a indexed get to the host
| CSHostObject | |
![]() | hostGetStatic(className:String, propertyName:String, expectedReturnType:Class):* [static]
Implements a safe get of a static property on the host
Used by for instance, all the enum implementations. | CSHostObject | |
![]() | hostSet(name:String, rawvalue:*):void
Encapsulates a property set to the host
| CSHostObject | |
![]() | hostSetStatic(className:String, propertyName:String, rawvalue:*):* [static]
Implements a safe set of a static property on the host
| CSHostObject | |
insertLabel(keyParam:String = null, valueParam:String = null):void
Sets the label to the value associated with the specified key. | Assignment | ||
![]() | isDescendedFrom(clz:Class, ancClass:Class):Boolean [static] Efficiently determines whether or not one class descends from
another in inheritance hierarchy- class relationships are cached
by the ClassUtils implementation-
(uses org.as3commons lib to quickly discover class hierarchy. | CSHostObject | |
removeEventListenerAssignment(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | Assignment | ||
![]() | replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call. | CSHostObject | |
toSpecifier():String
Retrieves the object specifier. | Assignment | ||
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject |
assignedStories | property |
assignedStories:AssignedStories
[read-only] Since : | CS5 |
A collection of assigned stories.
public function get assignedStories():AssignedStories
documentPath | property |
documentPath:File
[read-only] Since : | CS5 |
The path to the document that the hyperlink destination points to.
public function get documentPath():File
eventListeners | property |
eventListeners:EventListeners
[read-only] Since : | CS5 |
A collection of event listeners.
public function get eventListeners():EventListeners
events | property |
events:Events
[read-only] Since : | CS5 |
A collection of events.
public function get events():Events
exportOptions | property |
exportOptions:AssignmentExportOptions
[read-only] Since : | CS5 |
The content to export in the assignment.
public function get exportOptions():AssignmentExportOptions
filePath | property |
filePath:String
[read-only] Since : | CS5 |
The file path (colon delimited on the Mac OS). Can also accept: File.
public function get filePath():String
frameColor | property |
frameColor:Object
[read-only] Since : | CS5 |
The color of the assignment's frames. Can return: Array of 3 Reals (0 - 255) or UIColors enumerator or NothingEnum enumerator.
public function get frameColor():Object
id | property |
id:Number
[read-only] Since : | CS5 |
The unique ID of the Assignment.
public function get id():Number
includeLinksWhenPackage | property |
includeLinksWhenPackage:Boolean
Since : | CS5 |
If true, includes linked files when packaging the assignment.
public function get includeLinksWhenPackage():Boolean
public function set includeLinksWhenPackage(value:Boolean):void
index | property |
index:Number
[read-only] Since : | CS5 |
The index of the Assignment within its containing object.
public function get index():Number
isValid | property |
isValid:Boolean
[read-only] Since : | CS5 |
Returns true if the object specifier resolves to valid objects.
public function get isValid():Boolean
label | property |
label:String
Since : | CS5 |
A property that can be set to any string.
public function get label():String
public function set label(value:String):void
name | property |
name:String
[read-only] Since : | CS5 |
The name of the Assignment.
public function get name():String
packaged | property |
packaged:Boolean
[read-only] Since : | CS5 |
If true, the assignment is packaged.
public function get packaged():Boolean
packageUpToDate | property |
packageUpToDate:Boolean
[read-only] Since : | CS5 |
If true, the assignment package is up to date.
public function get packageUpToDate():Boolean
parent | property |
parent:Document
[read-only] Since : | CS5 |
The parent of the Assignment (a Document).
public function get parent():Document
properties | property |
properties:Object
Since : | CS5 |
A property that allows setting of several properties at the same time.
public function get properties():Object
public function set properties(value:Object):void
userName | property |
userName:String
[read-only] Since : | CS5 |
The user name to assign to tracked changes and notes.
public function get userName():String
addEventListenerAssignment | () | method |
public function addEventListenerAssignment(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Since : | CS5 |
Adds an event listener.
Parameters
eventTypeParam:String (default = null ) — (String) The event type.
| |
handlerParam:Object (default = null ) — (Object) The event handler. Can accept: File or JavaScript Function.
| |
capturesParam:Boolean (default = false ) — (Boolean) This parameter is obsolete. (Optional)
|
EventListener |
createPackage | () | method |
public function createPackage(filePathParam:File = null, packageTypeParam:PackageType = null, submitParam:Boolean = true, includeAddedParam:Boolean = true, withPropertiesParam:Object = null):File
Since : | CS5 |
Creates an assignment package.
Parameters
filePathParam:File (default = null ) — (File) The full path name of the assignment pacakge file.
| |
packageTypeParam:PackageType (default = null ) — (PackageType) The package type.
| |
submitParam:Boolean (default = true ) — (Boolean) If true, submit assigned stories before packaging the assignment. (Optional)
| |
includeAddedParam:Boolean (default = true ) — (Boolean) If true, includes added links in the assginment package. (Optional)
| |
withPropertiesParam:Object (default = null ) — (Object) Initial values for properties of the new Assignment (Optional)
|
File |
extractLabel | () | method |
public function extractLabel(keyParam:String = null):String
Since : | CS5 |
Gets the label value associated with the specified key.
Parameters
keyParam:String (default = null ) — (String) The key.
|
String |
getElements | () | method |
public function getElements():Object
Since : | CS5 |
Resolves the object specifier, creating an array of object references.
ReturnsObject |
insertLabel | () | method |
public function insertLabel(keyParam:String = null, valueParam:String = null):void
Since : | CS5 |
Sets the label to the value associated with the specified key.
Parameters
keyParam:String (default = null ) — (String) The key.
| |
valueParam:String (default = null ) — (String) The value.
|
removeEventListenerAssignment | () | method |
public function removeEventListenerAssignment(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Since : | CS5 |
Removes the event listener.
Parameters
eventTypeParam:String (default = null ) — (String) The registered event type.
| |
handlerParam:Object (default = null ) — (Object) The registered event handler. Can accept: File or JavaScript Function.
| |
capturesParam:Boolean (default = false ) — (Boolean) This parameter is obsolete. (Optional)
|
Boolean |
toSpecifier | () | method |
public function toSpecifier():String
Since : | CS5 |
Retrieves the object specifier.
ReturnsString |