NavigationBuilderContext

laika.ast.NavigationBuilderContext
See theNavigationBuilderContext companion object
sealed abstract class NavigationBuilderContext

The context of a navigation builder that can get passed down in recursive calls to the various types that have an asNavigationItem method.

Attributes

Companion
object
Source
DocumentNavigation.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Impl

Members list

Value members

Abstract methods

The current level of the navigation tree being built.

The current level of the navigation tree being built.

Attributes

Source
DocumentNavigation.scala

Indicates whether the recursion should exclude sections of documents even when maxLevels has not been reached yet.

Indicates whether the recursion should exclude sections of documents even when maxLevels has not been reached yet.

Attributes

Source
DocumentNavigation.scala

Indicates that links pointing to the current document should be omitted.

Indicates that links pointing to the current document should be omitted.

Attributes

Source
DocumentNavigation.scala

The styles to assign to each navigation item as a render hint.

The styles to assign to each navigation item as a render hint.

Attributes

Source
DocumentNavigation.scala
def maxLevels: Int

The number of levels of sub-trees, documents or sections to create navigation info for.

The number of levels of sub-trees, documents or sections to create navigation info for.

Attributes

Source
DocumentNavigation.scala

Creates a new instance for the next navigation level.

Creates a new instance for the next navigation level.

Attributes

Source
DocumentNavigation.scala
def refPath: Path

The path of the document for which links will be created (meaning all generated links will be relative to this path).

The path of the document for which links will be created (meaning all generated links will be relative to this path).

Attributes

Source
DocumentNavigation.scala

Concrete fields

Indicates whether the final navigation level has been reached.

Indicates whether the final navigation level has been reached.

True if currentLevel >= maxLevels.

Attributes

Source
DocumentNavigation.scala