ContextMenuRegion class - region library

Constructors

ContextMenuRegion({Key? key, Widget? child, Widget builder(bool)?, bool enabled = true, bool moveDownwards = true, bool preventContextMenu = true, bool enableLongTap = true, bool enablePrimaryTap = false, bool enableSecondaryTap = true, Alignment alignment = Alignment.bottomCenter, List<ContextMenuItem> actions = const [], GlobalKey<State<StatefulWidget>>? selector, bool selectorClosable = true, double width = 260, EdgeInsets margin = EdgeInsets.zero, bool indicateOpenedMenu = false, bool unconstrained = false}): const

Properties

actions → List<ContextMenuItem>: ContextMenuItems representing the actions of the context menu.
final
alignment → Alignment: Alignment of a FloatingContextMenu this region displays.
final
builder → Widget Function(bool)?: Builder building a Widget to wrap this region over depending on whether the ContextMenu is displayed.
final
child → Widget?: Widget to wrap this region over.
final
enabled → bool: Indicator whether this region should be enabled.
final
enableLongTap → bool: Indicator whether context menu should be displayed on a long tap.
final
enablePrimaryTap → bool: Indicator whether context menu should be displayed on a primary tap.
final
enableSecondaryTap → bool: Indicator whether context menu should be displayed on a secondary tap.
final
hashCode → int: The hash code for this object.
no setterinherited
indicateOpenedMenu → bool: Indicator whether this ContextMenuRegion should display a ColoredBox above the child when a ContextMenu is opened.
final
key → Key?: Controls how one widget replaces another widget in the tree.
finalinherited
margin → EdgeInsets: Margin to apply to a Selector on desktop or to FloatingContextMenu on mobile.
final
moveDownwards → bool: Indicator whether a FloatingContextMenu this region displays should animate the child moving downwards.
final
preventContextMenu → bool: Indicator whether a default context menu should be prevented or not.
final
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
selector → GlobalKey<State<StatefulWidget>>?: GlobalKey of a Selector.buttonKey.
final
selectorClosable → bool: Indicator whether Selector.onPointerUp should pop the Navigator.
final
unconstrained → bool: Indicator whether the child should be unconstrained.
final
width → double: Width of a Selector.
final

Methods

animate({Key? key, List<Effect>? effects, AnimateCallback? onInit, AnimateCallback? onPlay, AnimateCallback? onComplete, bool? autoPlay, Duration? delay, AnimationController? controller, Adapter? adapter, double? target, double? value}) → Animate: Available on Widget, provided by the AnimateWidgetExtensions extension
Wraps the target Widget in an Animate instance, and returns the instance for chaining calls. Ex. myWidget.animate() is equivalent to Animate(child: myWidget).
createElement() → StatefulElement: Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<ContextMenuRegion>: 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

Static Properties

overlays ↔ List<ContextMenuRegionState>: List of ContextMenuRegionState currently having an OverlayEntry.
getter/setter pair