Class OutlineElement
-
- All Implemented Interfaces:
public 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.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public @interface
OutlineElement.OutlineElementStyle
Style of outline element text.
public final class
OutlineElement.Builder
Builder for OutlineElement.
-
Field Summary
Fields Modifier and Type Field Description public final static int
DEFAULT_COLOR
public final int
color
public final int
style
public final String
title
public final List<OutlineElement>
children
public final Action
action
-
Method Summary
Modifier and Type Method Description int
getColor()
Returns outline element color. int
getStyle()
Returns outline element text style. String
getTitle()
Returns outline title. List<OutlineElement>
getChildren()
Returns outline element children - outline is organized in a tree-like fashion. Action
getAction()
Returns action be run when clicking on this element. boolean
isExpanded()
Returns whether the outline element is expanded or not. String
getPageLabel()
Page label of target page if one exists and Action in getAction is a go to page action. int
hashCode()
boolean
equals(@Nullable() Object o)
String
toString()
-
-
Method Detail
-
getColor
@ColorInt() int getColor()
Returns outline element color.
- Returns:
Color of the outline title text.
-
getStyle
int getStyle()
Returns outline element text style.
- Returns:
Style of the outline element, may be one of android.graphics.Typeface class constants: NORMAL, BOLD, ITALIC or BOLD_ITALIC
-
getChildren
@NonNull() List<OutlineElement> getChildren()
Returns outline element children - outline is organized in a tree-like fashion.
- Returns:
Children of this element.
-
getAction
@Nullable() Action getAction()
Returns action be run when clicking on this element.
- Returns:
Action tied to this element, may be
null
.
-
isExpanded
boolean isExpanded()
Returns whether the outline element is expanded or not.
- Returns:
true
if the outline element is expanded,false
otherwise.
-
getPageLabel
@Nullable() 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
-
hashCode
int hashCode()
-
-
-
-