Package | com.adobe.incopy |
Class | public class XMLInstruction |
Inheritance | XMLInstruction ![]() ![]() ![]() |
Since : | CS5 |
Property | Defined By | ||
---|---|---|---|
data : String
A value that tells the application reading the exported XML file what to do with the processing instruction. | XMLInstruction | ||
eventListeners : EventListeners [override] [read-only]
A collection of event listeners. | XMLInstruction | ||
events : Events [override] [read-only]
A collection of events. | XMLInstruction | ||
![]() | hostObjectDelegate : HostObject Getter for the delegate | CSHostObject | |
id : Number [override] [read-only]
The unique ID of the XMLInstruction. | XMLInstruction | ||
index : Number [override] [read-only]
The index of the XMLInstruction within its containing object. | XMLInstruction | ||
isValid : Boolean [override] [read-only]
Returns true if the object specifier resolves to valid objects. | XMLInstruction | ||
parent : Object [override] [read-only]
The parent of the XMLInstruction (a Document or XMLElement). | XMLInstruction | ||
properties : Object [override]
A property that allows setting of several properties at the same time. | XMLInstruction | ||
storyOffset : InsertionPoint [read-only]
The insertion point before the table in the story containing the table. | XMLInstruction | ||
target : String
A name that identifies the processing instruction to an application reading the exported XML file. | XMLInstruction |
Method | Defined By | ||
---|---|---|---|
addEventListenerXMLInstruction(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | XMLInstruction | ||
![]() | addEventListenerXMLItem(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | XMLItem | |
[override]
Duplicates the XMLInstruction. | XMLInstruction | ||
![]() | 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 [override]
Resolves the object specifier, creating an array of object references. | XMLInstruction | ||
![]() | 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 | |
![]() | 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 | |
Moves the element to the specified location. | XMLInstruction | ||
remove():void [override]
Deletes the XMLInstruction. | XMLInstruction | ||
removeEventListenerXMLInstruction(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | XMLInstruction | ||
![]() | removeEventListenerXMLItem(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | XMLItem | |
![]() | replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call. | CSHostObject | |
select(existingSelectionParam:SelectionOptions = null):void [override]
Selects the object. | XMLInstruction | ||
toSpecifier():String [override]
Retrieves the object specifier. | XMLInstruction | ||
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject |
data | property |
data:String
Since : | CS5 |
A value that tells the application reading the exported XML file what to do with the processing instruction.
public function get data():String
public function set data(value:String):void
eventListeners | property |
eventListeners:EventListeners
[read-only] [override] Since : | CS5 |
A collection of event listeners.
public function get eventListeners():EventListeners
events | property |
events:Events
[read-only] [override] Since : | CS5 |
A collection of events.
public function get events():Events
id | property |
id:Number
[read-only] [override] Since : | CS5 |
The unique ID of the XMLInstruction.
public function get id():Number
index | property |
index:Number
[read-only] [override] Since : | CS5 |
The index of the XMLInstruction within its containing object.
public function get index():Number
isValid | property |
isValid:Boolean
[read-only] [override] Since : | CS5 |
Returns true if the object specifier resolves to valid objects.
public function get isValid():Boolean
parent | property |
parent:Object
[read-only] [override] Since : | CS5 |
The parent of the XMLInstruction (a Document or XMLElement).
public function get parent():Object
properties | property |
properties:Object
[override] 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
storyOffset | property |
storyOffset:InsertionPoint
[read-only] Since : | CS5 |
The insertion point before the table in the story containing the table.
public function get storyOffset():InsertionPoint
target | property |
target:String
Since : | CS5 |
A name that identifies the processing instruction to an application reading the exported XML file.
public function get target():String
public function set target(value:String):void
addEventListenerXMLInstruction | () | method |
public function addEventListenerXMLInstruction(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 |
duplicate | () | method |
override public function duplicate():XMLItem
Since : | CS5 |
Duplicates the XMLInstruction.
ReturnsXMLItem |
getElements | () | method |
override public function getElements():Object
Since : | CS5 |
Resolves the object specifier, creating an array of object references.
ReturnsObject |
move | () | method |
public function move(toParam:LocationOptions = null, referenceParam:Object = null):XMLInstruction
Since : | CS5 |
Moves the element to the specified location.
Parameters
toParam:LocationOptions (default = null ) — (LocationOptions) The location in relation to the reference object or within the containing object.
| |
referenceParam:Object (default = null ) — (Object) The reference object. Note: Required when the to parameter specifies before or after. . Can accept: XMLItem or Text. (Optional)
|
XMLInstruction |
remove | () | method |
override public function remove():void
Since : | CS5 |
Deletes the XMLInstruction.
removeEventListenerXMLInstruction | () | method |
public function removeEventListenerXMLInstruction(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 |
select | () | method |
override public function select(existingSelectionParam:SelectionOptions = null):void
Since : | CS5 |
Selects the object.
Parameters
existingSelectionParam:SelectionOptions (default = null ) — (SelectionOptions) The selection status of the XMLInstruction in relation to previously selected objects. (Optional)
|
toSpecifier | () | method |
override public function toSpecifier():String
Since : | CS5 |
Retrieves the object specifier.
ReturnsString |