laika-core/laika.ast/TreeContent

TreeContent

sealed trait TreeContent extends Navigatable

A titled, positional element in the document tree.

class Object
trait Matchable
class Any
class Document

Value members

Abstract methods

def asNavigationItem(context: NavigationBuilderContext): NavigationItem

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.

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.

Value parameters:
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

def config: Config

The configuration associated with this element.

The configuration associated with this element.

protected def configScope: Scope
def invalidElements(filter: MessageFilter): Seq[Invalid]

Extracts all invalid elements with the specified minimum message level from this tree content.

Extracts all invalid elements with the specified minimum message level from this tree content.

def position: TreePosition

The position of this element within the document tree.

The position of this element within the document tree.

def runtimeMessages(filter: MessageFilter): Seq[RuntimeMessage]

Extracts all runtime messages with the specified minimum level from this tree content.

Extracts all runtime messages with the specified minimum level from this tree content.

def title: Option[SpanSequence]

The title of this element which can originate from the first header of a markup file or from configuration.

The title of this element which can originate from the first header of a markup file or from configuration.

Concrete methods

def targetFormats: TargetFormats

The formats this tree content should be rendered to.

The formats this tree content should be rendered to.

protected def titleFromConfig: Option[SpanSequence]

Inherited methods

def path: Path
Inherited from:
Navigatable

Inherited fields

lazy val name: String

The local name of this navigatable.

The local name of this navigatable.

Inherited from:
Navigatable