colibrio-reader-framework/com.colibrio.readingsystem.base/Renderer

Renderer

sealed class Renderer

A Renderer is responsible for the presentation of the ReaderPublication. For example, the Renderer.Stack presents the publication as a series of pages stacked on top of each other like a deck of cards.

Each Renderer implementation has its own set of options to controls its behavior and its visual aspects.

Renderers are added to a ReaderView using ReaderView.addRenderer(). See ReaderView.addRenderer for more information.

Types

FlipBook

class FlipBook(options: FlipBookRendererOptions = FlipBookRendererOptions()) : Renderer

Presents the publication as a book. Two pages are displayed at a time as a spread. You can configure the spread slot (left or right) for the first page using ReaderViewOptions.defaultStartPageSpreadSlot. The page animation resembles a flip book with 3D perspective.

SingleDocumentScroll

class SingleDocumentScroll(options: SingleDocumentScrollRendererOptions = SingleDocumentScrollRendererOptions()) : Renderer

A renderer that shows one document at a time in a scrolling view.

SinglePageSwipe

class SinglePageSwipe(options: SinglePageSwipeRendererOptions = SinglePageSwipeRendererOptions()) : Renderer

Presents the publication as a conveyor belt of single pages. Pages slide in from the sides. The renderer can be configured to slide pages horizontally or vertically. One page is shown at a time.

SpreadSwipe

class SpreadSwipe(options: SpreadSwipeRendererOptions = SpreadSwipeRendererOptions()) : Renderer

Presents the publication as a conveyor belt of spreads. Spreads slide in from the sides. The renderer can be configured to slide spreads horizontally or vertically. Two page is shown at a time as a spread.

Stack

class Stack(options: StackRendererOptions = StackRendererOptions()) : Renderer

Presents the publication as a series of pages stacked on top of each other like a deck of cards. One page is shown at a time.

Inheritors