case class Field(name: Seq[Span], content: Seq[Block], options: Options = NoOpt) extends Element with ListItem with BlockContainer with Product with Serializable
A single entry in a field list consisting of name and body.
- Alphabetic
- By Inheritance
- Field
- BlockContainer
- RewritableContainer
- ElementContainer
- ElementTraversal
- Container
- ListItem
- Element
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Type Members
- type Self = Field
- Definition Classes
- Field → BlockContainer → RewritableContainer → ListItem → 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(classOf[java.lang.CloneNotSupportedException]) @native()
- 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[Block]
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- 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[_ <: AnyRef]
- 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
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- 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
- val name: Seq[Span]
- 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 productElementNames: Iterator[String]
- Definition Classes
- Product
- def rewriteBlocks(rules: RewriteRule[Block]): Self
Rewrites all block children of this container based on the specified rules.
Rewrites all block 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
- BlockContainer
- def rewriteChildren(rules: RewriteRules): Field
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
- Field → BlockContainer → 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(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- def withContent(newContent: Seq[Block]): Field
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
- Field → BlockContainer
- 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): Field
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