IosDocumentGestureEditingController class

Controls the display of drag handles, a magnifier, and a floating toolbar, assuming iOS-style behavior for the handles.

Inheritance

Constructors

IosDocumentGestureEditingController({required LayerLink documentLayoutLink, required SelectionLayerLinks selectionLinks, required LeaderLink magnifierFocalPointLink, required MagnifierAndToolbarController overlayController})

Properties

caretHeight double?
The height of the caret, or null if no caret should be displayed.
no setter
caretTop Offset?
The offset of the top of the caret, or null if no caret should be displayed.
no setter
collapsedHandleOffset Offset?
The offset of the collapsed handle focal point, within the coordinate space of the document layout, or null if no collapsed handle should be displayed.
getter/setter pair
downstreamCaretHeight double?
getter/setter pair
downstreamHandleOffset Offset?
The offset of the downstream handle focal point, within the coordinate space of the document layout, or null if no downstream handle should be displayed.
getter/setter pair
hasCaret bool
Whether or not a caret should be displayed.
no setter
hashCode int
The hash code for this object.
no setterinherited
hasListeners bool
Whether any listeners are currently registered.
no setterinherited
isToolbarPositioned bool
Whether the toolbar currently has a designated display position.
no setterinherited
A LayerLink whose top-left corner sits at the location where the magnifier should magnify.
no setterinherited
getter/setter pair
overlayController MagnifierAndToolbarController
Controls the magnifier and the toolbar.
getter/setter pairinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
screenPadding EdgeInsets?
Minimum space from the screen edges.
no setterinherited
finalinherited
shouldDisplayCollapsedHandle bool
Whether a collapsed handle should be displayed.
no setter
shouldDisplayExpandedHandles bool
Whether the expanded handles (base + extent) should be displayed.
no setter
shouldDisplayMagnifier bool
Whether the magnifier should be displayed.
no setterinherited
shouldDisplayToolbar bool
Whether the toolbar should be displayed.
no setterinherited
toolbarBottomAnchor Offset?
The point about which the floating toolbar should focus, when the toolbar appears below the selected content.
no setterinherited
toolbarTopAnchor Offset?
The point about which the floating toolbar should focus, when the toolbar appears above the selected content.
no setterinherited
upstreamCaretHeight double?
getter/setter pair
upstreamHandleOffset Offset?
The offset of the upstream handle focal point, within the coordinate space of the document layout, or null if no upstream handle should be displayed.
getter/setter pair

Methods

addListener(VoidCallback listener) → void
Register a closure to be called when the object changes.
inherited
dispose() → void
Discards any resources used by the object. After this is called, the object is not in a usable state and should be discarded (calls to addListener will throw after the object is disposed).
inherited
hideMagnifier() → void
Hides the magnifier.
override
hideToolbar() → void
Hides the toolbar.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
notifyListeners() → void
Call all the registered listeners.
inherited
positionToolbar({required Offset topAnchor, required Offset bottomAnchor}) → void
Sets the toolbar's position to the given topAnchor and bottomAnchor.
inherited
removeCaret() → void
Removes the caret from the display.
removeListener(VoidCallback listener) → void
Remove a previously registered closure from the list of closures that are notified when the object changes.
inherited
showMagnifier() → void
Shows the magnify, and hides the toolbar.
override
showToolbar() → void
Shows the toolbar, and hides the magnifier.
inherited
toggleToolbar() → void
Toggles the toolbar from visible to not visible, or vis-a-versa.
inherited
toString() String
A string representation of this object.
inherited
updateCaret({Offset? top, double? height}) → void
Updates the caret's size and position.

Operators

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