case class SectionInfo(id: String, title: SpanSequence, content: Seq[SectionInfo], options: Options = NoOpt) extends Element with ElementContainer[SectionInfo] with Product with Serializable
Captures information about a document section, without its content.
- Alphabetic
- By Inheritance
- SectionInfo
- ElementContainer
- ElementTraversal
- Container
- Element
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new SectionInfo(id: String, title: SpanSequence, content: Seq[SectionInfo], options: Options = NoOpt)
Type Members
- type Self = SectionInfo
- Definition Classes
- SectionInfo → Element
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 asNavigationItem(docPath: Path, context: NavigationBuilderContext = NavigationBuilderContext()): NavigationItem
Creates the navigation structure for this section up to the specified depth.
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.
- 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 clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- 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.
- Definition Classes
- ElementTraversal
- val content: Seq[SectionInfo]
- Definition Classes
- SectionInfo → Container
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- 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.
- Definition Classes
- ElementTraversal
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def hasId: Boolean
Indicates whether this element has an id assigned.
Indicates whether this element has an id assigned.
- Definition Classes
- Element
- 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
- val id: String
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- 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
- 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
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- val options: Options
- Definition Classes
- SectionInfo → Element
- def productElementNames: Iterator[String]
- Definition Classes
- 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.
- Definition Classes
- ElementTraversal
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val title: SpanSequence
- def toString(): String
- Definition Classes
- ElementContainer → AnyRef → Any
- 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()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- 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
- 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.
- Definition Classes
- SectionInfo → 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.
- Definition Classes
- 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.
- Definition Classes
- 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.
- Definition Classes
- Element
- 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
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated @Deprecated
- Deprecated