MenuItemGroupWithSelection<SelectionItemType> class
A MenuItemGroup that contains a SelectionModel.
When used in the MenuItemGroupsComponent, the component will allow both single- and multi-select. A single-select group will have a left indicator, while the multi-select group will have check marks.
- Inheritance
-
- Object
- LabeledList<
SelectableMenuItem< SelectionItemType> > - MenuItemGroup<
SelectableMenuItem< SelectionItemType> > - MenuItemGroupWithSelection
- Implemented types
-
- Selectable<
SelectionItemType> - List<
E> - Iterable<
E>
- Selectable<
Constructors
-
MenuItemGroupWithSelection({required List<
SelectableMenuItem< items, required SelectionModel<SelectionItemType> >SelectionItemType> selectionModel, String? label, bool? shouldCloseMenuOnSelection})
Properties
-
first
↔ SelectableMenuItem<
SelectionItemType> -
The first element.
getter/setter pairinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- hasLabel → bool
-
no setterinherited
- hasSeparator ↔ bool
-
True when this component explicitly specifies a separator.
getter/setter pairinherited
- isCollapsible ↔ bool
-
True when this component can be collapsed.
getter/setter pairinherited
- isEmpty → bool
-
Whether this collection has no elements.
no setterinherited
- isExpanded ↔ bool
-
True when the component is collapsed.
getter/setter pairinherited
- isMultiSelect → bool
-
True if the selection model is multi-select.
no setter
- isNotEmpty → bool
-
Whether this collection has at least one element.
no setterinherited
- itemsRole → String
-
The
role
attribute each menu item should apply.final -
iterator
→ Iterator<
SelectableMenuItem< SelectionItemType> > -
A new
Iterator
that allows iterating the elements of thisIterable
.no setterinherited -
last
↔ SelectableMenuItem<
SelectionItemType> -
The last element.
getter/setter pairinherited
- length ↔ int
-
The number of elements in this Iterable.
getter/setter pairinherited
-
onCollapsibleChange
→ Stream<
bool?> -
Change stream of collapsible changes.
no setterinherited
-
onExpandedChange
→ Stream<
bool?> -
Change stream of the expansion state.
no setterinherited
-
reversed
→ Iterable<
SelectableMenuItem< SelectionItemType> > -
An Iterable of the objects in this list in reverse order.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
selectionModel
→ SelectionModel<
SelectionItemType> -
final
- shouldCloseMenuOnSelection → bool
-
If true, the current menu should be closed when this item is selected.
final
-
single
→ SelectableMenuItem<
SelectionItemType> -
Checks that this iterable has only one element, and returns that element.
no setterinherited
- uiDisplayName → String?
-
no setterinherited
Methods
-
add(
SelectableMenuItem< SelectionItemType> value) → void -
Adds
value
to the end of this list, extending the length by one.inherited -
addAll(
Iterable< SelectableMenuItem< iterable) → voidSelectionItemType> > -
Appends all objects of
iterable
to the end of this list.inherited -
any(
bool test(SelectableMenuItem< SelectionItemType> )) → bool -
Checks whether any element of this iterable satisfies
test
.inherited -
asMap(
) → Map< int, SelectableMenuItem< SelectionItemType> > -
An unmodifiable Map view of this list.
inherited
-
cast<
T> () → List< T> -
A view of this iterable as an iterable of
R
instances.inherited -
clear(
) → void -
Removes all objects from this list; the length of the list becomes zero.
inherited
-
contains(
Object? element) → bool -
Whether the collection contains an element equal to
element
.inherited -
elementAt(
int index) → SelectableMenuItem< SelectionItemType> -
Returns the
index
th element.inherited -
every(
bool test(SelectableMenuItem< SelectionItemType> )) → bool -
Checks whether every element of this iterable satisfies
test
.inherited -
expand<
T> (Iterable< T> f(SelectableMenuItem<SelectionItemType> )) → Iterable<T> -
Expands each element of this Iterable into zero or more elements.
inherited
-
fillRange(
int start, int end, [SelectableMenuItem< SelectionItemType> ? fillValue]) → void -
Overwrites a range of elements with
fillValue
.inherited -
firstWhere(
bool test(SelectableMenuItem< SelectionItemType> ), {SelectableMenuItem<SelectionItemType> orElse()?}) → SelectableMenuItem<SelectionItemType> -
The first element that satisfies the given predicate
test
.inherited -
fold<
T> (T initialValue, T combine(T previousValue, SelectableMenuItem< SelectionItemType> element)) → T -
Reduces a collection to a single value by iteratively combining each
element of the collection with an existing value
inherited
-
followedBy(
Iterable< SelectableMenuItem< other) → Iterable<SelectionItemType> >SelectableMenuItem< SelectionItemType> > -
Creates the lazy concatenation of this iterable and
other
.inherited -
forEach(
void f(SelectableMenuItem< SelectionItemType> )) → void -
Invokes
action
on each element of this iterable in iteration order.inherited -
getRange(
int start, int end) → Iterable< SelectableMenuItem< SelectionItemType> > -
Creates an Iterable that iterates over a range of elements.
inherited
-
getSelectable(
SelectionItemType item) → SelectableOption -
Whether
item
should be shown as selectable.override -
indexOf(
SelectableMenuItem< SelectionItemType> element, [int start = 0]) → int -
The first index of
element
in this list.inherited -
indexWhere(
bool test(SelectableMenuItem< SelectionItemType> ), [int start = 0]) → int -
The first index in the list that satisfies the provided
test
.inherited -
insert(
int index, SelectableMenuItem< SelectionItemType> element) → void -
Inserts
element
at positionindex
in this list.inherited -
insertAll(
int index, Iterable< SelectableMenuItem< iterable) → voidSelectionItemType> > -
Inserts all objects of
iterable
at positionindex
in this list.inherited -
join(
[String separator = '']) → String -
Converts each element to a String and concatenates the strings.
inherited
-
lastIndexOf(
SelectableMenuItem< SelectionItemType> element, [int? start]) → int -
The last index of
element
in this list.inherited -
lastIndexWhere(
bool test(SelectableMenuItem< SelectionItemType> ), [int? start]) → int -
The last index in the list that satisfies the provided
test
.inherited -
lastWhere(
bool test(SelectableMenuItem< SelectionItemType> ), {SelectableMenuItem<SelectionItemType> orElse()?}) → SelectableMenuItem<SelectionItemType> -
The last element that satisfies the given predicate
test
.inherited -
map<
T> (T f(SelectableMenuItem< SelectionItemType> )) → Iterable<T> -
The current elements of this iterable modified by
toElement
.inherited -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
reduce(
SelectableMenuItem< SelectionItemType> combine(SelectableMenuItem<SelectionItemType> value, SelectableMenuItem<SelectionItemType> element)) → SelectableMenuItem<SelectionItemType> -
Reduces a collection to a single value by iteratively combining elements
of the collection using the provided function.
inherited
-
remove(
Object? value) → bool -
Removes the first occurrence of
value
from this list.inherited -
removeAt(
int index) → SelectableMenuItem< SelectionItemType> -
Removes the object at position
index
from this list.inherited -
removeLast(
) → SelectableMenuItem< SelectionItemType> -
Removes and returns the last object in this list.
inherited
-
removeRange(
int start, int end) → void -
Removes a range of elements from the list.
inherited
-
removeWhere(
bool test(SelectableMenuItem< SelectionItemType> )) → void -
Removes all objects from this list that satisfy
test
.inherited -
replaceRange(
int start, int end, Iterable< SelectableMenuItem< iterable) → voidSelectionItemType> > -
Replaces a range of elements with the elements of
replacements
.inherited -
retainWhere(
bool test(SelectableMenuItem< SelectionItemType> )) → void -
Removes all objects from this list that fail to satisfy
test
.inherited -
retype<
T> () → List< T> -
inherited
-
setAll(
int index, Iterable< SelectableMenuItem< iterable) → voidSelectionItemType> > -
Overwrites elements with the objects of
iterable
.inherited -
setRange(
int start, int end, Iterable< SelectableMenuItem< iterable, [int skipCount = 0]) → voidSelectionItemType> > -
Writes some elements of
iterable
into a range of this list.inherited -
shuffle(
[Random? random]) → void -
Shuffles the elements of this list randomly.
inherited
-
singleWhere(
bool test(SelectableMenuItem< SelectionItemType> ), {SelectableMenuItem<SelectionItemType> orElse()?}) → SelectableMenuItem<SelectionItemType> -
The single element that satisfies
test
.inherited -
skip(
int n) → Iterable< SelectableMenuItem< SelectionItemType> > -
Creates an Iterable that provides all but the first
count
elements.inherited -
skipWhile(
bool test(SelectableMenuItem< SelectionItemType> )) → Iterable<SelectableMenuItem< SelectionItemType> > -
Creates an
Iterable
that skips leading elements whiletest
is satisfied.inherited -
sort(
[int compare(SelectableMenuItem< SelectionItemType> , SelectableMenuItem<SelectionItemType> )?]) → void -
Sorts this list according to the order specified by the
compare
function.inherited -
sublist(
int start, [int? end]) → List< SelectableMenuItem< SelectionItemType> > -
Returns a new list containing the elements between
start
andend
.inherited -
take(
int n) → Iterable< SelectableMenuItem< SelectionItemType> > -
Creates a lazy iterable of the
count
first elements of this iterable.inherited -
takeWhile(
bool test(SelectableMenuItem< SelectionItemType> )) → Iterable<SelectableMenuItem< SelectionItemType> > -
Creates a lazy iterable of the leading elements satisfying
test
.inherited -
toList(
{bool growable = true}) → List< SelectableMenuItem< SelectionItemType> > -
Creates a List containing the elements of this Iterable.
inherited
-
toSet(
) → Set< SelectableMenuItem< SelectionItemType> > -
Creates a Set containing the same elements as this iterable.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
-
where(
bool test(SelectableMenuItem< SelectionItemType> )) → Iterable<SelectableMenuItem< SelectionItemType> > -
Creates a new lazy Iterable with all elements that satisfy the
predicate
test
.inherited -
whereType<
T> () → Iterable< T> -
Creates a new lazy Iterable with all elements that have type
T
.inherited
Operators
-
operator +(
List< SelectableMenuItem< other) → List<SelectionItemType> >SelectableMenuItem< SelectionItemType> > -
Returns the concatenation of this list and
other
.inherited -
operator ==(
Object other) → bool -
The equality operator.
inherited
-
operator [](
int index) → SelectableMenuItem< SelectionItemType> -
The object at the given
index
in the list.inherited -
operator []=(
int index, SelectableMenuItem< SelectionItemType> value) → void -
Sets the value at the given
index
in the list tovalue
.inherited