colibrio-reader-framework/com.colibrio.readingsystem.formatadapter.epub/EpubReflowPluginOptions

EpubReflowPluginOptions

data class EpubReflowPluginOptions(val cssForcedPageBreak: Boolean = true, val customCssValuePenalizer: CustomCssValuePenalizerOptions? = null, val customElementPenalizer: CustomElementPenalizerOptions? = null, val customForcedPageBreak: CustomForcedPageBreakOptions? = null, val floatingOrphanPenalizer: FloatingOrphanPenalizerOptions? = null, val fragmentableElements: FragmentableElementsOptions? = null, val listBreak: ListBreakOptions? = null, val mediaShrink: MediaShrinkReflowPluginOptions? = null, val orphanTextPattern: OrphanTextPatternOptions? = null, val unforcedTextBreak: UnforcedTextBreakOptions? = null, val verticalWhitespacePenalizer: VerticalWhitespacePenalizerOptions? = null)

Constructors

Link copied to clipboard
fun EpubReflowPluginOptions(cssForcedPageBreak: Boolean = true, customCssValuePenalizer: CustomCssValuePenalizerOptions? = null, customElementPenalizer: CustomElementPenalizerOptions? = null, customForcedPageBreak: CustomForcedPageBreakOptions? = null, floatingOrphanPenalizer: FloatingOrphanPenalizerOptions? = null, fragmentableElements: FragmentableElementsOptions? = null, listBreak: ListBreakOptions? = null, mediaShrink: MediaShrinkReflowPluginOptions? = null, orphanTextPattern: OrphanTextPatternOptions? = null, unforcedTextBreak: UnforcedTextBreakOptions? = null, verticalWhitespacePenalizer: VerticalWhitespacePenalizerOptions? = null)

Types

Link copied to clipboard
object Companion

Functions

Link copied to clipboard
fun serialize(generator: JsonGenerator)

Properties

Link copied to clipboard
val cssForcedPageBreak: Boolean = true

If enabled, apply forced page-breaks, or avoid soft page-breaks based on the CSS declarations 'page-break-before', 'page-break-after' if equal to one of: 'left', 'right', 'always', 'page', 'verso', 'recto'

Link copied to clipboard
val customCssValuePenalizer: CustomCssValuePenalizerOptions? = null

Add soft page-break penalties based on CSS declarations.

Link copied to clipboard
val customElementPenalizer: CustomElementPenalizerOptions? = null

Add soft page-break penalties based on CSS selectors.

Link copied to clipboard
val customForcedPageBreak: CustomForcedPageBreakOptions? = null

Add forced page-breaks to elements by selector

Link copied to clipboard
val floatingOrphanPenalizer: FloatingOrphanPenalizerOptions? = null

Adds penalties to soft page-breaks immediately after floating elements.

Link copied to clipboard
val fragmentableElements: FragmentableElementsOptions? = null

Defines which elements that are allowed to be fragmented.

Link copied to clipboard
val listBreak: ListBreakOptions? = null

Configures penalties when fragmenting lists.

Link copied to clipboard
val mediaShrink: MediaShrinkReflowPluginOptions? = null

Configures how to shrink images to improve page breaks.

Link copied to clipboard
val orphanTextPattern: OrphanTextPatternOptions? = null

Configures RegExp to give orphan penalties.

Link copied to clipboard
val unforcedTextBreak: UnforcedTextBreakOptions? = null

Configures penalties when fragmenting text.

Link copied to clipboard
val verticalWhitespacePenalizer: VerticalWhitespacePenalizerOptions? = null

Configures penalties based on throw much vertical whitespace that is left after applying a page-break.