pspdfkit/com.pspdfkit.document/OutlineElement

OutlineElement

open class OutlineElement

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

Types

Link copied to clipboard
class Builder
Builder for OutlineElement.
Link copied to clipboard
@Retention(value = RetentionPolicy.SOURCE)
annotation class OutlineElementStyle
Style of outline element text.

Properties

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
@ColorInt
@get:ColorInt
val color: Int
If the color is set to `DEFAULT_COLOR` the PDF doesn't define a color for the entry.
Link copied to clipboard
val DEFAULT_COLOR: Int = -16777216
Default transparent color indicates no color is defined.
Link copied to clipboard
val style: Int
Link copied to clipboard

Functions

Link copied to clipboard
open fun equals(@Nullable o: Any): Boolean
Link copied to clipboard
@Nullable
open fun getPageLabel(): String
Page label of target page if one exists and Action in getAction is a go to page action.
Link copied to clipboard
open fun hashCode(): Int
Link copied to clipboard
open fun isExpanded(): Boolean
Returns whether the outline element is expanded or not.
Link copied to clipboard
@NonNull
open fun toString(): String