CustomPopupMenu class
A highly customizable popup menu widget that can be attached to any child widget.
It allows you to display a custom menu builder when the user interacts with the child widget based on the specified pressType.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- CustomPopupMenu
Constructors
- CustomPopupMenu({Key? key, required Widget child, required PressType pressType, CustomPopupMenuController? controller, Color arrowColor = const Color(0xFF4C4C4C), bool showArrow = true, Color barrierColor = Colors.black12, double arrowSize = 10.0, double horizontalMargin = 10.0, double verticalMargin = 10.0, PreferredPosition? position, bool enablePassEvent = true})
-
Creates a CustomPopupMenu.
const
Properties
- arrowColor → Color
-
The color of the arrow pointing to the anchor widget.
final
- arrowSize → double
-
The size of the arrow pointing to the anchor widget.
final
- barrierColor → Color
-
The background color of the overlay barrier behind the popup menu.
final
- child → Widget
-
The widget that triggers the popup menu when interacted with.
final
- controller → CustomPopupMenuController?
-
An optional controller to programmatically control the menu's visibility.
final
- enablePassEvent → bool
-
Pass tap event to the widgets below the mask.
It only works when barrierColor is transparent.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- horizontalMargin → double
-
The horizontal margin between the menu and the screen edges.
final
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
-
A builder function that returns the widget to be displayed inside the popup menu.
final
-
A callback that is triggered when the menu's visibility changes.
final
- position → PreferredPosition?
-
The preferred position of the menu relative to the anchor widget.
If null, the position is calculated automatically based on available space.
final
- pressType → PressType
-
The type of interaction required to show the menu (e.g., single click or long press).
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- showArrow → bool
-
Whether to display an arrow pointing to the anchor widget.
final
- verticalMargin → double
-
The vertical margin between the menu and the anchor widget.
final
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → State< CustomPopupMenu> -
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