Element

laika.ast.Element
abstract class Element extends Product, Serializable

The base class for all Elements forming the document tree. Usually not extended directly, instead either Span or Block should be picked as the base type for new element types.

All node types have an optional id and zero or more associated styles serving as render hints.

Attributes

Source
base.scala
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Known subtypes
trait Block
class HTMLBlock
class HTMLComment
class HTMLStartTag
class BlockScope
class BulletList
class Citation
class CodeBlock
class Comment
trait Definition
class LinkAlias
class EnumList
class Figure
class Footnote
class Header
class InvalidBlock
trait LinkTarget
class LiteralBlock
class PageBreak
class Paragraph
class QuotedBlock
class RawContent
class RootElement
class Rule
class Section
class Selection
class SpanSequence
class Table
class TargetFormat
class TemplateRoot
class Title
class TitledBlock
trait Container[T]
trait ElementContainer[E]
class Cell
class Choice
class EmbeddedRoot
class EnumListItem
class SectionInfo
class HTMLElement
class Caption
class Deleted
class Emphasized
class InlineCode
class Inserted
class SpanLink
class Strong
class Columns
class Row
class TableBody
class TableHead
class CodeSpan
class Literal
class Text
trait Hidden
trait Invalid
class InvalidSpan
trait ListItem
trait Span
class HTMLSpan
class HTMLEndTag
trait Icon
class IconGlyph
class IconStyle
class LineBreak
trait Link
trait GlobalLink
class Image
class RawLink
trait LocalLink
class CitationLink
class FootnoteLink
trait Reference
class Reverse
trait SpanResolver
class ContextReference[T]
class SpanScope
trait TemplateSpan
trait TableElement
class Column
trait Unresolved
trait ElementScope[E]
Show all

Members list

Type members

Types

type Self <: Element

Attributes

Source
base.scala

Value members

Abstract methods

Attributes

Source
base.scala
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.

Attributes

Source
base.scala

Concrete methods

Returns a new instance of this element with all options removed from it.

Returns a new instance of this element with all options removed from it.

Attributes

Source
base.scala
def hasId: Boolean

Indicates whether this element has an id assigned.

Indicates whether this element has an id assigned.

Attributes

Source
base.scala
def hasStyle(name: String): Boolean

Indicates whether this element has the specified style assigned.

Indicates whether this element has the specified style assigned.

Attributes

Source
base.scala

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.

Attributes

Source
base.scala

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.

Attributes

Source
base.scala
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.

Attributes

Source
base.scala
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.

Attributes

Source
base.scala
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.

Attributes

Source
base.scala
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.

Attributes

Source
base.scala

Returns a new instance of this element without its id.

Returns a new instance of this element without its id.

Attributes

Source
base.scala

Inherited methods

def canEqual(that: Any): Boolean

Attributes

Inherited from:
Equals
def productArity: Int

Attributes

Inherited from:
Product
def productElement(n: Int): Any

Attributes

Inherited from:
Product
def productElementName(n: Int): String

Attributes

Inherited from:
Product
def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
def productPrefix: String

Attributes

Inherited from:
Product