Package | com.adobe.indesign |
Class | public class BuildingBlocks |
Inheritance | BuildingBlocks ![]() ![]() |
Since : | CS5 |
Property | Defined By | ||
---|---|---|---|
![]() | hostObjectDelegate : HostObject Getter for the delegate | CSHostObject | |
length : Number [read-only]
The number of objects in the collection. | BuildingBlocks |
Method | Defined By | ||
---|---|---|---|
add(blockTypeParam:BuildingBlockTypes = null, appliedCharacterStyleParam:CharacterStyle = null, customTextParam:String = null, withPropertiesParam:Object = null):BuildingBlock
Creates a new cross reference building block. | BuildingBlocks | ||
Returns any BuildingBlock in the collection. | BuildingBlocks | ||
count():Number
Displays the number of elements in the BuildingBlock. | BuildingBlocks | ||
everyItem():Object
Returns every BuildingBlock in the collection. | BuildingBlocks | ||
![]() | 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 BuildingBlock in the collection. | BuildingBlocks | ||
![]() | 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):BuildingBlock
Returns the BuildingBlock with the specified index or name. | BuildingBlocks | ||
itemByRange(fromParam:Object = null, toParam:Object = null):Object
Returns the BuildingBlocks within the specified range. | BuildingBlocks | ||
Returns the last BuildingBlock in the collection. | BuildingBlocks | ||
Returns the middle BuildingBlock in the collection. | BuildingBlocks | ||
Returns the BuildingBlock whose index follows the specified BuildingBlock in the collection. | BuildingBlocks | ||
Returns the BuildingBlock with the index previous to the specified index. | BuildingBlocks | ||
![]() | 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
| BuildingBlocks | ||
nextValue(index:int):* [override]
Overriding this allows us to support for each...in
| BuildingBlocks |
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(blockTypeParam:BuildingBlockTypes = null, appliedCharacterStyleParam:CharacterStyle = null, customTextParam:String = null, withPropertiesParam:Object = null):BuildingBlock
Since : | CS5 |
Creates a new cross reference building block.
Parameters
blockTypeParam:BuildingBlockTypes (default = null ) — (BuildingBlockTypes) Type of the building block.
| |
appliedCharacterStyleParam:CharacterStyle (default = null ) — (CharacterStyle) Character style to be applied to the building block. (Optional)
| |
customTextParam:String (default = null ) — (String) Building block custom text. Currently this is only useful in custom string building block. It is ignored for other types of building blocks. (Optional)
| |
withPropertiesParam:Object (default = null ) — (Object) Initial values for properties of the new BuildingBlock (Optional)
|
BuildingBlock |
anyItem | () | method |
public function anyItem():BuildingBlock
Since : | CS5 |
Returns any BuildingBlock in the collection.
ReturnsBuildingBlock |
count | () | method |
public function count():Number
Since : | CS5 |
Displays the number of elements in the BuildingBlock.
ReturnsNumber |
everyItem | () | method |
public function everyItem():Object
Since : | CS5 |
Returns every BuildingBlock in the collection.
ReturnsObject |
firstItem | () | method |
public function firstItem():BuildingBlock
Since : | CS5 |
Returns the first BuildingBlock in the collection.
ReturnsBuildingBlock |
item | () | method |
public function item(indexParam:Object = null):BuildingBlock
Since : | CS5 |
Returns the BuildingBlock with the specified index or name.
Parameters
indexParam:Object (default = null ) — (Object) The index or name. Can accept: Long Integer or String.
|
BuildingBlock |
itemByRange | () | method |
public function itemByRange(fromParam:Object = null, toParam:Object = null):Object
Since : | CS5 |
Returns the BuildingBlocks within the specified range.
Parameters
fromParam:Object (default = null ) — (Object) The BuildingBlock, index, or name at the beginning of the range. Can accept: BuildingBlock, Long Integer or String.
| |
toParam:Object (default = null ) — (Object) The BuildingBlock, index, or name at the end of the range. Can accept: BuildingBlock, Long Integer or String.
|
Object |
lastItem | () | method |
public function lastItem():BuildingBlock
Since : | CS5 |
Returns the last BuildingBlock in the collection.
ReturnsBuildingBlock |
middleItem | () | method |
public function middleItem():BuildingBlock
Since : | CS5 |
Returns the middle BuildingBlock in the collection.
ReturnsBuildingBlock |
nextItem | () | method |
public function nextItem(objParam:BuildingBlock = null):BuildingBlock
Since : | CS5 |
Returns the BuildingBlock whose index follows the specified BuildingBlock in the collection.
Parameters
objParam:BuildingBlock (default = null ) — (BuildingBlock) The BuildingBlock whose index comes before the desired BuildingBlock.
|
BuildingBlock |
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:BuildingBlock = null):BuildingBlock
Since : | CS5 |
Returns the BuildingBlock with the index previous to the specified index.
Parameters
objParam:BuildingBlock (default = null ) — (BuildingBlock) The index of the BuildingBlock that follows the desired BuildingBlock.
|
BuildingBlock |