OutlineElement

data class OutlineElement(val title: String, val color: Int = DEFAULT_COLOR, val style: Int = Typeface.NORMAL, val typeface: Typeface? = Typeface.DEFAULT, val isExpanded: Boolean = false, val action: Action? = null, val pageLabel: String? = null, val children: List<OutlineElement> = emptyList())

A document outline element (or "table of contents entry"), usually the header of a chapter. Outline elements can be retrieved via PdfDocument.getOutline. They can carry an Action and thus allow quick navigation to document pages, or even external resources.

Constructors

Link copied to clipboard
constructor(title: String, color: Int = DEFAULT_COLOR, style: Int = Typeface.NORMAL, typeface: Typeface? = Typeface.DEFAULT, isExpanded: Boolean = false, action: Action? = null, pageLabel: String? = null, children: List<OutlineElement> = emptyList())

Types

Link copied to clipboard
class Builder

Builder for OutlineElement.

Link copied to clipboard
object Companion

Companion object containing constants for OutlineElement.

Link copied to clipboard
annotation class OutlineElementStyle

Style of outline element text.

Properties

Link copied to clipboard

The action to execute when this outline element is selected (typically a GoToAction).

Link copied to clipboard

Child outline elements nested under this element.

Link copied to clipboard
val color: Int

The text color of the outline element (default is black).

Link copied to clipboard

Whether this outline element is expanded in the outline view.

Link copied to clipboard

The label of the target page, if available.

Link copied to clipboard
Link copied to clipboard

The display title of the outline element.

Link copied to clipboard

The typeface used for rendering the title.