case class NavigationItem(title: SpanSequence, content: Seq[NavigationItem], link: Option[NavigationLink] = None, targetFormats: TargetFormats = TargetFormats.All, options: Options = NoOpt) extends Element with Block with ListItem with ElementContainer[NavigationItem] with RewritableContainer with ListContainer with Product with Serializable
Represents a navigation entry with an optional target link and optional child items. When the target link is not present, this item only serves as a navigation header for its children.
- Alphabetic
- By Inheritance
- NavigationItem
- ListContainer
- RewritableContainer
- ElementContainer
- ElementTraversal
- Container
- ListItem
- Block
- Element
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new NavigationItem(title: SpanSequence, content: Seq[NavigationItem], link: Option[NavigationLink] = None, targetFormats: TargetFormats = TargetFormats.All, options: Options = NoOpt)
Type Members
- type Self = NavigationItem
- Definition Classes
- NavigationItem → RewritableContainer → ListItem → Block → 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 clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- 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[NavigationItem]
- Definition Classes
- NavigationItem → Container
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- def firstChildLink: Option[NavigationLink]
Returns the first link from the children of this navigation item.
Returns the first link from the children of this navigation item. This is useful for navigation systems where each entry must contain a concrete link.
- 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()
- 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
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val link: Option[NavigationLink]
- 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()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- val options: Options
- Definition Classes
- NavigationItem → Element
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- def rewriteChildren(rules: RewriteRules): NavigationItem
Rewrites all children of this container based on the specified rules.
Rewrites all children of this container based on the specified rules.
Concrete types are expected to support rewriting at least for all standard block, span and template span elements they contain, plus optionally for any other elements that have custom support for rewriting.
- Definition Classes
- NavigationItem → RewritableContainer
- def rewriteSpans(rule: RewriteRule[Span]): Self
Rewrites all span children of this container based on the specified rules.
Rewrites all span children of this container based on the specified rules.
Concrete types are expected to support rewriting at least for all standard block, span and template span elements they contain, plus optionally for any other elements that have custom support for rewriting.
- Definition Classes
- RewritableContainer
- 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 targetFormats: TargetFormats
- val title: SpanSequence
- def toString(): String
- Definition Classes
- ElementContainer → AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- 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()
- 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): NavigationItem
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
- NavigationItem → 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