OrgController class

Control behavior of an Org Mode document widget. Not needed if you are using the Org widget.

Place this in your widget hierarchy and fetch with OrgController.of.

Inheritance

Constructors

OrgController({required Widget child, required OrgTree root, bool? hideMarkup, String? restorationId, Key? key})
const
OrgController.defaults(OrgControllerData data, {required OrgTree root, required Widget child, Key? key})
Initialize the controller with existing data. Mostly useful for displaying a subsection of a parent document in a "narrowed" view; in such cases you should supply the data and root from the parent OrgController.

Properties

child → Widget
The child widget
final
entityReplacements → Map<String, String>
A map of entity replacements, e.g. Agrave → À. See orgDefaultEntityReplacements.
final
hashCode → int
The hash code for this object.
no setterinherited
hideMarkup → bool?
Optionally hide some kinds of markup
final
inheritedNodeMap → OrgDataNodeMap?
Temporary data about the nodes in root
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
restorationId → String?
An ID for temporary state restoration. Supply a unique ID to ensure that temporary state such as scroll position is preserved as appropriate.
final
root → OrgTree
The Org Mode document or section this controller will control
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
searchQuery → Pattern?
A query for full-text search of the document
final

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<OrgController>
Creates the mutable state for this widget at a given location in the tree.
override
debugDescribeChildren() → List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
inherited
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) → String
A string representation of this object.
inherited
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String
Returns a string representation of this node and its descendants.
inherited
toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String
Returns a one-line detailed description of the object.
inherited
toStringShort() → String
A short, textual description of this widget.
inherited

Operators

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

Static Methods

of(BuildContext context) → OrgControllerData