CaretDocumentOverlay class
Document overlay that paints a caret with the given caretStyle.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- ContentLayerStatefulWidget
- DocumentLayoutLayerStatefulWidget
- CaretDocumentOverlay
Constructors
- CaretDocumentOverlay({Key? key, required DocumentComposer composer, required DocumentLayout documentLayoutResolver(), CaretStyle caretStyle = const CaretStyle(width: 2, color: Colors.black), TargetPlatform? platformOverride, bool displayOnAllPlatforms = false, bool displayCaretWithExpandedSelection = true, BlinkTimingMode blinkTimingMode = BlinkTimingMode.ticker})
-
const
Properties
- blinkTimingMode → BlinkTimingMode
-
The timing mechanism used to blink, e.g.,
TickerorTimer.final - caretStyle → CaretStyle
-
The visual style of the caret that this overlay paints.
final
- composer → DocumentComposer
-
The editor's DocumentComposer, which reports the current selection.
final
- displayCaretWithExpandedSelection → bool
-
Whether to display the caret when the selection is expanded.
final
- displayOnAllPlatforms → bool
-
Whether to display a caret on all platforms, including mobile.
final
- documentLayoutResolver → DocumentLayout Function()
-
Delegate that returns a reference to the editor's DocumentLayout, so
that the current selection can be mapped to an (x,y) offset and a height.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- platformOverride → TargetPlatform?
-
The platform to use to determine caret behavior, defaults to defaultTargetPlatform.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → DocumentLayoutLayerState< CaretDocumentOverlay, Rect?> -
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, int wrapWidth = 65}) → 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