laika-core/laika.ast/RewritableContainer

RewritableContainer

trait RewritableContainer extends Element

A generic container of child elements which can have rewrite rules applied to them in recursive tree rewriting.

class Element
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
class Cell
class Choice
class Citation
class Figure
class Footnote
class Section
class Field
class EnumList
class Row
class Selection
class Caption
class CodeBlock
class Deleted
class Header
class Inserted
class Paragraph
class SpanLink
class Strong
class Title
class Line
class Table
class TableBody
class TableHead
class FieldList
class LineBlock

Type members

Types

Value members

Abstract methods

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.

Concrete methods

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.

Inherited methods

def canEqual(that: Any): Boolean
Inherited from:
Equals
def hasId: Boolean

Indicates whether this element has an id assigned.

Indicates whether this element has an id assigned.

Inherited from:
Element
def hasStyle(name: String): Boolean

Indicates whether this element has the specified style assigned.

Indicates whether this element has the specified style assigned.

Inherited from:
Element
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.

Inherited from:
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.

Inherited from:
Element
def options: Options
Inherited from:
Element
def productArity: Int
Inherited from:
Product
def productElement(n: Int): Any
Inherited from:
Product
def productElementName(n: Int): String
Inherited from:
Product
def productElementNames: Iterator[String]
Inherited from:
Product
def productIterator: Iterator[Any]
Inherited from:
Product
def productPrefix: String
Inherited from:
Product
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.

Inherited from:
Element
def withOptions(options: Options): Self

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.

Inherited from:
Element
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.

Inherited from:
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.

Inherited from:
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.

Inherited from:
Element
def withoutId: Self

Returns a new instance of this element without its id.

Returns a new instance of this element without its id.

Inherited from:
Element