nutrient/com.pspdfkit.document/OutlineElement/Builder

Builder

Constructors

constructor(title: String)

Creates the builder with default properties.

constructor(document: PdfDocument, title: String, targetPageIndex: Int)

Creates the builder for outline element that represents element in a table of contents. Builder will be prefilled with resolved label for the target page and an action (GoToAction) for switching to targetPageIndex.

Functions

build

fun build(): OutlineElement

Builds the outline element with data set on this builder.

setAction

fun setAction(action: Action): OutlineElement.Builder

Sets action that will be executed when clicking on this outline element.

setChildren

fun setChildren(children: List<OutlineElement>): OutlineElement.Builder

Sets element children - outline elements are organized in a tree-like fashion.

setColor

fun setColor(@ColorInt textColor: Int): OutlineElement.Builder

Sets outline element text color.

setExpanded

fun setExpanded(isExpanded: Boolean): OutlineElement.Builder

Expands/collapses the outline element.

setPageLabel

fun setPageLabel(pageLabel: String): OutlineElement.Builder

Sets page label of the target page if one exists and outline action is GoToAction.

setStyle

fun setStyle(textStyle: Int): OutlineElement.Builder

Sets outline element text style.

setTitle

fun setTitle(title: String): OutlineElement.Builder

Sets outline title.

setTypeface

fun setTypeface(typeface: Typeface): OutlineElement.Builder

Sets outline element text typeface.