DropdownDialog<T> class
Class mainly used internally to display the available choices. Cannot be made private because of automated testing.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- DropdownDialog
Constructors
-
DropdownDialog({Key? key, List<
DropdownMenuItem< ? items, Widget? hint, bool isCaseSensitiveSearch = false, dynamic closeButton, TextInputType? keyboardType, Function? searchFn, required bool multipleSelection, List<T> >int> ? selectedItems, Function? displayItem, dynamic doneButton, Function? validator, required bool dialogBox, required PointerThisPlease<bool> displayMenu, Function? callOnPop, Function? updateParent, TextStyle? style, Color? iconEnabledColor, Color? iconDisabledColor, required bool rightToLeft, required bool autofocus, required String initialSearchTerms, Widget buildDropDownDialog(Widget titleBar, Widget searchBar, Widget list, Widget closeButton, BuildContext dropDownContext)?, EdgeInsets? dropDownDialogPadding, InputDecoration? searchInputDecoration, int? itemsPerPage, PointerThisPlease<int> ? currentPage, Widget customPaginationDisplay(Widget listWidget, int totalFilteredItemsNb, Function updateSearchPage)?, Future<Tuple2< futureSearchFn(String? keyword, String? orderBy, bool? orderAsc, List<List< >DropdownMenuItem> , int>Tuple2< ? filters, int? pageNb)?, Map<String, String> >String, Map< ? futureSearchOrderOptions, Map<String, dynamic> >String, Map< ? futureSearchFilterOptions, List<String, Object> >T> ? futureSelectedValues, dynamic emptyListWidget, Function? onTap, Function? futureSearchRetryButton, int? searchDelay, required Function giveMeThePop, Widget? clearSearchIcon, String? listValidator(List<T?> )?, Widget buildFutureFilterOrOrderButton({required BuildContext context, required bool filter, int? nbFilters, required Function onPressed, bool? orderAsc, String? orderBy})?, Widget searchResultDisplayFn({required Widget displayItem(DropdownMenuItem item, bool isItemSelected), required Widget emptyListWidget, required void itemTapped(int index, T value, bool itemSelected), required List<Tuple3< itemsToDisplay, required ScrollController scrollController, required bool thumbVisibility})?})int, DropdownMenuItem, bool> >
Properties
- autofocus → bool
-
See SearchChoices class.
final
- buildDropDownDialog → (Widget Function(Widget titleBar, Widget searchBar, Widget list, Widget closeButton, BuildContext dropDownContext)?)
-
See SearchChoices class.
final
- buildFutureFilterOrOrderButton → (Widget Function({required BuildContext context, required bool filter, int? nbFilters, required Function onPressed, bool? orderAsc, String? orderBy})?)
-
See SearchChoices class.
final
- callOnPop → Function?
-
Function to be called whenever the dialogBox is popped or the menu gets
closed.
final
- clearSearchIcon → Widget?
-
See SearchChoices class.
final
- closeButton → dynamic
-
See SearchChoices class.
final
-
currentPage
→ PointerThisPlease<
int> ? -
See SearchChoices class.
final
- customPaginationDisplay → (Widget Function(Widget listWidget, int totalFilteredItemsNb, Function updateSearchPage)?)
-
See SearchChoices class.
final
- dialogBox → bool
-
See SearchChoices class.
final
- displayItem → Function?
-
See SearchChoices class.
final
-
displayMenu
→ PointerThisPlease<
bool> -
See SearchChoices class.
final
- doneButton → dynamic
-
See SearchChoices class.
final
- dropDownDialogPadding → EdgeInsets?
-
See SearchChoices class.
final
- emptyListWidget → dynamic
-
See SearchChoices class.
final
-
futureSearchFilterOptions
→ Map<
String, Map< ?String, Object> > -
See SearchChoices class.
final
-
futureSearchFn
→ (Future<
Tuple2< Function(String? keyword, String? orderBy, bool? orderAsc, List<List< >DropdownMenuItem> , int>Tuple2< ? filters, int? pageNb)?)String, String> > -
See SearchChoices class.
final
-
futureSearchOrderOptions
→ Map<
String, Map< ?String, dynamic> > -
See SearchChoices class.
final
- futureSearchRetryButton → Function?
-
See SearchChoices class.
final
-
futureSelectedValues
→ List<
T> ? -
See SearchChoices class.
final
- giveMeThePop → Function
-
Assigns the pop function.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- hint → Widget?
-
See SearchChoices class.
final
- iconDisabledColor → Color?
-
See SearchChoices class.
final
- iconEnabledColor → Color?
-
See SearchChoices class.
final
- initialSearchTerms → String
-
Used for the setOpenDialog. This allows the dialogBox to be opened with
search terms preset from an external button as shown in example
Single dialog open and set search terms
.final - isCaseSensitiveSearch → bool
-
See SearchChoices class.
final
-
items
→ List<
DropdownMenuItem< ?T> > -
See SearchChoices class.
final
- itemsPerPage → int?
-
See SearchChoices class.
final
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- keyboardType → TextInputType?
-
See SearchChoices class.
final
- listScrollController → ScrollController
-
Allows to reset the scroll to the top of the list after changing the page
final
-
listValidator
→ (String? Function(List<
T?> )?) -
See SearchChoices class.
final
-
See SearchChoices class.
final
-
See SearchChoices class.
final
- multipleSelection → bool
-
See SearchChoices class.
final
- onTap → Function?
-
See SearchChoices class.
final
- rightToLeft → bool
-
See SearchChoices class.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- searchDelay → int?
-
See SearchChoices class.
final
- searchFn → Function?
-
See SearchChoices class.
final
- searchInputDecoration → InputDecoration?
-
See SearchChoices class.
final
-
searchResultDisplayFn
→ (Widget Function({required Widget displayItem(DropdownMenuItem item, bool isItemSelected), required Widget emptyListWidget, required void itemTapped(int index, T value, bool itemSelected), required List<
Tuple3< itemsToDisplay, required ScrollController scrollController, required bool thumbVisibility})?)int, DropdownMenuItem, bool> > -
See SearchChoices class.
final
-
selectedItems
→ List<
int> ? -
See SearchChoices class.
final
- style → TextStyle?
-
See SearchChoices class.
final
- updateParent → Function?
-
Function called to update the parent screen when necessary. Calls
setState.
final
- validator → Function?
-
See SearchChoices class.
final
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → _DropdownDialogState< T> -
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}) → 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