Package | com.adobe.indesign |
Class | public class EPubExportPreference |
Inheritance | EPubExportPreference ![]() ![]() ![]() |
Since : | CS5.5 |
Property | Defined By | ||
---|---|---|---|
applyImageAlignmentToAnchoredObjectSettings : Boolean
apply image alignment to anchored object settings. | EPubExportPreference | ||
bottomMargin : Number
Bottom margin of the epub. | EPubExportPreference | ||
breakDocument : Boolean
If true, break InDesign document into smaller piece when generating epub. | EPubExportPreference | ||
bulletExportOption : BulletListExportOption
The bullet export option. | EPubExportPreference | ||
coverImageFile : String
The epub cover image file path. | EPubExportPreference | ||
cssExportOption : StyleSheetExportOption
The cascading style sheet export option. | EPubExportPreference | ||
customImageSizeOption : ImageSizeOption
Allows user to select the image size option for conversion
| EPubExportPreference | ||
embedFont : Boolean
If true, embed font in epub. | EPubExportPreference | ||
epubCover : EpubCover
The epub cover option. | EPubExportPreference | ||
epubPublisher : String
The epub publisher. | EPubExportPreference | ||
eventListeners : EventListeners [override] [read-only]
A collection of event listeners. | EPubExportPreference | ||
events : Events [override] [read-only]
A collection of events. | EPubExportPreference | ||
exportOrder : ExportOrder
The export order. | EPubExportPreference | ||
externalCSSPath : String
The file path of external cascading style sheet. | EPubExportPreference | ||
footnoteFollowParagraph : Boolean
If true, output footnote immediately after its paragraph. | EPubExportPreference | ||
format : Boolean
If true, export epub in XHTML format. | EPubExportPreference | ||
gifOptionsInterlaced : Boolean
If true, generates interlaced GIFs. | EPubExportPreference | ||
gifOptionsPalette : GIFOptionsPalette
The color palette for GIF conversion. | EPubExportPreference | ||
![]() | hostObjectDelegate : HostObject Getter for the delegate | CSHostObject | |
id : String
The epub unique identifier, like ISBN. | EPubExportPreference | ||
ignoreObjectConversionSettings : Boolean
ignore object level image conversion settings. | EPubExportPreference | ||
imageAlignment : ImageAlignmentType
Alignment applied to images
| EPubExportPreference | ||
imageConversion : ImageConversion
The file format to use for converted images. | EPubExportPreference | ||
imageExportResolution : ImageResolution
The export resolution
| EPubExportPreference | ||
imagePageBreak : ImagePageBreakType
Image page break settings to be used with objects
| EPubExportPreference | ||
imageSpaceAfter : Number
Space After applied to images
| EPubExportPreference | ||
imageSpaceBefore : Number
Space Before applied to images
| EPubExportPreference | ||
includeCSSDefinition : Boolean
If true, include CSS definition. | EPubExportPreference | ||
includeDocumentMetadata : Boolean
If true, output document metadata into epub. | EPubExportPreference | ||
isValid : Boolean [override] [read-only]
Returns true if the object specifier resolves to valid objects. | EPubExportPreference | ||
jpegOptionsFormat : JPEGOptionsFormat
The formatting method for converted JPEG images. | EPubExportPreference | ||
jpegOptionsQuality : JPEGOptionsQuality
The quality of converted JPEG images. | EPubExportPreference | ||
leftMargin : Number
Left margin of the epub. | EPubExportPreference | ||
level : Number
The PNG compression level. | EPubExportPreference | ||
marginUnit : SpaceUnitType
The unit of margin. | EPubExportPreference | ||
numberedListExportOption : NumberedListExportOption
The numbered list export option. | EPubExportPreference | ||
paragraphStyleName : String
The name of paragraph style to break InDesign document. | EPubExportPreference | ||
parent : Object [override] [read-only]
The parent of the EPubExportPreference (a Book or Document). | EPubExportPreference | ||
preserveLayoutAppearence : Boolean
If true, format image based on layout appearence. | EPubExportPreference | ||
preserveLocalOverride : Boolean
If true, output local style override. | EPubExportPreference | ||
properties : Object [override]
A property that allows setting of several properties at the same time. | EPubExportPreference | ||
rightMargin : Number
Right margin of the epub. | EPubExportPreference | ||
spaceUnit : SpaceUnitType
The unit of space. | EPubExportPreference | ||
stripSoftReturn : Boolean
If true, strip soft return. | EPubExportPreference | ||
tocStyleName : String
The name of TOC style to generate epub TOC. | EPubExportPreference | ||
topMargin : Number
Top margin of the epub. | EPubExportPreference | ||
useImagePageBreak : Boolean
If true, image page break settings will be used in objects
| EPubExportPreference | ||
useTocStyle : Boolean
Use InDesign TOC style to generate epub TOC. | EPubExportPreference | ||
viewDocumentAfterExport : Boolean
If true, open docuemnt in viewer after export. | EPubExportPreference |
Method | Defined By | ||
---|---|---|---|
addEventListenerEPubExportPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | EPubExportPreference | ||
![]() | addEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | Preference | |
![]() | 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 [override]
Resolves the object specifier, creating an array of object references. | EPubExportPreference | ||
![]() | 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 | |
removeEventListenerEPubExportPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | EPubExportPreference | ||
![]() | removeEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | Preference | |
![]() | replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call. | CSHostObject | |
toSpecifier():String [override]
Retrieves the object specifier. | EPubExportPreference | ||
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject |
applyImageAlignmentToAnchoredObjectSettings | property |
applyImageAlignmentToAnchoredObjectSettings:Boolean
Since : | CS5.5 |
apply image alignment to anchored object settings.
public function get applyImageAlignmentToAnchoredObjectSettings():Boolean
public function set applyImageAlignmentToAnchoredObjectSettings(value:Boolean):void
bottomMargin | property |
bottomMargin:Number
Since : | CS5.5 |
Bottom margin of the epub.
public function get bottomMargin():Number
public function set bottomMargin(value:Number):void
breakDocument | property |
breakDocument:Boolean
Since : | CS5.5 |
If true, break InDesign document into smaller piece when generating epub.
public function get breakDocument():Boolean
public function set breakDocument(value:Boolean):void
bulletExportOption | property |
bulletExportOption:BulletListExportOption
Since : | CS5.5 |
The bullet export option.
public function get bulletExportOption():BulletListExportOption
public function set bulletExportOption(value:BulletListExportOption):void
coverImageFile | property |
coverImageFile:String
Since : | CS5.5 |
The epub cover image file path.
public function get coverImageFile():String
public function set coverImageFile(value:String):void
cssExportOption | property |
cssExportOption:StyleSheetExportOption
Since : | CS5.5 |
The cascading style sheet export option.
public function get cssExportOption():StyleSheetExportOption
public function set cssExportOption(value:StyleSheetExportOption):void
customImageSizeOption | property |
customImageSizeOption:ImageSizeOption
Since : | CS5.5 |
Allows user to select the image size option for conversion
public function get customImageSizeOption():ImageSizeOption
public function set customImageSizeOption(value:ImageSizeOption):void
embedFont | property |
embedFont:Boolean
Since : | CS5.5 |
If true, embed font in epub.
public function get embedFont():Boolean
public function set embedFont(value:Boolean):void
epubCover | property |
epubCover:EpubCover
Since : | CS5.5 |
The epub cover option.
public function get epubCover():EpubCover
public function set epubCover(value:EpubCover):void
epubPublisher | property |
epubPublisher:String
Since : | CS5.5 |
The epub publisher.
public function get epubPublisher():String
public function set epubPublisher(value:String):void
eventListeners | property |
eventListeners:EventListeners
[read-only] [override] Since : | CS5.5 |
A collection of event listeners.
public function get eventListeners():EventListeners
events | property |
events:Events
[read-only] [override] Since : | CS5.5 |
A collection of events.
public function get events():Events
exportOrder | property |
exportOrder:ExportOrder
Since : | CS5.5 |
The export order.
public function get exportOrder():ExportOrder
public function set exportOrder(value:ExportOrder):void
externalCSSPath | property |
externalCSSPath:String
Since : | CS5.5 |
The file path of external cascading style sheet.
public function get externalCSSPath():String
public function set externalCSSPath(value:String):void
footnoteFollowParagraph | property |
footnoteFollowParagraph:Boolean
Since : | CS5.5 |
If true, output footnote immediately after its paragraph.
public function get footnoteFollowParagraph():Boolean
public function set footnoteFollowParagraph(value:Boolean):void
format | property |
format:Boolean
Since : | CS5.5 |
If true, export epub in XHTML format. Otherwise, in DTBook format.
public function get format():Boolean
public function set format(value:Boolean):void
gifOptionsInterlaced | property |
gifOptionsInterlaced:Boolean
Since : | CS5.5 |
If true, generates interlaced GIFs. Note: Not valid when image conversion is JPEG.
public function get gifOptionsInterlaced():Boolean
public function set gifOptionsInterlaced(value:Boolean):void
gifOptionsPalette | property |
gifOptionsPalette:GIFOptionsPalette
Since : | CS5.5 |
The color palette for GIF conversion. Note: Not valid when image conversion is JPEG.
public function get gifOptionsPalette():GIFOptionsPalette
public function set gifOptionsPalette(value:GIFOptionsPalette):void
id | property |
id:String
Since : | CS5.5 |
The epub unique identifier, like ISBN.
public function get id():String
public function set id(value:String):void
ignoreObjectConversionSettings | property |
ignoreObjectConversionSettings:Boolean
Since : | CS5.5 |
ignore object level image conversion settings.
public function get ignoreObjectConversionSettings():Boolean
public function set ignoreObjectConversionSettings(value:Boolean):void
imageAlignment | property |
imageAlignment:ImageAlignmentType
Since : | CS5.5 |
Alignment applied to images
public function get imageAlignment():ImageAlignmentType
public function set imageAlignment(value:ImageAlignmentType):void
imageConversion | property |
imageConversion:ImageConversion
Since : | CS5.5 |
The file format to use for converted images. Note: Valid only when copy optimized images and/or copy formatted images is true.
public function get imageConversion():ImageConversion
public function set imageConversion(value:ImageConversion):void
imageExportResolution | property |
imageExportResolution:ImageResolution
Since : | CS5.5 |
The export resolution
public function get imageExportResolution():ImageResolution
public function set imageExportResolution(value:ImageResolution):void
imagePageBreak | property |
imagePageBreak:ImagePageBreakType
Since : | CS5.5 |
Image page break settings to be used with objects
public function get imagePageBreak():ImagePageBreakType
public function set imagePageBreak(value:ImagePageBreakType):void
imageSpaceAfter | property |
imageSpaceAfter:Number
Since : | CS5.5 |
Space After applied to images
public function get imageSpaceAfter():Number
public function set imageSpaceAfter(value:Number):void
imageSpaceBefore | property |
imageSpaceBefore:Number
Since : | CS5.5 |
Space Before applied to images
public function get imageSpaceBefore():Number
public function set imageSpaceBefore(value:Number):void
includeCSSDefinition | property |
includeCSSDefinition:Boolean
Since : | CS5.5 |
If true, include CSS definition.
public function get includeCSSDefinition():Boolean
public function set includeCSSDefinition(value:Boolean):void
includeDocumentMetadata | property |
includeDocumentMetadata:Boolean
Since : | CS5.5 |
If true, output document metadata into epub.
public function get includeDocumentMetadata():Boolean
public function set includeDocumentMetadata(value:Boolean):void
isValid | property |
isValid:Boolean
[read-only] [override] Since : | CS5.5 |
Returns true if the object specifier resolves to valid objects.
public function get isValid():Boolean
jpegOptionsFormat | property |
jpegOptionsFormat:JPEGOptionsFormat
Since : | CS5.5 |
The formatting method for converted JPEG images. Note: Not valid when image conversion is GIF.
public function get jpegOptionsFormat():JPEGOptionsFormat
public function set jpegOptionsFormat(value:JPEGOptionsFormat):void
jpegOptionsQuality | property |
jpegOptionsQuality:JPEGOptionsQuality
Since : | CS5.5 |
The quality of converted JPEG images. Note: Not valid when image conversion is GIF.
public function get jpegOptionsQuality():JPEGOptionsQuality
public function set jpegOptionsQuality(value:JPEGOptionsQuality):void
leftMargin | property |
leftMargin:Number
Since : | CS5.5 |
Left margin of the epub.
public function get leftMargin():Number
public function set leftMargin(value:Number):void
level | property |
level:Number
Since : | CS5.5 |
The PNG compression level.
public function get level():Number
public function set level(value:Number):void
marginUnit | property |
marginUnit:SpaceUnitType
Since : | CS5.5 |
The unit of margin.
public function get marginUnit():SpaceUnitType
public function set marginUnit(value:SpaceUnitType):void
numberedListExportOption | property |
numberedListExportOption:NumberedListExportOption
Since : | CS5.5 |
The numbered list export option.
public function get numberedListExportOption():NumberedListExportOption
public function set numberedListExportOption(value:NumberedListExportOption):void
paragraphStyleName | property |
paragraphStyleName:String
Since : | CS5.5 |
The name of paragraph style to break InDesign document.
public function get paragraphStyleName():String
public function set paragraphStyleName(value:String):void
parent | property |
parent:Object
[read-only] [override] Since : | CS5.5 |
The parent of the EPubExportPreference (a Book or Document).
public function get parent():Object
preserveLayoutAppearence | property |
preserveLayoutAppearence:Boolean
Since : | CS5.5 |
If true, format image based on layout appearence.
public function get preserveLayoutAppearence():Boolean
public function set preserveLayoutAppearence(value:Boolean):void
preserveLocalOverride | property |
preserveLocalOverride:Boolean
Since : | CS5.5 |
If true, output local style override.
public function get preserveLocalOverride():Boolean
public function set preserveLocalOverride(value:Boolean):void
properties | property |
properties:Object
[override] Since : | CS5.5 |
A property that allows setting of several properties at the same time.
public function get properties():Object
public function set properties(value:Object):void
rightMargin | property |
rightMargin:Number
Since : | CS5.5 |
Right margin of the epub.
public function get rightMargin():Number
public function set rightMargin(value:Number):void
spaceUnit | property |
spaceUnit:SpaceUnitType
Since : | CS5.5 |
The unit of space.
public function get spaceUnit():SpaceUnitType
public function set spaceUnit(value:SpaceUnitType):void
stripSoftReturn | property |
stripSoftReturn:Boolean
Since : | CS5.5 |
If true, strip soft return.
public function get stripSoftReturn():Boolean
public function set stripSoftReturn(value:Boolean):void
tocStyleName | property |
tocStyleName:String
Since : | CS5.5 |
The name of TOC style to generate epub TOC.
public function get tocStyleName():String
public function set tocStyleName(value:String):void
topMargin | property |
topMargin:Number
Since : | CS5.5 |
Top margin of the epub.
public function get topMargin():Number
public function set topMargin(value:Number):void
useImagePageBreak | property |
useImagePageBreak:Boolean
Since : | CS5.5 |
If true, image page break settings will be used in objects
public function get useImagePageBreak():Boolean
public function set useImagePageBreak(value:Boolean):void
useTocStyle | property |
useTocStyle:Boolean
Since : | CS5.5 |
Use InDesign TOC style to generate epub TOC.
public function get useTocStyle():Boolean
public function set useTocStyle(value:Boolean):void
viewDocumentAfterExport | property |
viewDocumentAfterExport:Boolean
Since : | CS5.5 |
If true, open docuemnt in viewer after export.
public function get viewDocumentAfterExport():Boolean
public function set viewDocumentAfterExport(value:Boolean):void
addEventListenerEPubExportPreference | () | method |
public function addEventListenerEPubExportPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Since : | CS5.5 |
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 |
override public function getElements():Object
Since : | CS5.5 |
Resolves the object specifier, creating an array of object references.
ReturnsObject |
removeEventListenerEPubExportPreference | () | method |
public function removeEventListenerEPubExportPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Since : | CS5.5 |
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 |
override public function toSpecifier():String
Since : | CS5.5 |
Retrieves the object specifier.
ReturnsString |