pspdfkit/com.pspdfkit.document/OutlineElement/Builder

Builder

class Builder

Builder for OutlineElement.

Constructors

Link copied to clipboard
constructor(@NonNull title: String)
Creates the builder with default properties.
constructor(@NonNull document: PdfDocument, @NonNull title: String, targetPageIndex: Int)
Creates the builder for outline element that represents element in a table of contents.

Functions

Link copied to clipboard
@NonNull
open fun build(): OutlineElement
Builds the outline element with data set on this builder.
Link copied to clipboard
@NonNull
open fun setAction(@Nullable action: Action): OutlineElement.Builder
Sets action that will be executed when clicking on this outline element.
Link copied to clipboard
@NonNull
open fun setChildren(@NonNull children: List<OutlineElement>): OutlineElement.Builder
Sets element children - outline elements are organized in a tree-like fashion.
Link copied to clipboard
@NonNull
open fun setColor(@ColorInt textColor: Int): OutlineElement.Builder
Sets outline element text color.
Link copied to clipboard
@NonNull
open fun setExpanded(isExpanded: Boolean): OutlineElement.Builder
Expands/collapses the outline element.
Link copied to clipboard
@NonNull
open fun setPageLabel(@Nullable pageLabel: String): OutlineElement.Builder
Sets page label of the target page if one exists and outline action is GoToAction
Link copied to clipboard
@NonNull
open fun setStyle(textStyle: Int): OutlineElement.Builder
Sets outline element text style.
Link copied to clipboard
@NonNull
open fun setTitle(@NonNull title: String): OutlineElement.Builder
Sets outline title.