EbookEditOptions
Inheritance: java.lang.Object
All Implemented Interfaces: com.groupdocs.editor.options.IEditOptions
public final class EbookEditOptions 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:
Constructors
| Constructor | 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 |
Methods
| Method | Description |
|---|---|
| getEnablePagination() | Allows to enable or disable pagination in the resultant HTML document. |
| setEnablePagination(boolean value) | Allows to enable or disable pagination in the resultant HTML document. |
| getEnableLanguageInformation() | Specifies whether language information is exported to the HTML markup in a form of ’lang’ HTML attributes. |
| setEnableLanguageInformation(boolean value) | Specifies whether language information is exported to the HTML markup in a form of ’lang’ HTML attributes. |
EbookEditOptions()
public EbookEditOptions()
Initializes a new instance of the EbookEditOptions class, where all options are set to their default values
EbookEditOptions(boolean enablePagination)
public EbookEditOptions(boolean enablePagination)
Initializes a new instance of the EbookEditOptions class with specified pagination mode
Parameters:
| Parameter | Type | Description |
|---|---|---|
| enablePagination | boolean | Enables ( true ) or disables ( false ) pagination of the e-book content in the resultant HTML document. By default 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) \u2014 not. This option allows to control how the e-book content should be represented in HTML/CSS while editing \u2014 in the float ( false ) or paged ( true ) view.
Returns: boolean
setEnablePagination(boolean value)
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) \u2014 not. This option allows to control how the e-book content should be represented in HTML/CSS while editing \u2014 in the float ( false ) or paged ( true ) view.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
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 ).
Returns: boolean
setEnableLanguageInformation(boolean value)
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 ).
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |