c

laika.rst.ast

Include

case class Include(path: String, source: SourceFragment, options: Options = NoOpt) extends Element with Block with BlockResolver with Product with Serializable

Temporary element representing a file inclusion. The path is interpreted as relative to the path of the processed document if it is not an absolute path.

Linear Supertypes
BlockResolver, Unresolved, Block, Element, Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Include
  2. BlockResolver
  3. Unresolved
  4. Block
  5. Element
  6. Serializable
  7. Serializable
  8. Product
  9. Equals
  10. AnyRef
  11. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Include(path: String, source: SourceFragment, options: Options = NoOpt)

Type Members

  1. type Self = Include
    Definition Classes
    IncludeBlockElement

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  8. def hasId: Boolean

    Indicates whether this element has an id assigned.

    Indicates whether this element has an id assigned.

    Definition Classes
    Element
  9. 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
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. 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
  12. 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
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. val options: Options
    Definition Classes
    IncludeElement
  17. val path: String
  18. def resolve(cursor: DocumentCursor): Block
    Definition Classes
    IncludeBlockResolver
  19. def runsIn(phase: RewritePhase): Boolean
    Definition Classes
    IncludeBlockResolver
  20. 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
    IncludeUnresolved
  21. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  22. 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
    IncludeUnresolved
  23. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  25. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. 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
  27. def withOptions(options: Options): Include

    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
    IncludeElement
  28. 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
  29. 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
  30. 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
  31. 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

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from BlockResolver

Inherited from Unresolved

Inherited from Block

Inherited from Element

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped