Packages

c

laika.ast

InlineCode

case class InlineCode(language: String, content: Seq[Span], options: Options = NoOpt) extends Element with Span with SpanContainer with Product with Serializable

A span of program code. The content is a sequence of spans to support the integration of syntax highlighting systems. Without this support the sequence will only consist of a single Text element.

Linear Supertypes
SpanContainer, RewritableContainer, ElementContainer[Span], ElementTraversal, Container[Seq[Span]], Span, Element, Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. InlineCode
  2. SpanContainer
  3. RewritableContainer
  4. ElementContainer
  5. ElementTraversal
  6. Container
  7. Span
  8. Element
  9. Serializable
  10. Serializable
  11. Product
  12. Equals
  13. AnyRef
  14. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new InlineCode(language: String, content: Seq[Span], options: Options = NoOpt)

Type Members

  1. type Self = InlineCode
    Definition Classes
    InlineCodeSpanContainerRewritableContainerSpanElement

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()
  6. 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
  7. val content: Seq[Span]
    Definition Classes
    InlineCodeContainer
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def extractText: String

    Extracts the text from the spans of this container, removing any formatting or links.

    Extracts the text from the spans of this container, removing any formatting or links.

    Definition Classes
    SpanContainer
  10. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. 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
  12. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. def hasId: Boolean

    Indicates whether this element has an id assigned.

    Indicates whether this element has an id assigned.

    Definition Classes
    Element
  14. 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
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. val language: String
  17. 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
  18. 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
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. val options: Options
    Definition Classes
    InlineCodeElement
  23. def rewriteChildren(rules: RewriteRules): Self

    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
    SpanContainerRewritableContainer
  24. 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
  25. 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
  26. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  27. def toString(): String
    Definition Classes
    ElementContainer → AnyRef → Any
  28. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  31. def withContent(newContent: Seq[Span]): InlineCode

    Creates a copy of this instance with the specified new content.

    Creates a copy of this instance with the specified new content.

    Implementation note: This method exists to deal with the fact that there is no polymorphic copy method and trades a small bit of boilerplate for avoiding the compile time hit of using shapeless for this.

    Definition Classes
    InlineCodeSpanContainer
  32. 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
  33. def withOptions(options: Options): InlineCode

    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
    InlineCodeElement
  34. 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
  35. 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
  36. 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
  37. 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

Inherited from SpanContainer

Inherited from RewritableContainer

Inherited from ElementContainer[Span]

Inherited from ElementTraversal

Inherited from Container[Seq[Span]]

Inherited from Span

Inherited from Element

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped