com.groupdocs.editor.options

Class EbookEditOptions

java.lang.Object

com.groupdocs.editor.options.EbookEditOptions

All Implemented Interfaces:

IEditOptions

public final class EbookEditOptions
extends Object
implements IEditOptions

Allows to specify and adjust custom options for editing E-book documents in all supported formats: ePub, MOBI, and AZW3.

Supported E-book formats:

1. ePub (Electronic Publication)
2. MOBI (MobiPocket)
3. AZW3 (Kindle Format 8t)

Constructor Summary

Constructors

Constructor and Description
EbookEditOptions() Initializes a new instance of the EbookEditOptions class, where all options are set to their default values
EbookEditOptions(boolean enablePagination) Initializes a new instance of the EbookEditOptions class with specified pagination mode

Method Summary

Modifier and Type	Method and Description
boolean	getEnableLanguageInformation() Specifies whether language information is exported to the HTML markup in a form of 'lang' HTML attributes.
boolean	getEnablePagination() Allows to enable or disable pagination in the resultant HTML document.
void	setEnableLanguageInformation(boolean value) Specifies whether language information is exported to the HTML markup in a form of 'lang' HTML attributes.
void	setEnablePagination(boolean value) Allows to enable or disable pagination in the resultant HTML document.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EbookEditOptions

public EbookEditOptions()

Initializes a new instance of the EbookEditOptions class, where all options are set to their default values

EbookEditOptions

public EbookEditOptions(boolean enablePagination)

Initializes a new instance of the EbookEditOptions class with specified pagination mode

Parameters:

enablePagination - Enables (true) or disables (false) pagination of the e-book content in the resultant HTML document. By default is disabled (false).

Method Detail

getEnableLanguageInformation

public final boolean getEnableLanguageInformation()

Specifies whether language information is exported to the HTML markup in a form of 'lang' HTML attributes. This option may be useful for roundtrip conversion of the multi-language documents. By default it is disabled (false).

getEnablePagination

public final boolean getEnablePagination()

Allows to enable or disable pagination in the resultant HTML document. By default is disabled (false).

In its essence most of e-book formats internally is a flow format like Office Open XML, where content is a solid and is splitted onto chapters but not the pages. However, it contains some page-specific info like the page numbers, footnotes, heraders/footers and so on. Some e-book readers perform a splitting of the e-book content onto pages, while others (especially mobile) — not. This option allows to control how the e-book content should be represented in HTML/CSS while editing — in the float (false) or paged (true) view.

setEnableLanguageInformation

public final void setEnableLanguageInformation(boolean value)

Specifies whether language information is exported to the HTML markup in a form of 'lang' HTML attributes. This option may be useful for roundtrip conversion of the multi-language documents. By default it is disabled (false).

setEnablePagination

public final void setEnablePagination(boolean value)

Allows to enable or disable pagination in the resultant HTML document. By default is disabled (false).

In its essence most of e-book formats internally is a flow format like Office Open XML, where content is a solid and is splitted onto chapters but not the pages. However, it contains some page-specific info like the page numbers, footnotes, heraders/footers and so on. Some e-book readers perform a splitting of the e-book content onto pages, while others (especially mobile) — not. This option allows to control how the e-book content should be represented in HTML/CSS while editing — in the float (false) or paged (true) view.