| 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
| Nested Classes | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| class | OutlineElement.Builder | Builder for OutlineElement. |
|||||||||
| @interface | OutlineElement.OutlineElementStyle | Style of outline element text. | |||||||||
| 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 element.
| ||||||||||
| List<OutlineElement> |
getChildren()
Returns outline element children - outline is organized in a tree-like fashion.
| ||||||||||
| int |
getColor()
Returns outline element color.
| ||||||||||
| String |
getPageLabel()
Page label of target page if one exists and Action in
getAction() is a
go to page action. | ||||||||||
| int |
getStyle()
Returns outline element text style.
| ||||||||||
| String |
getTitle()
Returns outline 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 Action getAction ()
Returns action be run when clicking on this element.
Returns
- Action tied to this element, may be
null.
public List<OutlineElement> getChildren ()
Returns outline element children - outline is organized in a tree-like fashion.
Returns
- Children of this element.
public int getColor ()
Returns outline element color.
Returns
- Color of the outline 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,
nullotherwise
public int getStyle ()
Returns outline element text style.
Returns
- Style of the outline element, may be one of
Typefaceclass constants:NORMAL,BOLD,ITALICorBOLD_ITALIC
public int hashCode ()
public boolean isExpanded ()
Returns whether the outline element is expanded or not.
Returns
trueif the outline element is expanded,falseotherwise.