case class GeneratedNavigationNode(target: PathBase, title: Option[SpanSequence] = None, depth: Option[Int] = None, excludeRoot: Option[Boolean] = None, excludeSections: Option[Boolean] = None) extends NavigationNodeConfig with Product with Serializable
The configuration for an automatically generated navigation tree.
- target
the target to use as the root node for navigation tree based on a relative or absolute path in the virtual input tree
- title
the title for this entry when getting rendered as a link
- depth
the depth to recurse from the root node
- excludeRoot
indicates whether the root node should be excluded in which case the first-level children will be inserted into the parent node
- excludeSections
indicates whether sections within documents should be excluded in automatic entries
- Alphabetic
- By Inheritance
- GeneratedNavigationNode
- Serializable
- Serializable
- Product
- Equals
- NavigationNodeConfig
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
-
new
GeneratedNavigationNode(target: PathBase, title: Option[SpanSequence] = None, depth: Option[Int] = None, excludeRoot: Option[Boolean] = None, excludeSections: Option[Boolean] = None)
- target
the target to use as the root node for navigation tree based on a relative or absolute path in the virtual input tree
- title
the title for this entry when getting rendered as a link
- depth
the depth to recurse from the root node
- excludeRoot
indicates whether the root node should be excluded in which case the first-level children will be inserted into the parent node
- excludeSections
indicates whether sections within documents should be excluded in automatic entries
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( ... ) @native()
- val depth: Option[Int]
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val excludeRoot: Option[Boolean]
- val excludeSections: Option[Boolean]
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
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()
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
- val target: PathBase
- val title: Option[SpanSequence]
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()