Packagecom.adobe.indesign
Classpublic class BuildingBlocks
InheritanceBuildingBlocks Inheritance CSHostObject Inheritance flash.utils.Proxy



Public Properties
 PropertyDefined By
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  length : Number
[read-only] The number of objects in the collection.
BuildingBlocks
Public Methods
 MethodDefined 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
 Inherited
filterArgsForHBAPI(args:Array):Array
[static] Function to clean up the argument list and put it into a format that makes sense for HBAPI.
CSHostObject
 Inherited
filterSingleObjectForHBAPI(value:Object):Object
[static]
CSHostObject
  
Returns the first BuildingBlock in the collection.
BuildingBlocks
 Inherited
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
 Inherited
getSpecialTranslation(className:String, ho:HostObject, expectedReturnType:Class, ownerName:String):*
[static]
CSHostObject
 Inherited
hostCall(name:String, expectedReturnType:Class, rawargs:Array):*
Encapsulates a function call to the host
CSHostObject
 Inherited
hostCallStatic(className:String, methodName:String, expectedReturnType:Class, rawargs:Array):*
[static] Implements a safe call of a static method on the host
CSHostObject
 Inherited
hostGet(name:String, expectedReturnType:Class):*
Encapsulates a property get to the host
CSHostObject
 Inherited
hostGetIndex(idx:Object, expectedReturnType:Class):*
Encapsulates a indexed get to the host
CSHostObject
 Inherited
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
 Inherited
hostSet(name:String, rawvalue:*):void
Encapsulates a property set to the host
CSHostObject
 Inherited
hostSetStatic(className:String, propertyName:String, rawvalue:*):*
[static] Implements a safe set of a static property on the host
CSHostObject
 Inherited
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
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
 Inherited
wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):*
[static] Method used on static/normal get/ hostcalls
CSHostObject
Protected Methods
 MethodDefined By
 Inherited
createWithArgs(args:Array):void
CSHostObject
 Inherited
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
Property Detail
lengthproperty
length:Number  [read-only]

The number of objects in the collection.


Implementation
    public function get length():Number
Method Detail
add()method
public function add(blockTypeParam:BuildingBlockTypes = null, appliedCharacterStyleParam:CharacterStyle = null, customTextParam:String = null, withPropertiesParam:Object = null):BuildingBlock

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)

Returns
BuildingBlock
anyItem()method 
public function anyItem():BuildingBlock

Returns any BuildingBlock in the collection.

Returns
BuildingBlock
count()method 
public function count():Number

Displays the number of elements in the BuildingBlock.

Returns
Number
everyItem()method 
public function everyItem():Object

Returns every BuildingBlock in the collection.

Returns
Object
firstItem()method 
public function firstItem():BuildingBlock

Returns the first BuildingBlock in the collection.

Returns
BuildingBlock
item()method 
public function item(indexParam:Object = null):BuildingBlock

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.

Returns
BuildingBlock
itemByRange()method 
public function itemByRange(fromParam:Object = null, toParam:Object = null):Object

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.

Returns
Object
lastItem()method 
public function lastItem():BuildingBlock

Returns the last BuildingBlock in the collection.

Returns
BuildingBlock
middleItem()method 
public function middleItem():BuildingBlock

Returns the middle BuildingBlock in the collection.

Returns
BuildingBlock
nextItem()method 
public function nextItem(objParam:BuildingBlock = null):BuildingBlock

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.

Returns
BuildingBlock
nextNameIndex()method 
override flash_proxy function nextNameIndex(idx:int):int

Overriding this allows us to support for each...in

Parameters

idx:int

Returns
int
nextValue()method 
override flash_proxy function nextValue(index:int):*

Overriding this allows us to support for each...in

Parameters

index:int

Returns
*
previousItem()method 
public function previousItem(objParam:BuildingBlock = null):BuildingBlock

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.

Returns
BuildingBlock