OrgDocument class

The top-level node representing a full Org document

Inheritance

Constructors

OrgDocument(OrgContent? content, Iterable<OrgSection> sections)
OrgDocument.parse(String text)
Parse an Org document in string form into an AST
factory

Properties

children → List<OrgNode>
Leading content, if present, followed by sections
no setterinherited
content → OrgContent?
Leading content
finalinherited
hashCode → int
The hash code for this object.
no setterinherited
level → int
The "level" (depth) of this node in the tree; corresponds to the number of '*' characters in the section heading
no setteroverride
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sections → List<OrgSection>
Sections contained within this tree. These are also iterated by children.
finalinherited

Methods

contains(Pattern pattern, {bool includeChildren = true}) → bool
Return true if this node or any of its children recursively match the supplied pattern
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
override
visit<T extends OrgNode>(bool visitor(T)) → bool
Walk AST with visitor. Specify a type T to only visit nodes of that type. The visitor function must return true to continue iterating, or false to stop.
inherited
visitSections(bool visitor(OrgSection)) → bool
Walk only section nodes of the AST with visitor. More efficient than calling visit. The visitor function must return true to continue iterating, or false to stop.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited