sealed trait TreeContent extends Navigatable
A titled, positional element in the document tree.
- Alphabetic
- By Inheritance
- TreeContent
- Navigatable
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract def asNavigationItem(context: NavigationBuilderContext = NavigationBuilderContext()): NavigationItem
Creates the navigation structure for this instance up to the specified depth.
Creates the navigation structure for this instance up to the specified depth. The returned instance can be used as part of a bigger navigation structure comprising of trees, documents and their sections.
- context
captures the navigation depth, reference path and styles for the navigation tree being built
- returns
a navigation item that can be used as part of a bigger navigation structure comprising of trees, documents and their sections
- abstract def config: Config
The configuration associated with this element.
- abstract def configScope: Scope
- Attributes
- protected
- abstract def invalidElements(filter: MessageFilter): Seq[Invalid]
Extracts all invalid elements with the specified minimum message level from this tree content.
- abstract def path: Path
- Definition Classes
- Navigatable
- abstract def position: TreePosition
The position of this element within the document tree.
- abstract def runtimeMessages(filter: MessageFilter): Seq[RuntimeMessage]
Extracts all runtime messages with the specified minimum level from this tree content.
- abstract def title: Option[SpanSequence]
The title of this element which can originate from the first header of a markup file or from configuration.
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- lazy val name: String
The local name of this navigatable.
The local name of this navigatable.
- Definition Classes
- Navigatable
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def targetFormats: TargetFormats
The formats this tree content should be rendered to.
- def titleFromConfig: Option[SpanSequence]
- Attributes
- protected
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()