BoustroScope class

Inherited widget that carries information about a document.

Inheritance
Annotations

Constructors

BoustroScope.editable({Key? key, required DocumentController controller, required Widget child})
Create a scope for an editable document with a DocumentController.
const
BoustroScope.readonly({Key? key, required Document document, required Widget child})
Create a scope for a read-only document with a Document.
const

Properties

child → Widget
The widget below this widget in the tree.
finalinherited
controller → DocumentController?
Document controller of the editor. Null if BoustroScope.readonly was used.
final
document → Document?
Document of the DocumentView. Null if BoustroScope.readonly was used.
final
hashCode → int
The hash code for this object.
no setterinherited
isEditable → bool
True if BoustroScope.editable was used, false if BoustroScope.readonly was used.
no setter
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

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.
override
match<T>({required T editable(DocumentController), required T readonly(Document)}) → T
Call editable if isEditable is true or readonly if it is not.
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
updateShouldNotify(covariant BoustroScope oldWidget) → bool
Whether the framework should notify widgets that inherit from this widget.
override

Operators

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

Static Methods

of(BuildContext context) → BoustroScope
Look for a boustro scope widget up the tree from context.