Package | com.adobe.indesign |
Class | public class TextVariables |
Inheritance | TextVariables ![]() ![]() |
Since : | CS5 |
Property | Defined By | ||
---|---|---|---|
![]() | hostObjectDelegate : HostObject Getter for the delegate | CSHostObject | |
length : Number [read-only]
The number of objects in the collection. | TextVariables |
Method | Defined By | ||
---|---|---|---|
add(withPropertiesParam:Object = null):TextVariable
Creates a new TextVariable. | TextVariables | ||
Returns any TextVariable in the collection. | TextVariables | ||
count():Number
Displays the number of elements in the TextVariable. | TextVariables | ||
everyItem():Object
Returns every TextVariable in the collection. | TextVariables | ||
![]() | 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 TextVariable in the collection. | TextVariables | ||
![]() | 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):TextVariable
Returns the TextVariable with the specified index or name. | TextVariables | ||
itemByName(nameParam:String = null):TextVariable
Returns the TextVariable with the specified name. | TextVariables | ||
itemByRange(fromParam:Object = null, toParam:Object = null):Object
Returns the TextVariables within the specified range. | TextVariables | ||
Returns the last TextVariable in the collection. | TextVariables | ||
Returns the middle TextVariable in the collection. | TextVariables | ||
Returns the TextVariable whose index follows the specified TextVariable in the collection. | TextVariables | ||
Returns the TextVariable with the index previous to the specified index. | TextVariables | ||
![]() | 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
| TextVariables | ||
nextValue(index:int):* [override]
Overriding this allows us to support for each...in
| TextVariables |
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(withPropertiesParam:Object = null):TextVariable
Since : | CS5 |
Creates a new TextVariable.
Parameters
withPropertiesParam:Object (default = null ) — (Object) Initial values for properties of the new TextVariable (Optional)
|
TextVariable |
anyItem | () | method |
public function anyItem():TextVariable
Since : | CS5 |
Returns any TextVariable in the collection.
ReturnsTextVariable |
count | () | method |
public function count():Number
Since : | CS5 |
Displays the number of elements in the TextVariable.
ReturnsNumber |
everyItem | () | method |
public function everyItem():Object
Since : | CS5 |
Returns every TextVariable in the collection.
ReturnsObject |
firstItem | () | method |
public function firstItem():TextVariable
Since : | CS5 |
Returns the first TextVariable in the collection.
ReturnsTextVariable |
item | () | method |
public function item(indexParam:Object = null):TextVariable
Since : | CS5 |
Returns the TextVariable with the specified index or name.
Parameters
indexParam:Object (default = null ) — (Object) The index or name. Can accept: Long Integer or String.
|
TextVariable |
itemByName | () | method |
public function itemByName(nameParam:String = null):TextVariable
Since : | CS5 |
Returns the TextVariable with the specified name.
Parameters
nameParam:String (default = null ) — (String) The name.
|
TextVariable |
itemByRange | () | method |
public function itemByRange(fromParam:Object = null, toParam:Object = null):Object
Since : | CS5 |
Returns the TextVariables within the specified range.
Parameters
fromParam:Object (default = null ) — (Object) The TextVariable, index, or name at the beginning of the range. Can accept: TextVariable, Long Integer or String.
| |
toParam:Object (default = null ) — (Object) The TextVariable, index, or name at the end of the range. Can accept: TextVariable, Long Integer or String.
|
Object |
lastItem | () | method |
public function lastItem():TextVariable
Since : | CS5 |
Returns the last TextVariable in the collection.
ReturnsTextVariable |
middleItem | () | method |
public function middleItem():TextVariable
Since : | CS5 |
Returns the middle TextVariable in the collection.
ReturnsTextVariable |
nextItem | () | method |
public function nextItem(objParam:TextVariable = null):TextVariable
Since : | CS5 |
Returns the TextVariable whose index follows the specified TextVariable in the collection.
Parameters
objParam:TextVariable (default = null ) — (TextVariable) The TextVariable whose index comes before the desired TextVariable.
|
TextVariable |
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:TextVariable = null):TextVariable
Since : | CS5 |
Returns the TextVariable with the index previous to the specified index.
Parameters
objParam:TextVariable (default = null ) — (TextVariable) The index of the TextVariable that follows the desired TextVariable.
|
TextVariable |