Package | com.adobe.indesign |
Class | public class Book |
Inheritance | Book ![]() ![]() |
Since : | CS5 |
Property | Defined By | ||
---|---|---|---|
automaticDocumentConversion : Boolean
If true, automatically converts the book content object during repagination and synchronization. | Book | ||
automaticPagination : Boolean
If true, automatically updates page numbers when pages in book content files are added, deleted, or rearranged. | Book | ||
bookContents : BookContents [read-only]
A collection of book content objects. | Book | ||
epubExportPreferences : EPubExportPreference [read-only]
EPub export preference settings. | Book | ||
eventListeners : EventListeners [read-only]
A collection of event listeners. | Book | ||
events : Events [read-only]
A collection of events. | Book | ||
filePath : File [read-only]
The full path to the file. | Book | ||
fullName : File [read-only]
The full path to the Book, including the name of the Book. | Book | ||
![]() | hostObjectDelegate : HostObject Getter for the delegate | CSHostObject | |
index : Number [read-only]
The index of the Book within its containing object. | Book | ||
insertBlankPage : Boolean
If true, inserts a blank page as necessary to fill in page number gaps caused by the odd or even specification set in the repagination option. | Book | ||
isValid : Boolean [read-only]
Returns true if the object specifier resolves to valid objects. | Book | ||
label : String
A property that can be set to any string. | Book | ||
mergeIdenticalLayers : Boolean
If true, merges identically named layers when exporting to PDF. | Book | ||
modified : Boolean [read-only]
If true, the Book has been modified since it was last saved. | Book | ||
name : String [read-only]
The name of the Book. | Book | ||
parent : Application [read-only]
The parent of the Book (a Application). | Book | ||
preferences : Preferences [read-only]
A collection of preferences objects. | Book | ||
preflightBookOptions : PreflightBookOption [read-only]
Preflight book option settings. | Book | ||
printPreferences : PrintPreference [read-only]
Print preference settings. | Book | ||
properties : Object
A property that allows setting of several properties at the same time. | Book | ||
repaginationOption : RepaginateOption
Page numbering options for book content objects within the book. | Book | ||
saved : Boolean [read-only]
If true, the Book has been saved since it was created. | Book | ||
smartMatchStyleGroups : SmartMatchOptions
How to match styles with same name while synchronizing a book. | Book | ||
styleSourceDocument : Object
Current style source document. | Book | ||
synchronizeBulletNumberingList : Boolean
If true, synchronize bullets and numbering. | Book | ||
synchronizeCellStyle : Boolean
If true, synchronize cell styles. | Book | ||
synchronizeCharacterStyle : Boolean
If true, synchronize character styles. | Book | ||
synchronizeConditionalText : Boolean
If true, synchronize conditional text. | Book | ||
synchronizeMasterPage : Boolean
If true, synchronize master pages. | Book | ||
synchronizeObjectStyle : Boolean
If true, synchronize object styles. | Book | ||
synchronizeParagraphStyle : Boolean
If true, synchronize paragraph styles. | Book | ||
synchronizeSwatch : Boolean
If true, synchronize swatches. | Book | ||
synchronizeTableOfContentStyle : Boolean
If true, synchronize table of content styles. | Book | ||
synchronizeTableStyle : Boolean
If true, synchronize table styles. | Book | ||
synchronizeTextVariable : Boolean
If true, synchronize text variables. | Book | ||
synchronizeTrapStyle : Boolean
If true, synchronize trap styles. | Book |
Method | Defined By | ||
---|---|---|---|
addEventListenerBook(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | Book | ||
close(savingParam:SaveOptions = null, savingInParam:File = null, versionCommentsParam:String = null, forceSaveParam:Boolean = false):void
Close the Book
| Book | ||
exportFile(formatParam:Object = null, toParam:File = null, showingOptionsParam:Boolean = false, usingParam:PDFExportPreset = null, whichDocumentsParam:Array = null, versionCommentsParam:String = null, forceSaveParam:Boolean = false):void
Exports the book to a file. | Book | ||
extractLabel(keyParam:String = null):String
Gets the label value associated with the specified key. | Book | ||
![]() | 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. | Book | ||
![]() | 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. | Book | ||
![]() | 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 | |
packageForPrint(toParam:File = null, copyingFontsParam:Boolean, copyingLinkedGraphicsParam:Boolean, copyingProfilesParam:Boolean, updatingGraphicsParam:Boolean, includingHiddenLayersParam:Boolean, ignorePreflightErrorsParam:Boolean, creatingReportParam:Boolean, versionCommentsParam:String = null, forceSaveParam:Boolean = false):Boolean
Packages the document. | Book | ||
preflight(toParam:File = null, autoOpenParam:Boolean = false):void
Preflight a book and optionally save the resulting report. | Book | ||
print(printDialogParam:Boolean, usingParam:Object = null):void
Prints the Book(s). | Book | ||
removeEventListenerBook(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | Book | ||
repaginate():void
Repaginates the book. | Book | ||
![]() | replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call. | CSHostObject | |
save(toParam:File = null, versionCommentsParam:String = null, forceSaveParam:Boolean = false):void
Saves the book. | Book | ||
synchronize():void
Synchronizes the entire book to the style source document. | Book | ||
toSpecifier():String
Retrieves the object specifier. | Book | ||
updateAllCrossReferences():void
Updates the cross references in the entire book. | Book | ||
updateAllNumbers():void
Update all numbers (e.g. | Book | ||
Updates chapter numbers and paragraph numbers throughout the book. | Book | ||
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject |
automaticDocumentConversion | property |
automaticDocumentConversion:Boolean
Since : | CS5 |
If true, automatically converts the book content object during repagination and synchronization.
public function get automaticDocumentConversion():Boolean
public function set automaticDocumentConversion(value:Boolean):void
automaticPagination | property |
automaticPagination:Boolean
Since : | CS5 |
If true, automatically updates page numbers when pages in book content files are added, deleted, or rearranged.
public function get automaticPagination():Boolean
public function set automaticPagination(value:Boolean):void
bookContents | property |
bookContents:BookContents
[read-only] Since : | CS5 |
A collection of book content objects.
public function get bookContents():BookContents
epubExportPreferences | property |
epubExportPreferences:EPubExportPreference
[read-only] Since : | CS5.5 |
EPub export preference settings.
public function get epubExportPreferences():EPubExportPreference
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 Book, including the name of the Book.
public function get fullName():File
index | property |
index:Number
[read-only] Since : | CS5 |
The index of the Book within its containing object.
public function get index():Number
insertBlankPage | property |
insertBlankPage:Boolean
Since : | CS5 |
If true, inserts a blank page as necessary to fill in page number gaps caused by the odd or even specification set in the repagination option.
public function get insertBlankPage():Boolean
public function set insertBlankPage(value:Boolean):void
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
mergeIdenticalLayers | property |
mergeIdenticalLayers:Boolean
Since : | CS5 |
If true, merges identically named layers when exporting to PDF.
public function get mergeIdenticalLayers():Boolean
public function set mergeIdenticalLayers(value:Boolean):void
modified | property |
modified:Boolean
[read-only] Since : | CS5 |
If true, the Book has been modified since it was last saved.
public function get modified():Boolean
name | property |
name:String
[read-only] Since : | CS5 |
The name of the Book.
public function get name():String
parent | property |
parent:Application
[read-only] Since : | CS5 |
The parent of the Book (a Application).
public function get parent():Application
preferences | property |
preferences:Preferences
[read-only] Since : | CS5 |
A collection of preferences objects.
public function get preferences():Preferences
preflightBookOptions | property |
preflightBookOptions:PreflightBookOption
[read-only] Since : | CS5 |
Preflight book option settings.
public function get preflightBookOptions():PreflightBookOption
printPreferences | property |
printPreferences:PrintPreference
[read-only] Since : | CS5 |
Print preference settings.
public function get printPreferences():PrintPreference
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
repaginationOption | property |
repaginationOption:RepaginateOption
Since : | CS5 |
Page numbering options for book content objects within the book.
public function get repaginationOption():RepaginateOption
public function set repaginationOption(value:RepaginateOption):void
saved | property |
saved:Boolean
[read-only] Since : | CS5 |
If true, the Book has been saved since it was created.
public function get saved():Boolean
smartMatchStyleGroups | property |
smartMatchStyleGroups:SmartMatchOptions
Since : | CS5 |
How to match styles with same name while synchronizing a book.
public function get smartMatchStyleGroups():SmartMatchOptions
public function set smartMatchStyleGroups(value:SmartMatchOptions):void
styleSourceDocument | property |
styleSourceDocument:Object
Since : | CS5 |
Current style source document. Can return: Document or BookContent.
public function get styleSourceDocument():Object
public function set styleSourceDocument(value:Object):void
synchronizeBulletNumberingList | property |
synchronizeBulletNumberingList:Boolean
Since : | CS5 |
If true, synchronize bullets and numbering.
public function get synchronizeBulletNumberingList():Boolean
public function set synchronizeBulletNumberingList(value:Boolean):void
synchronizeCellStyle | property |
synchronizeCellStyle:Boolean
Since : | CS5 |
If true, synchronize cell styles.
public function get synchronizeCellStyle():Boolean
public function set synchronizeCellStyle(value:Boolean):void
synchronizeCharacterStyle | property |
synchronizeCharacterStyle:Boolean
Since : | CS5 |
If true, synchronize character styles.
public function get synchronizeCharacterStyle():Boolean
public function set synchronizeCharacterStyle(value:Boolean):void
synchronizeConditionalText | property |
synchronizeConditionalText:Boolean
Since : | CS5 |
If true, synchronize conditional text.
public function get synchronizeConditionalText():Boolean
public function set synchronizeConditionalText(value:Boolean):void
synchronizeMasterPage | property |
synchronizeMasterPage:Boolean
Since : | CS5 |
If true, synchronize master pages.
public function get synchronizeMasterPage():Boolean
public function set synchronizeMasterPage(value:Boolean):void
synchronizeObjectStyle | property |
synchronizeObjectStyle:Boolean
Since : | CS5 |
If true, synchronize object styles.
public function get synchronizeObjectStyle():Boolean
public function set synchronizeObjectStyle(value:Boolean):void
synchronizeParagraphStyle | property |
synchronizeParagraphStyle:Boolean
Since : | CS5 |
If true, synchronize paragraph styles.
public function get synchronizeParagraphStyle():Boolean
public function set synchronizeParagraphStyle(value:Boolean):void
synchronizeSwatch | property |
synchronizeSwatch:Boolean
Since : | CS5 |
If true, synchronize swatches.
public function get synchronizeSwatch():Boolean
public function set synchronizeSwatch(value:Boolean):void
synchronizeTableOfContentStyle | property |
synchronizeTableOfContentStyle:Boolean
Since : | CS5 |
If true, synchronize table of content styles.
public function get synchronizeTableOfContentStyle():Boolean
public function set synchronizeTableOfContentStyle(value:Boolean):void
synchronizeTableStyle | property |
synchronizeTableStyle:Boolean
Since : | CS5 |
If true, synchronize table styles.
public function get synchronizeTableStyle():Boolean
public function set synchronizeTableStyle(value:Boolean):void
synchronizeTextVariable | property |
synchronizeTextVariable:Boolean
Since : | CS5 |
If true, synchronize text variables.
public function get synchronizeTextVariable():Boolean
public function set synchronizeTextVariable(value:Boolean):void
synchronizeTrapStyle | property |
synchronizeTrapStyle:Boolean
Since : | CS5 |
If true, synchronize trap styles.
public function get synchronizeTrapStyle():Boolean
public function set synchronizeTrapStyle(value:Boolean):void
addEventListenerBook | () | method |
public function addEventListenerBook(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 |
close | () | method |
public function close(savingParam:SaveOptions = null, savingInParam:File = null, versionCommentsParam:String = null, forceSaveParam:Boolean = false):void
Since : | CS5 |
Close the Book
Parameters
savingParam:SaveOptions (default = null ) — (SaveOptions) Whether to save changes before closing the Book (Optional)
| |
savingInParam:File (default = null ) — (File) The file in which to save the Book (Optional)
| |
versionCommentsParam:String (default = null ) — (String) The comment for this version (Optional)
| |
forceSaveParam:Boolean (default = false ) — (Boolean) Forcibly save a version (Optional)
|
exportFile | () | method |
public function exportFile(formatParam:Object = null, toParam:File = null, showingOptionsParam:Boolean = false, usingParam:PDFExportPreset = null, whichDocumentsParam:Array = null, versionCommentsParam:String = null, forceSaveParam:Boolean = false):void
Since : | CS5 |
Exports the book to a file.
Parameters
formatParam:Object (default = null ) — (Object) The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String.
| |
toParam:File (default = null ) — (File) The file to which to export the book. (Optional)
| |
showingOptionsParam:Boolean (default = false ) — (Boolean) Used to specify if the PDF Export Options Dialog needs to be shown or not (Optional)
| |
usingParam:PDFExportPreset (default = null ) — (PDFExportPreset) Used to specify the presets for the export which can be the object of the preset type, enumeration for existing presets or user defined presets, or a string naming the preset to be used, but in case Showing Options is true, the preset specified in the Export Dialog will over ride this parameter (Optional)
| |
whichDocumentsParam:Array (default = null ) — (Array) Used to specify a list of book content references, from the current book, where the list may contain duplicate entries and if the list is not specified then the entire book contents shall be exported (Optional)
| |
versionCommentsParam:String (default = null ) — (String) The comment for this version. (Optional)
| |
forceSaveParam:Boolean (default = false ) — (Boolean) If true, forcibly saves a version. (Optional)
|
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.
|
packageForPrint | () | method |
public function packageForPrint(toParam:File = null, copyingFontsParam:Boolean, copyingLinkedGraphicsParam:Boolean, copyingProfilesParam:Boolean, updatingGraphicsParam:Boolean, includingHiddenLayersParam:Boolean, ignorePreflightErrorsParam:Boolean, creatingReportParam:Boolean, versionCommentsParam:String = null, forceSaveParam:Boolean = false):Boolean
Since : | CS5 |
Packages the document.
Parameters
toParam:File (default = null ) — (File) The folder, alias, or path in which to place the packaged files.
| |
copyingFontsParam:Boolean (default = NaN ) — (Boolean) If true, copies fonts used in the document to the package folder.
| |
copyingLinkedGraphicsParam:Boolean (default = NaN ) — (Boolean) If true, copies linked graphics files to the package folder.
| |
copyingProfilesParam:Boolean (default = NaN ) — (Boolean) If true, copies color profiles to the package folder.
| |
updatingGraphicsParam:Boolean (default = NaN ) — (Boolean) If true, updates graphics links to the package folder.
| |
includingHiddenLayersParam:Boolean (default = NaN ) — (Boolean) If true, copies fonts and links from hidden layers to the package.
| |
ignorePreflightErrorsParam:Boolean (default = NaN ) — (Boolean) If true, ignores preflight errors and proceeds with the packaging. If false, cancels the packaging when errors exist.
| |
creatingReportParam:Boolean (default = NaN ) — (Boolean) If true, creates a package report that includes printing instructions, print settings, lists of fonts, links and required inks, and other information.
| |
versionCommentsParam:String (default = null ) — (String) The comments for the version. (Optional)
| |
forceSaveParam:Boolean (default = false ) — (Boolean) If true, forcibly saves a version. (Optional)
|
Boolean |
preflight | () | method |
public function preflight(toParam:File = null, autoOpenParam:Boolean = false):void
Since : | CS5 |
Preflight a book 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)
|
() | method |
public function print(printDialogParam:Boolean, usingParam:Object = null):void
Since : | CS5 |
Prints the Book(s).
Parameters
printDialogParam:Boolean (default = NaN ) — (Boolean) Whether to invoke the print dialog (Optional)
| |
usingParam:Object (default = null ) — (Object) Printer preset to use. Can accept: PrinterPresetTypes enumerator or PrinterPreset. (Optional)
|
removeEventListenerBook | () | method |
public function removeEventListenerBook(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 |
repaginate | () | method |
public function repaginate():void
Since : | CS5 |
Repaginates the book.
save | () | method |
public function save(toParam:File = null, versionCommentsParam:String = null, forceSaveParam:Boolean = false):void
Since : | CS5 |
Saves the book.
Parameters
toParam:File (default = null ) — (File) The file path. Note: Required only if the book has not been previously saved. If the book has previously been saved, specifying a path saves a copy and closes the original book. (Optional)
| |
versionCommentsParam:String (default = null ) — (String) The comment for this version. (Optional)
| |
forceSaveParam:Boolean (default = false ) — (Boolean) If true, forcibly saves a version. (Optional)
|
synchronize | () | method |
public function synchronize():void
Since : | CS5 |
Synchronizes the entire book to the style source document.
toSpecifier | () | method |
public function toSpecifier():String
Since : | CS5 |
Retrieves the object specifier.
ReturnsString |
updateAllCrossReferences | () | method |
public function updateAllCrossReferences():void
Since : | CS5 |
Updates the cross references in the entire book.
updateAllNumbers | () | method |
public function updateAllNumbers():void
Since : | CS5 |
Update all numbers (e.g. Page numbers, chapter numbers and paragraph numbers) throughout the book.
updateChapterAndParagraphNumbers | () | method |
public function updateChapterAndParagraphNumbers():void
Since : | CS5 |
Updates chapter numbers and paragraph numbers throughout the book.