type

DocNode

@Js
abstract class DocNode : Obj

DocNode is the base class for nodes in a fandoc model. There are two type of nodes: DocElem and DocText.

See pod doc for usage.

fields

parent

Get the DocElem that contains this node.

methods

dump

Debug dump to output stream.

id

Get node id for node type.

isBlock

Is this a block element versus an inline element.

isFirst

Return true if this node is the first child in its parent.

isInline

Is this an inline versus a block node.

isLast

Return true if this node is the last child in its parent.

path

Get the path from the root of the DOM to this node.

pos

Get the index of this node in its parent's children.

toText

Get all the DocText children as a string

write

Write this node to the specified DocWriter.

Slot Details

dump

Void dump(OutStream out := Env.cur().out())

Debug dump to output stream.

id

abstract DocNodeId id()

Get node id for node type.

isBlock

Bool isBlock()

Is this a block element versus an inline element.

isFirst

Bool isFirst()

Return true if this node is the first child in its parent.

isInline

abstract Bool isInline()

Is this an inline versus a block node.

isLast

Bool isLast()

Return true if this node is the last child in its parent.

parent

DocElem? parent { internal set }

Get the DocElem that contains this node. Return null if not parented.

path

virtual DocNode[] path()

Get the path from the root of the DOM to this node.

pos

Int? pos()

Get the index of this node in its parent's children. Return null if not parented.

toText

abstract Str toText()

Get all the DocText children as a string

write

abstract Void write(DocWriter out)

Write this node to the specified DocWriter.