Package | com.adobe.incopy |
Class | public class XMLInstructions |
Inheritance | XMLInstructions ![]() ![]() |
Since : | CS5 |
Property | Defined By | ||
---|---|---|---|
![]() | hostObjectDelegate : HostObject Getter for the delegate | CSHostObject | |
length : Number [read-only]
The number of objects in the collection. | XMLInstructions |
Method | Defined By | ||
---|---|---|---|
add(targetParam:String = null, dataParam:String, storyOffsetParam:Object = null, withPropertiesParam:Object = null):XMLInstruction
Creates a new XML processing instruction. | XMLInstructions | ||
Returns any XMLInstruction in the collection. | XMLInstructions | ||
count():Number
Displays the number of elements in the XMLInstruction. | XMLInstructions | ||
everyItem():Object
Returns every XMLInstruction in the collection. | XMLInstructions | ||
![]() | 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 | |
Returns the first XMLInstruction in the collection. | XMLInstructions | ||
![]() | 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 | |
![]() | 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 | |
item(indexParam:Object = null):XMLInstruction
Returns the XMLInstruction with the specified index or name. | XMLInstructions | ||
itemByID(idParam:Number):XMLInstruction
Returns the XMLInstruction with the specified ID. | XMLInstructions | ||
itemByRange(fromParam:Object = null, toParam:Object = null):Object
Returns the XMLInstructions within the specified range. | XMLInstructions | ||
Returns the last XMLInstruction in the collection. | XMLInstructions | ||
Returns the middle XMLInstruction in the collection. | XMLInstructions | ||
Returns the XMLInstruction whose index follows the specified XMLInstruction in the collection. | XMLInstructions | ||
Returns the XMLInstruction with the index previous to the specified index. | XMLInstructions | ||
![]() | replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call. | CSHostObject | |
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject |
Method | Defined By | ||
---|---|---|---|
![]() | createWithArgs(args:Array):void | CSHostObject | |
![]() | hostCreate(args:Array):void | CSHostObject | |
nextNameIndex(idx:int):int [override]
Overriding this allows us to support for each...in
| XMLInstructions | ||
nextValue(index:int):* [override]
Overriding this allows us to support for each...in
| XMLInstructions |
length | property |
length:Number
[read-only] Since : | CS5 |
The number of objects in the collection.
public function get length():Number
add | () | method |
public function add(targetParam:String = null, dataParam:String, storyOffsetParam:Object = null, withPropertiesParam:Object = null):XMLInstruction
Since : | CS5 |
Creates a new XML processing instruction.
Parameters
targetParam:String (default = null ) — (String) A name that identifies the processing instruction to an application reading the exported XML file.
| |
dataParam:String — (String) A value that tells the application what to do with the processing instruction identified in the target. (Optional)
| |
storyOffsetParam:Object (default = null ) — (Object) The location within the story, specified as an insertion point. Can accept: InsertionPoint or Long Integer. (Optional)
| |
withPropertiesParam:Object (default = null ) — (Object) Initial values for properties of the new XMLInstruction (Optional)
|
XMLInstruction |
anyItem | () | method |
public function anyItem():XMLInstruction
Since : | CS5 |
Returns any XMLInstruction in the collection.
ReturnsXMLInstruction |
count | () | method |
public function count():Number
Since : | CS5 |
Displays the number of elements in the XMLInstruction.
ReturnsNumber |
everyItem | () | method |
public function everyItem():Object
Since : | CS5 |
Returns every XMLInstruction in the collection.
ReturnsObject |
firstItem | () | method |
public function firstItem():XMLInstruction
Since : | CS5 |
Returns the first XMLInstruction in the collection.
ReturnsXMLInstruction |
item | () | method |
public function item(indexParam:Object = null):XMLInstruction
Since : | CS5 |
Returns the XMLInstruction with the specified index or name.
Parameters
indexParam:Object (default = null ) — (Object) The index or name. Can accept: Long Integer or String.
|
XMLInstruction |
itemByID | () | method |
public function itemByID(idParam:Number):XMLInstruction
Since : | CS5 |
Returns the XMLInstruction with the specified ID.
Parameters
idParam:Number (default = NaN ) — (Number) The ID.
|
XMLInstruction |
itemByRange | () | method |
public function itemByRange(fromParam:Object = null, toParam:Object = null):Object
Since : | CS5 |
Returns the XMLInstructions within the specified range.
Parameters
fromParam:Object (default = null ) — (Object) The XMLInstruction, index, or name at the beginning of the range. Can accept: XMLInstruction, Long Integer or String.
| |
toParam:Object (default = null ) — (Object) The XMLInstruction, index, or name at the end of the range. Can accept: XMLInstruction, Long Integer or String.
|
Object |
lastItem | () | method |
public function lastItem():XMLInstruction
Since : | CS5 |
Returns the last XMLInstruction in the collection.
ReturnsXMLInstruction |
middleItem | () | method |
public function middleItem():XMLInstruction
Since : | CS5 |
Returns the middle XMLInstruction in the collection.
ReturnsXMLInstruction |
nextItem | () | method |
public function nextItem(objParam:XMLInstruction = null):XMLInstruction
Since : | CS5 |
Returns the XMLInstruction whose index follows the specified XMLInstruction in the collection.
Parameters
objParam:XMLInstruction (default = null ) — (XMLInstruction) The XMLInstruction whose index comes before the desired XMLInstruction.
|
XMLInstruction |
nextNameIndex | () | method |
override flash_proxy function nextNameIndex(idx:int):int
Since : | CS5 |
Overriding this allows us to support for each...in
Parameters
idx:int |
int |
nextValue | () | method |
override flash_proxy function nextValue(index:int):*
Since : | CS5 |
Overriding this allows us to support for each...in
Parameters
index:int |
* |
previousItem | () | method |
public function previousItem(objParam:XMLInstruction = null):XMLInstruction
Since : | CS5 |
Returns the XMLInstruction with the index previous to the specified index.
Parameters
objParam:XMLInstruction (default = null ) — (XMLInstruction) The index of the XMLInstruction that follows the desired XMLInstruction.
|
XMLInstruction |