Package | com.adobe.incopy |
Class | public class BuildingBlock |
Inheritance | BuildingBlock ![]() ![]() |
Since : | CS5 |
Property | Defined By | ||
---|---|---|---|
appliedCharacterStyle : CharacterStyle
Character style to be applied to the building block. | BuildingBlock | ||
appliedDelimiter : String
Delimiter character for paragraph text and full paragraph building blocks. | BuildingBlock | ||
blockType : BuildingBlockTypes
Type of the building block. | BuildingBlock | ||
customText : String
Building block custom text. | BuildingBlock | ||
eventListeners : EventListeners [read-only]
A collection of event listeners. | BuildingBlock | ||
events : Events [read-only]
A collection of events. | BuildingBlock | ||
![]() | hostObjectDelegate : HostObject Getter for the delegate | CSHostObject | |
includeDelimiter : Boolean
If true, the source generated for the building block includes the delimiter. | BuildingBlock | ||
index : Number [read-only]
The index of the BuildingBlock within its containing object. | BuildingBlock | ||
isValid : Boolean [read-only]
Returns true if the object specifier resolves to valid objects. | BuildingBlock | ||
parent : CrossReferenceFormat [read-only]
The parent of the BuildingBlock (a CrossReferenceFormat). | BuildingBlock | ||
properties : Object
A property that allows setting of several properties at the same time. | BuildingBlock |
Method | Defined By | ||
---|---|---|---|
addEventListenerBuildingBlock(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | BuildingBlock | ||
![]() | 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
Resolves the object specifier, creating an array of object references. | BuildingBlock | ||
![]() | 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 | |
remove():void
Deletes the BuildingBlock. | BuildingBlock | ||
removeEventListenerBuildingBlock(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | BuildingBlock | ||
![]() | replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call. | CSHostObject | |
toSpecifier():String
Retrieves the object specifier. | BuildingBlock | ||
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject |
appliedCharacterStyle | property |
appliedCharacterStyle:CharacterStyle
Since : | CS5 |
Character style to be applied to the building block.
public function get appliedCharacterStyle():CharacterStyle
public function set appliedCharacterStyle(value:CharacterStyle):void
appliedDelimiter | property |
appliedDelimiter:String
Since : | CS5 |
Delimiter character for paragraph text and full paragraph building blocks. It is ignored for other types of building blocks.
public function get appliedDelimiter():String
public function set appliedDelimiter(value:String):void
blockType | property |
blockType:BuildingBlockTypes
Since : | CS5 |
Type of the building block.
public function get blockType():BuildingBlockTypes
public function set blockType(value:BuildingBlockTypes):void
customText | property |
customText:String
Since : | CS5 |
Building block custom text. Currently this is only useful in custom string building block. It is ignored for other types of building blocks.
public function get customText():String
public function set customText(value:String):void
eventListeners | property |
eventListeners:EventListeners
[read-only] Since : | CS5 |
A collection of event listeners.
public function get eventListeners():EventListeners
events | property |
events:Events
[read-only] Since : | CS5 |
A collection of events.
public function get events():Events
includeDelimiter | property |
includeDelimiter:Boolean
Since : | CS5 |
If true, the source generated for the building block includes the delimiter. It is ignored if no delimiter is specified on the building block.
public function get includeDelimiter():Boolean
public function set includeDelimiter(value:Boolean):void
index | property |
index:Number
[read-only] Since : | CS5 |
The index of the BuildingBlock within its containing object.
public function get index():Number
isValid | property |
isValid:Boolean
[read-only] Since : | CS5 |
Returns true if the object specifier resolves to valid objects.
public function get isValid():Boolean
parent | property |
parent:CrossReferenceFormat
[read-only] Since : | CS5 |
The parent of the BuildingBlock (a CrossReferenceFormat).
public function get parent():CrossReferenceFormat
properties | property |
properties:Object
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
addEventListenerBuildingBlock | () | method |
public function addEventListenerBuildingBlock(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 |
getElements | () | method |
public function getElements():Object
Since : | CS5 |
Resolves the object specifier, creating an array of object references.
ReturnsObject |
remove | () | method |
public function remove():void
Since : | CS5 |
Deletes the BuildingBlock.
removeEventListenerBuildingBlock | () | method |
public function removeEventListenerBuildingBlock(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 |
toSpecifier | () | method |
public function toSpecifier():String
Since : | CS5 |
Retrieves the object specifier.
ReturnsString |