case class NavigationBuilderContext(refPath: Path = Root, itemStyles: Set[String] = Set(), maxLevels: Int = Int.MaxValue, currentLevel: Int = 1, excludeSections: Boolean = false, excludeSelf: Boolean = false) extends Product with Serializable
The context of a navigation builder that can get passed down in recursive calls to the various types that have an asNavigationItem method.
- refPath
the path of document from which this document will be linked (for creating a corresponding relative path)
- itemStyles
the styles to assign to each navigation item as a render hint
- maxLevels
the number of levels of sub-trees, documents or sections to create navigation info for
- currentLevel
the current level of the navigation tree being built
- excludeSections
indicates whether the recursion should exclude sections of documents even when maxLevels has not been reached yet
- Alphabetic
- By Inheritance
- NavigationBuilderContext
- Serializable
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
-
new
NavigationBuilderContext(refPath: Path = Root, itemStyles: Set[String] = Set(), maxLevels: Int = Int.MaxValue, currentLevel: Int = 1, excludeSections: Boolean = false, excludeSelf: Boolean = false)
- refPath
the path of document from which this document will be linked (for creating a corresponding relative path)
- itemStyles
the styles to assign to each navigation item as a render hint
- maxLevels
the number of levels of sub-trees, documents or sections to create navigation info for
- currentLevel
the current level of the navigation tree being built
- excludeSections
indicates whether the recursion should exclude sections of documents even when maxLevels has not been reached yet
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() @HotSpotIntrinsicCandidate()
- val currentLevel: Int
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val excludeSections: Boolean
- val excludeSelf: Boolean
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- val isComplete: Boolean
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val itemStyles: Set[String]
- val maxLevels: Int
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def newNavigationItem(title: SpanSequence, target: Path, children: Seq[NavigationItem], targetFormats: TargetFormats): NavigationItem
- def newNavigationItem(title: SpanSequence, target: Option[DocumentNavigation], children: Seq[NavigationItem], targetFormats: TargetFormats): NavigationItem
- lazy val nextLevel: NavigationBuilderContext
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- val refPath: Path
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
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()
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
Deprecated Value Members
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] ) @Deprecated
- Deprecated