case class Contents(title: String, source: SourceFragment, depth: Int = Int.MaxValue, local: Boolean = false, options: Options = NoOpt) extends Element with Block with BlockResolver with Product with Serializable
Generates a table of contents element inside a topic.
- Alphabetic
- By Inheritance
- Contents
- BlockResolver
- Unresolved
- Block
- Element
- Serializable
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
- new Contents(title: String, source: SourceFragment, depth: Int = Int.MaxValue, local: Boolean = false, options: Options = NoOpt)
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 depth: Int
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
getClass(): Class[_]
- 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
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val local: Boolean
-
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
-
def
resolve(cursor: DocumentCursor): Block
- Definition Classes
- Contents → BlockResolver
-
def
runsIn(phase: RewritePhase): Boolean
- Definition Classes
- Contents → BlockResolver
-
val
source: SourceFragment
The fragment from the input source that produced this element.
The fragment from the input source that produced this element. Can be used to report the line of the error or to render a fallback that simply renders back the consumed input.
- Definition Classes
- Contents → Unresolved
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
- val title: String
-
lazy val
unresolvedMessage: String
An error message to display when this element remains unresolved until after the final AST transformation step.
An error message to display when this element remains unresolved until after the final AST transformation step.
- Definition Classes
- Contents → Unresolved
-
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( ... )
-
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): Contents
Returns a new instance of this element with the specified options replacing the current value.
-
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