N
- the type of nodes used in this Outline Treepublic interface Outline<N extends OutlineNode<N>> extends OutlineNode<N>
Outline
represents such a tree structure. Besides that, an Outline
instance is also the tree's
root node. The whole structure is also called an Outline Tree.
To distinguish multiple outlines from each other, it is possible to name and characterize them.
The root node's description can serve as a name for the entire outline. In addition, the Outline
Tree is characterized by its type. (see getType()
)
The Outline Tree's hierarchy is formed using instances of OutlineNode
. Each node can have
an arbitrary number of children. The hierarchy provides an independent view, representing a
specific aspect of data or objects. This aspect is expressed by the hierarchical ordering itself
as well as by the textual description supplied by each node. In addition, each node offers the
option to associate arbitrary properties or instruction with it. The properties may be used to
store additional information which can serve to enrich the OutlineNode
's presentation or
further augment the aspect. Using Instruction
s, it is furthermore possible to deposit
information on steps to be executed on-demand for a given OutlineNode
.
One typical use case which can be solved using an Outline Tree is the definition of bookmarks for a document in order to provide flexible navigation through its pages. Some file formats even support embedding such bookmarks. However, outlines are not limited to documents or pages.
Modifier and Type | Method and Description |
---|---|
String |
getType()
Returns the type identifier which is an indicator of this
Outline 's purpose. |
getChildren, getDescription, getInstructionChain, getOutline, getParent, getProperties
String getType()
Outline
's purpose. It can be
helpful to distinguish multiple Outline Trees from each other, or to present a suitable
heading/name to users.
Outlines may have arbitrary type identifiers. However, some components may also rely on well-known type identifiers. The constants defined in this class serve as well-known type identifiers which should usually be supported.
Outline
's purpose. Must not return
null
.Copyright © 2024 levigo holding gmbh. All rights reserved.