SelectionContainerModifier class
A container that handles SelectionEvents for the Selectables in the subtree.
This widget is useful when one wants to customize selection behaviors for a group of Selectables
The state of this container is a single selectable and will register itself to the registrar if provided. Otherwise, it will register to the SelectionRegistrar from the context.
The containers handle the SelectionEvents from the registered SelectionRegistrar and delegate the events to the delegate.
This widget uses SelectionRegistrarScope to host the delegate as the SelectionRegistrar for the subtree to collect the Selectables, and SelectionEvents received by this container are sent to the delegate using the SelectionHandler API of the delegate.
{@tool dartpad} This sample demonstrates how to create a SelectionContainer that only allows selecting everything or nothing with no partial selection.
** See code in examples/api/lib/material/selection_area/custom_container.dart ** {@end-tool}
See also:
- SelectableRegion, which provides an overview of the selection system.
- SelectionContainer.disabled, which disable selection for a subtree.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatelessWidget
- SingleChildStatelessModifier
- SelectionContainerModifier
- Available extensions
Constructors
- SelectionContainerModifier({Key? key, Key? modifierKey, Widget? child, SelectionRegistrar? registrar, required SelectionContainerDelegate delegate})
-
Creates a selection container to collect the Selectables in the subtree.
const
- SelectionContainerModifier.disabled({Key? key, Key? modifierKey, Widget? child})
-
Creates a selection container that disables selection for the
subtree.
const
Properties
- delegate → SelectionContainerDelegate?
-
The delegate for SelectionEvents sent to this selection container.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- modifierKey → Key?
-
The actual key of the widget, which Modifier wrapped
finalinherited
- registrar → SelectionRegistrar?
-
The SelectionRegistrar this container is registered to.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
build(
BuildContext context) → Widget -
Describes the part of the user interface represented by this widget.
inherited
-
buildWithChild(
BuildContext context, Widget? child) → Widget -
A build method that receives an extra
childparameter.override -
createElement(
) → SingleChildStatelessElement -
Create a SingleChildStatelessElement
inherited
-
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
-
modified(
) → Modifier -
Available on Widget, provided by the ModifierTransformer extension
Transform normal widget to Modifier -
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