laika-core
API
Generated with
laika-core/laika/laika.ast/SectionInfo

SectionInfo

laika.ast.SectionInfo
case class SectionInfo(id: String, title: SpanSequence, content: Seq[SectionInfo], options: Options) extends Element, ElementContainer[SectionInfo]

Captures information about a document section, without its content.

Attributes

Graph
Supertypes
trait Container[Seq[SectionInfo]]
class Element
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Members list

Type members

Types

type Self = SectionInfo

Value members

Concrete methods

def asNavigationItem(docPath: Path, context: NavigationBuilderContext): NavigationItem

Creates the navigation structure for this section up to the specified depth. The returned instance can be used as part of a bigger navigation structure comprising of documents and trees.

Creates the navigation structure for this section up to the specified depth. The returned instance can be used as part of a bigger navigation structure comprising of documents and trees.

Value parameters

context

captures the navigation depth, reference path and styles for the navigation tree being built

Attributes

Returns

a navigation item that can be used as part of a bigger navigation structure comprising of trees, documents and their sections

def withOptions(options: Options): SectionInfo

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.

Attributes

Inherited methods

def collect[B](pf: PartialFunction[Element, B]): List[B]

Collects elements by applying the partial function to all elements it is defined for, in depth-first traversal, including this element itself.

Collects elements by applying the partial function to all elements it is defined for, in depth-first traversal, including this element itself.

Attributes

Inherited from:
ElementTraversal
def foreach(f: Element => Unit): Unit

Invokes the specified function for each child of this element container, including children of children, and this element itself, in depth-first traversal.

Invokes the specified function for each child of this element container, including children of children, and this element itself, in depth-first traversal.

Attributes

Inherited from:
ElementTraversal
def hasId: Boolean

Indicates whether this element has an id assigned.

Indicates whether this element has an id assigned.

Attributes

Inherited from:
Element
def hasStyle(name: String): Boolean

Indicates whether this element has the specified style assigned.

Indicates whether this element has the specified style assigned.

Attributes

Inherited from:
Element
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.

Attributes

Inherited from:
Element
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.

Attributes

Inherited from:
Element
def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
def select(p: Element => Boolean): List[Element]

Selects all elements satisfying the specified predicate, collecting in depth-first traversal, including this element itself.

Selects all elements satisfying the specified predicate, collecting in depth-first traversal, including this element itself.

Attributes

Inherited from:
ElementTraversal
override def toString: String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns

a string representation of the object.

Definition Classes
Inherited from:
ElementContainer
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.

Attributes

Inherited from:
Element
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.

Attributes

Inherited from:
Element
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.

Attributes

Inherited from:
Element
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.

Attributes

Inherited from:
Element
def withoutId: Self

Returns a new instance of this element without its id.

Returns a new instance of this element without its id.

Attributes

Inherited from:
Element
Generated with