DropRegion class

Widget to which data can be dropped.

Inheritance

Constructors

DropRegion({Key? key, required Widget? child, required List<DataFormat<Object>> formats, required FutureOr<DropOperation> onDropOver(DropOverEvent), required Future<void> onPerformDrop(PerformDropEvent), void onDropEnter(DropEvent)?, void onDropLeave(DropEvent)?, void onDropEnded(DropEvent)?, OnGetDropItemPreview? onGetDropItemPreview, RenderObjectType renderObjectType = RenderObjectType.box, HitTestBehavior hitTestBehavior = HitTestBehavior.deferToChild})
const

Properties

child → Widget?
The widget below this widget in the tree.
finalinherited
formats → List<DataFormat<Object>>
List of DataFormats this DropRegion is interested in. May be empty if region only wants to accept local drag sessions.
final
hashCode → int
The hash code for this object.
no setterinherited
hitTestBehavior → HitTestBehavior
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
onDropEnded → (void Function(DropEvent)?)
Invoked when drop session has finished.
final
onDropEnter → (void Function(DropEvent)?)
Invoked once after inactive region accepts the drop.
final
onDropLeave → (void Function(DropEvent)?)
Invoked when dragging leaves the region.
final
onDropOver → FutureOr<DropOperation> Function(DropOverEvent)
Invoked when dragging happens over this region. Implementation should inspect the drag session from event and return a drop operation that it can support (or DropOperation.none).
final
onGetDropItemPreview → OnGetDropItemPreview?
Allows customizing drop animation on macOS and iOS.
final
onPerformDrop → Future<void> Function(PerformDropEvent)
Invoked when user performs drop on this region.
final
renderObjectType → RenderObjectType
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

createElement() → SingleChildRenderObjectElement
RenderObjectWidgets always inflate to a RenderObjectElement subclass.
inherited
createRenderObject(BuildContext context) → RenderObject
Creates an instance of the RenderObject class that this RenderObjectWidget represents, using the configuration described by this RenderObjectWidget.
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
didUnmountRenderObject(covariant RenderObject renderObject) → void
A render object previously associated with this widget has been removed from the tree. The given RenderObject will be of the same type as returned by this object's createRenderObject.
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
updateRenderObject(BuildContext context, covariant RenderObject renderObject) → void
Copies the configuration described by this RenderObjectWidget to the given RenderObject, which will be of the same type as returned by this object's createRenderObject.
override

Operators

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