public class

OutlineElement

extends Object
java.lang.Object
   ↳ com.pspdfkit.document.OutlineElement

Class Overview

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 Action and thus allow quick navigation to document pages, or even external resources.

Summary

Constants
int DEFAULT_COLOR Default transparent color indicates no color is defined.
Public Methods
boolean equals(Object o)
Action getAction()
Returns action be run when clicking on this bookmark.
List<OutlineElement> getChildren()
Returns bookmark children - bookmarks are organized in a tree-like fashion.
int getColor()
Returns bookmark color.
String getPageLabel()
Page label of target page if one exists and Action in getAction() is a go to page action.
int getStyle()
Returns bookmark text style.
String getTitle()
Returns bookmark title.
int hashCode()
boolean isExpanded()
Returns whether the outline element is expanded or not.
String toString()
[Expand]
Inherited Methods
From class java.lang.Object

Constants

public static final int DEFAULT_COLOR

Default transparent color indicates no color is defined.

Constant Value: -16777216 (0xff000000)

Public Methods

public boolean equals (Object o)

public Action getAction ()

Returns action be run when clicking on this bookmark.

Returns
  • Action tied to this bookmark, may be null.

public List<OutlineElement> getChildren ()

Returns bookmark children - bookmarks are organized in a tree-like fashion.

Returns
  • Children of this bookmark.

public int getColor ()

Returns bookmark color.

Returns
  • Color of the bookmark title text.

public String getPageLabel ()

Page label of target page if one exists and Action in getAction() is a go to page action.

Returns
  • Page label if applicable, null otherwise

public int getStyle ()

Returns bookmark text style.

Returns

public String getTitle ()

Returns bookmark title.

Returns
  • Human readable bookmark title.

public int hashCode ()

public boolean isExpanded ()

Returns whether the outline element is expanded or not.

Returns
  • true if the outline element is expanded, false otherwise.

public String toString ()