Packages

case class NavigationBuilderConfig(entries: Seq[NavigationNodeConfig], source: SourceFragment, defaultDepth: Int = Int.MaxValue, itemStyles: Set[String] = Set(), excludeRoot: Boolean = false, excludeSections: Boolean = false, excludeSelf: Boolean = false, options: Options = NoOpt) extends Element with BlockResolver with Product with Serializable

A block resolver that replaces itself with a navigation list according to this instances configuration. The resulting navigation tree can either be automatically generated from specified root nodes of the input tree or by specifying entries manually (or a combination of both).

Serves as the implementation for the navigationTree directive, but can also be inserted into the AST manually.

entries

the list of manual and automatic entries to insert into the navigation tree

source

the source fragment that produced this navigation builder, for error reporting

defaultDepth

the depth for automatically generated entries (unless overridden in the entries' config)

itemStyles

the styles to apply to all navigation items in the list as a render hint

excludeRoot

indicates whether the root node should be excluded in automatic entries (may be overridden in the entries' config)

excludeSections

indicates whether sections within documents should be excluded in automatic entries (may be overridden in the entries' config)

excludeSelf

indicates whether the current document should be included

options

optional styles and/or an id for the final navigation list

Linear Supertypes
BlockResolver, Unresolved, Block, Element, Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. NavigationBuilderConfig
  2. BlockResolver
  3. Unresolved
  4. Block
  5. Element
  6. Serializable
  7. Serializable
  8. Product
  9. Equals
  10. AnyRef
  11. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new NavigationBuilderConfig(entries: Seq[NavigationNodeConfig], source: SourceFragment, defaultDepth: Int = Int.MaxValue, itemStyles: Set[String] = Set(), excludeRoot: Boolean = false, excludeSections: Boolean = false, excludeSelf: Boolean = false, options: Options = NoOpt)

    entries

    the list of manual and automatic entries to insert into the navigation tree

    source

    the source fragment that produced this navigation builder, for error reporting

    defaultDepth

    the depth for automatically generated entries (unless overridden in the entries' config)

    itemStyles

    the styles to apply to all navigation items in the list as a render hint

    excludeRoot

    indicates whether the root node should be excluded in automatic entries (may be overridden in the entries' config)

    excludeSections

    indicates whether sections within documents should be excluded in automatic entries (may be overridden in the entries' config)

    excludeSelf

    indicates whether the current document should be included

    options

    optional styles and/or an id for the final navigation list

Type Members

  1. type Self = NavigationBuilderConfig
    Definition Classes
    NavigationBuilderConfig → Block → Element

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  6. val defaultDepth: Int
  7. val entries: Seq[NavigationNodeConfig]
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def eval(cursor: DocumentCursor): Either[String, NavigationList]

    Creates a navigation list for the specified document based on this instances configuration.

    Creates a navigation list for the specified document based on this instances configuration.

    In case of configuration errors or references to non-existing documents an error message will be returned as a Left.

  10. val excludeRoot: Boolean
  11. val excludeSections: Boolean
  12. val excludeSelf: Boolean
  13. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  14. def hasId: Boolean

    Indicates whether this element has an id assigned.

    Indicates whether this element has an id assigned.

    Definition Classes
    Element
  15. def hasStyle(name: String): Boolean

    Indicates whether this element has the specified style assigned.

    Indicates whether this element has the specified style assigned.

    Definition Classes
    Element
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. val itemStyles: Set[String]
  18. def mergeOptions(opt: Options): Self

    Returns a new instance of this element with its options merged with the specified options.

    Returns a new instance of this element with its options merged with the specified options.

    Definition Classes
    Element
  19. def modifyOptions(f: (Options) ⇒ Options): Self

    Returns a new instance of this element with the new options obtained from applying the specified function to the existing value.

    Returns a new instance of this element with the new options obtained from applying the specified function to the existing value.

    Definition Classes
    Element
  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  23. val options: Options
    Definition Classes
    NavigationBuilderConfig → Element
  24. def resolve(cursor: DocumentCursor): Block
    Definition Classes
    NavigationBuilderConfig → BlockResolver
  25. def runsIn(phase: RewritePhase): Boolean
    Definition Classes
    NavigationBuilderConfig → BlockResolver
  26. val source: SourceFragment

    The fragment from the input source that produced this element.

    The fragment from the input source that produced this element. Can be used to report the line of the error or to render a fallback that simply renders back the consumed input.

    Definition Classes
    NavigationBuilderConfig → Unresolved
  27. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  28. lazy val unresolvedMessage: String

    An error message to display when this element remains unresolved until after the final AST transformation step.

    An error message to display when this element remains unresolved until after the final AST transformation step.

    Definition Classes
    NavigationBuilderConfig → Unresolved
  29. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  31. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. def withId(id: String): Self

    Returns a new instance of this element with its id set to the specified value, overriding any existing value.

    Returns a new instance of this element with its id set to the specified value, overriding any existing value.

    Definition Classes
    Element
  33. def withOptions(options: Options): NavigationBuilderConfig

    Returns a new instance of this element with the specified options replacing the current value.

    Returns a new instance of this element with the specified options replacing the current value.

    Definition Classes
    NavigationBuilderConfig → Element
  34. def withStyle(name: String): Self

    Returns a new instance of this element with the specified style added to its existing styles.

    Returns a new instance of this element with the specified style added to its existing styles.

    Definition Classes
    Element
  35. def withStyles(styles: Iterable[String]): Self

    Returns a new instance of this element with the specified styles added to its existing styles.

    Returns a new instance of this element with the specified styles added to its existing styles.

    Definition Classes
    Element
  36. def withStyles(style: String, styles: String*): Self

    Returns a new instance of this element with the specified styles added to its existing styles.

    Returns a new instance of this element with the specified styles added to its existing styles.

    Definition Classes
    Element
  37. def withoutId: Self

    Returns a new instance of this element without its id.

    Returns a new instance of this element without its id.

    Definition Classes
    Element

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from BlockResolver

Inherited from Unresolved

Inherited from Block

Inherited from Element

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped