OrgControllerData class
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- ProxyWidget
- InheritedWidget
- OrgControllerData
Constructors
-
OrgControllerData({required Widget child, required OrgTree root, required OrgDataNodeMap nodeMap, required Pattern searchQuery, required dynamic search(Pattern), required bool hideMarkup, required Map<
String, String> entityReplacements, required dynamic setHideMarkup(bool), required void cycleVisibility(), required void cycleVisibilityOf(OrgTree), String? restorationId, Key? key})
Properties
- child → Widget
-
The widget below this widget in the tree.
finalinherited
- cycleVisibility → void Function()
-
Cycle the visibility of the entire document
final
- cycleVisibilityOf → void Function(OrgTree)
-
Cycle the visibility of the specified subtree
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- hideMarkup ↔ bool
-
Whether some kidns of markup should be hidden
getter/setter pair
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- 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
- search → dynamic Function(Pattern)
-
Set the search query. Seciton visibility will be updated so that sections
with hits are expanded and sections without will be collapsed.
final
- searchQuery → Pattern
-
A query for full-text search of the document
final
-
searchResultKeys
→ ValueNotifier<
List< SearchResultKey> > -
Keys representing individual search result spans in the document. It will
only be populated after the widget build phase, so consumers will likely
want to use e.g. a ValueListenableBuilder to consume it.
final
Methods
-
createElement(
) → InheritedElement -
Inflates this configuration to a concrete instance.
inherited
-
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
-
generateSearchResultKey(
{String? label}) → SearchResultKey -
nodeFor(
OrgTree tree) → OrgDataNode? - Find the temporary data node for the given subtree
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
prettifyEntity(
String name) → String? -
Get the prettify-symbols-mode replacement with the given
name
. The result is obtained from OrgController.entityReplacements. -
restorationIdFor(
String name) → String? -
sectionForTarget(
String target) → OrgSection? -
Find the section corresponding to
target
, which may be one of -
sectionWithCustomId(
String customId) → OrgSection? - Find the section with the specified custom ID
-
sectionWithId(
String id) → OrgSection? - Find the section with the specified ID
-
sectionWithTitle(
String title) → OrgSection? - Find the section with the specified title
-
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
-
updateShouldNotify(
covariant OrgControllerData oldWidget) → bool -
Whether the framework should notify widgets that inherit from this widget.
override
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited