case class CodeBlock(language: String, content: Seq[Span], codeOptions: Seq[String] = Nil, options: Options = NoOpt) extends Element with Block with SpanContainer with Product with Serializable
A block of program code. The content is a sequence of spans to support
the integration of syntax highlighting systems. For unsupported languages
the sequence will only consist of a single Text element.
- Alphabetic
- By Inheritance
- CodeBlock
- SpanContainer
- RewritableContainer
- ElementContainer
- ElementTraversal
- Container
- Block
- Element
- Serializable
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
Type Members
-
type
Self = CodeBlock
- Definition Classes
- CodeBlock → SpanContainer → RewritableContainer → Block → Element
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 codeOptions: Seq[String]
-
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
- val content: Seq[Span]
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
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
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
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
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
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
- def hasSyntaxHighlighting: Boolean
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val language: String
-
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()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- val options: Options
-
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
- SpanContainer → RewritableContainer
-
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
-
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
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- ElementContainer → AnyRef → Any
-
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()
-
def
withContent(newContent: Seq[Span]): CodeBlock
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
- CodeBlock → SpanContainer
-
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): CodeBlock
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