Package | com.adobe.indesign |
Class | public class BookContent |
Inheritance | BookContent ![]() ![]() |
Since : | CS5 |
Property | Defined By | ||
---|---|---|---|
date : Date [read-only]
The date and time the BookContent was created. | BookContent | ||
documentPageRange : String [read-only]
The page range of the book content object within the book. | BookContent | ||
eventListeners : EventListeners [read-only]
A collection of event listeners. | BookContent | ||
events : Events [read-only]
A collection of events. | BookContent | ||
filePath : File [read-only]
The full path to the file. | BookContent | ||
fullName : File [read-only]
The full path to the BookContent, including the name of the BookContent. | BookContent | ||
![]() | hostObjectDelegate : HostObject Getter for the delegate | CSHostObject | |
id : Number [read-only]
The unique ID of the BookContent. | BookContent | ||
index : Number [read-only]
The index of the BookContent within its containing object. | BookContent | ||
isValid : Boolean [read-only]
Returns true if the object specifier resolves to valid objects. | BookContent | ||
label : String
A property that can be set to any string. | BookContent | ||
name : String [read-only]
The name of the BookContent. | BookContent | ||
parent : Book [read-only]
The parent of the BookContent (a Book). | BookContent | ||
properties : Object
A property that allows setting of several properties at the same time. | BookContent | ||
size : Number [read-only]
The size of the BookContent file. | BookContent | ||
status : BookContentStatus [read-only]
The status of the book content object file. | BookContent |
Method | Defined By | ||
---|---|---|---|
addEventListenerBookContent(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | BookContent | ||
extractLabel(keyParam:String = null):String
Gets the label value associated with the specified key. | BookContent | ||
![]() | 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. | BookContent | ||
![]() | 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 | |
insertLabel(keyParam:String = null, valueParam:String = null):void
Sets the label to the value associated with the specified key. | BookContent | ||
![]() | 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 | |
Moves the book content object. | BookContent | ||
preflight(toParam:File = null, autoOpenParam:Boolean = false):void
Preflight a book content object and optionally save the resulting report. | BookContent | ||
remove():void
Deletes the BookContent. | BookContent | ||
removeEventListenerBookContent(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | BookContent | ||
replace(usingParam:File = null):BookContent
Replaces a book content object with a new file. | BookContent | ||
![]() | replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call. | CSHostObject | |
synchronize():void
Matches the formatting of the book content object to the style source document. | BookContent | ||
toSpecifier():String
Retrieves the object specifier. | BookContent | ||
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject |
date | property |
date:Date
[read-only] Since : | CS5 |
The date and time the BookContent was created.
public function get date():Date
documentPageRange | property |
documentPageRange:String
[read-only] Since : | CS5 |
The page range of the book content object within the book.
public function get documentPageRange():String
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
filePath | property |
filePath:File
[read-only] Since : | CS5 |
The full path to the file.
public function get filePath():File
fullName | property |
fullName:File
[read-only] Since : | CS5 |
The full path to the BookContent, including the name of the BookContent.
public function get fullName():File
id | property |
id:Number
[read-only] Since : | CS5 |
The unique ID of the BookContent.
public function get id():Number
index | property |
index:Number
[read-only] Since : | CS5 |
The index of the BookContent 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
label | property |
label:String
Since : | CS5 |
A property that can be set to any string.
public function get label():String
public function set label(value:String):void
name | property |
name:String
[read-only] Since : | CS5 |
The name of the BookContent.
public function get name():String
parent | property |
parent:Book
[read-only] Since : | CS5 |
The parent of the BookContent (a Book).
public function get parent():Book
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
size | property |
size:Number
[read-only] Since : | CS5 |
The size of the BookContent file.
public function get size():Number
status | property |
status:BookContentStatus
[read-only] Since : | CS5 |
The status of the book content object file.
public function get status():BookContentStatus
addEventListenerBookContent | () | method |
public function addEventListenerBookContent(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 |
extractLabel | () | method |
public function extractLabel(keyParam:String = null):String
Since : | CS5 |
Gets the label value associated with the specified key.
Parameters
keyParam:String (default = null ) — (String) The key.
|
String |
getElements | () | method |
public function getElements():Object
Since : | CS5 |
Resolves the object specifier, creating an array of object references.
ReturnsObject |
insertLabel | () | method |
public function insertLabel(keyParam:String = null, valueParam:String = null):void
Since : | CS5 |
Sets the label to the value associated with the specified key.
Parameters
keyParam:String (default = null ) — (String) The key.
| |
valueParam:String (default = null ) — (String) The value.
|
move | () | method |
public function move(toParam:LocationOptions = null, referenceParam:BookContent = null):BookContent
Since : | CS5 |
Moves the book content object.
Parameters
toParam:LocationOptions (default = null ) — (LocationOptions) The location relative to the reference object or within the book. (Optional)
| |
referenceParam:BookContent (default = null ) — (BookContent) The reference object. Note: Required when the to parameter specifies before or after. (Optional)
|
BookContent |
preflight | () | method |
public function preflight(toParam:File = null, autoOpenParam:Boolean = false):void
Since : | CS5 |
Preflight a book content object and optionally save the resulting report.
Parameters
toParam:File (default = null ) — (File) The preflight report to save to. (Optional)
| |
autoOpenParam:Boolean (default = false ) — (Boolean) If true, automatically open the report after creation. (Optional)
|
remove | () | method |
public function remove():void
Since : | CS5 |
Deletes the BookContent.
removeEventListenerBookContent | () | method |
public function removeEventListenerBookContent(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 |
replace | () | method |
public function replace(usingParam:File = null):BookContent
Since : | CS5 |
Replaces a book content object with a new file. Note: If the new file replaces the current style source document, the new file becomes the style source document.
Parameters
usingParam:File (default = null ) — (File) The full path name of the new book content object.
|
BookContent |
synchronize | () | method |
public function synchronize():void
Since : | CS5 |
Matches the formatting of the book content object to the style source document.
toSpecifier | () | method |
public function toSpecifier():String
Since : | CS5 |
Retrieves the object specifier.
ReturnsString |