All Implemented Interfaces:: org.readium.r2.navigator.preferences.Configurable.Preferences

@Serializable() 
public final class EpubPreferences
 implements Configurable.Preferences<EpubPreferences>

Preferences for the EPUB navigator.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public class`	`EpubPreferences.Companion`

Field Summary

Fields
Modifier and Type	Field	Description
`private final Color`	`backgroundColor`
`private final ColumnCount`	`columnCount`
`private final FontFamily`	`fontFamily`
`private final Double`	`fontSize`
`private final Double`	`fontWeight`
`private final Boolean`	`hyphens`
`private final ImageFilter`	`imageFilter`
`private final Language`	`language`
`private final Double`	`letterSpacing`
`private final Boolean`	`ligatures`
`private final Double`	`lineHeight`
`private final Double`	`pageMargins`
`private final Double`	`paragraphIndent`
`private final Double`	`paragraphSpacing`
`private final Boolean`	`publisherStyles`
`private final ReadingProgression`	`readingProgression`
`private final Boolean`	`scroll`
`private final Spread`	`spread`
`private final TextAlign`	`textAlign`
`private final Color`	`textColor`
`private final Boolean`	`textNormalization`
`private final Theme`	`theme`
`private final Double`	`typeScale`
`private final Boolean`	`verticalText`
`private final Double`	`wordSpacing`

Constructor Summary

Constructors
Constructor	Description
EpubPreferences(Color backgroundColor, ColumnCount columnCount, FontFamily fontFamily, Double fontSize, Double fontWeight, Boolean hyphens, ImageFilter imageFilter, Language language, Double letterSpacing, Boolean ligatures, Double lineHeight, Double pageMargins, Double paragraphIndent, Double paragraphSpacing, Boolean publisherStyles, ReadingProgression readingProgression, Boolean scroll, Spread spread, TextAlign textAlign, Color textColor, Boolean textNormalization, Theme theme, Double typeScale, Boolean verticalText, Double wordSpacing)

Method Summary

Modifier and Type	Method	Description
`final Color`	`getBackgroundColor()`
`final ColumnCount`	`getColumnCount()`
`final FontFamily`	`getFontFamily()`
`final Double`	`getFontSize()`
`final Double`	`getFontWeight()`
`final Boolean`	`getHyphens()`
`final ImageFilter`	`getImageFilter()`
`final Language`	`getLanguage()`
`final Double`	`getLetterSpacing()`
`final Boolean`	`getLigatures()`
`final Double`	`getLineHeight()`
`final Double`	`getPageMargins()`
`final Double`	`getParagraphIndent()`
`final Double`	`getParagraphSpacing()`
`final Boolean`	`getPublisherStyles()`
`final ReadingProgression`	`getReadingProgression()`
`final Boolean`	`getScroll()`
`final Spread`	`getSpread()`
`final TextAlign`	`getTextAlign()`
`final Color`	`getTextColor()`
`final Boolean`	`getTextNormalization()`
`final Theme`	`getTheme()`
`final Double`	`getTypeScale()`
`final Boolean`	`getVerticalText()`
`final Double`	`getWordSpacing()`
`EpubPreferences`	`plus(EpubPreferences other)`	Creates a new instance of P after merging the values of other.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - EpubPreferences
```
EpubPreferences(Color backgroundColor, ColumnCount columnCount, FontFamily fontFamily, Double fontSize, Double fontWeight, Boolean hyphens, ImageFilter imageFilter, Language language, Double letterSpacing, Boolean ligatures, Double lineHeight, Double pageMargins, Double paragraphIndent, Double paragraphSpacing, Boolean publisherStyles, ReadingProgression readingProgression, Boolean scroll, Spread spread, TextAlign textAlign, Color textColor, Boolean textNormalization, Theme theme, Double typeScale, Boolean verticalText, Double wordSpacing)
```
    Parameters:
    
    backgroundColor - Default page background color.
    
    columnCount - Number of reflowable columns to display (one-page view or two-page spread).
    
    fontFamily - Default typeface for the text.
    
    fontSize - Base text font size.
    
    fontWeight - Default boldness for the text.
    
    hyphens - Enable hyphenation.
    
    imageFilter - Filter applied to images in dark theme.
    
    language - Language of the publication content.
    
    letterSpacing - Space between letters.
    
    ligatures - Enable ligatures in Arabic.
    
    lineHeight - Leading line height.
    
    pageMargins - Factor applied to horizontal margins.
    
    paragraphIndent - Text indentation for paragraphs.
    
    paragraphSpacing - Vertical margins for paragraphs.
    
    publisherStyles - Indicates whether the original publisher styles should be observed.
    
    readingProgression - Direction of the reading progression across resources.
    
    scroll - Indicates if the overflow of resources should be handled using scrolling instead of synthetic pagination.
    
    spread - Indicates if the fixed-layout publication should be rendered with a synthetic spread (dual-page).
    
    textAlign - Page text alignment.
    
    textColor - Default page text color.
    
    textNormalization - Normalize text styles to increase accessibility.
    
    theme - Reader theme.
    
    typeScale - Scale applied to all element font sizes.
    
    verticalText - Indicates whether the text should be laid out vertically.
    
    wordSpacing - Space between words.
- Method Detail
  - getBackgroundColor
```
 final Color getBackgroundColor()
```
  - getColumnCount
```
 final ColumnCount getColumnCount()
```
  - getFontFamily
```
 final FontFamily getFontFamily()
```
  - getFontSize
```
 final Double getFontSize()
```
  - getFontWeight
```
 final Double getFontWeight()
```
  - getHyphens
```
 final Boolean getHyphens()
```
  - getImageFilter
```
 final ImageFilter getImageFilter()
```
  - getLanguage
```
 final Language getLanguage()
```
  - getLetterSpacing
```
 final Double getLetterSpacing()
```
  - getLigatures
```
 final Boolean getLigatures()
```
  - getLineHeight
```
 final Double getLineHeight()
```
  - getPageMargins
```
 final Double getPageMargins()
```
  - getParagraphIndent
```
 final Double getParagraphIndent()
```
  - getParagraphSpacing
```
 final Double getParagraphSpacing()
```
  - getPublisherStyles
```
 final Boolean getPublisherStyles()
```
  - getReadingProgression
```
 final ReadingProgression getReadingProgression()
```
  - getScroll
```
 final Boolean getScroll()
```
  - getSpread
```
 final Spread getSpread()
```
  - getTextAlign
```
 final TextAlign getTextAlign()
```
  - getTextColor
```
 final Color getTextColor()
```
  - getTextNormalization
```
 final Boolean getTextNormalization()
```
  - getTheme
```
 final Theme getTheme()
```
  - getTypeScale
```
 final Double getTypeScale()
```
  - getVerticalText
```
 final Boolean getVerticalText()
```
  - getWordSpacing
```
 final Double getWordSpacing()
```
  - plus
```
 EpubPreferences plus(EpubPreferences other)
```
    Creates a new instance of P after merging the values of other.
    In case of conflict, other takes precedence.

Class EpubPreferences

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EpubPreferences

Method Detail

getBackgroundColor

getColumnCount

getFontFamily

getFontSize

getFontWeight

getHyphens

getImageFilter

getLanguage

getLetterSpacing

getLigatures

getLineHeight

getPageMargins

getParagraphIndent

getParagraphSpacing

getPublisherStyles

getReadingProgression

getScroll

getSpread

getTextAlign

getTextColor

getTextNormalization

getTheme

getTypeScale

getVerticalText

getWordSpacing

plus