S2MultiState<T> class

State for Multiple Choice

Inheritance

• Object
• State<SmartSelect<T>>
• S2State<T>
• S2MultiState

Constructors

S2MultiState()

Properties

builder → S2MultiBuilder<T>?

Returns the builders collection

no setter, override

choiceActiveStyle → S2ChoiceStyle?

Returns the active choice style

no setter, inherited

choiceConfig → S2ChoiceConfig

Returns the choice config

no setter, inherited

choiceEmpty → Widget

Returns the choice empty widget

no setter, inherited

choiceList → Widget

Returns the choice items widget

no setter, inherited

choiceListBuilder → S2ChoiceListBuilder<T>

Returns the choice item builder by it's current state

no setter, inherited

choiceProgress → Widget

Returns the indicator widget indicates the choices is processing

no setter, inherited

choiceResolver → S2ChoiceResolver<T>

Returns the default choice builder by its type

no setter, inherited

choices ↔ S2Choices<T>?

State of the choice items

getter/setter pair, inherited

choiceSelectorAll → Widget

Returns the choices selector widget

no setter, override

choiceStyle → S2ChoiceStyle?

Returns the choice style

no setter, inherited

confirmButton → Widget

Returns the confirm button widget

no setter, inherited

context → BuildContext

The location in the tree where this widget builds.

no setter, inherited

customChoiceEmpty → Widget?

Returns the custom empty choice widget

no setter, override

customConfirmButton → Widget?

Returns the custom confirm button widget

no setter, override

customModal → Widget?

Returns the custom modal widget

no setter, override

customModalActions → List<Widget>?

Returns the custom modal actions widgets

no setter, override

customModalFilter → Widget?

Returns the custom modal filter widget

no setter, override

customModalFilterToggle → Widget?

Returns the custom widget to show/hide modal filter

no setter, override

customModalHeader → Widget?

Returns the custom modal header

no setter, override

debouncer → Debouncer

Debouncer used in search text on changed

final, inherited

defaultActiveChoiceStyle → S2ChoiceStyle

Returns the default style for selected choice

no setter, inherited

defaultChoiceEmpty → Widget

Returns the default choice empty widget

no setter, inherited

defaultChoiceStyle → S2ChoiceStyle

Returns the default style for unselected choice

no setter, inherited

defaultConfirmButton → Widget

Returns the default confirm button widget

no setter, inherited

defaultModal → Widget

Returns the default modal widget

no setter, inherited

defaultModalActions → List<Widget>

Returns the default modal actions widgets

no setter, inherited

defaultModalFilter → Widget

Returns the default modal filter widget

no setter, inherited

defaultModalFilterToggle → Widget

Returns the default widget to show/hide modal filter

no setter, inherited

defaultModalHeader → Widget

Returns the default modal header widget

no setter, inherited

defaultTile → Widget

Returns the default trigger tile widget

no setter, inherited

filter ↔ S2Filter?

State of the filter operation

getter/setter pair, inherited

groupConfig → S2GroupConfig

Returns the group config

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

isMultiChoice → bool

Returns true if the widget is multiple choice

no setter, inherited

isSingleChoice → bool

Returns true if the widget is single choice

no setter, inherited

modal → Widget

Returns the modal widget

no setter, inherited

modalActions → List<Widget>

Returns the modal action widgets

no setter, inherited

modalBody → Widget

Returns the modal body widget

no setter, inherited

modalConfig → S2ModalConfig

Returns the modal config

no setter, inherited

modalContext ↔ BuildContext

Context of the modal

getter/setter pair, inherited

modalDivider → Widget?

Returns the modal divider widget

no setter, override

modalError → Widget

Returns the modal error widget

no setter, inherited

modalErrorController ↔ S2TextErrorController

getter/setter pair, inherited

modalFilter → Widget

Returns the modal filter widget

no setter, inherited

modalFilterToggle → Widget?

Returns the widget to show/hide modal filter

no setter, inherited

modalFooter → Widget?

Returns the modal footer widget

no setter, override

modalHeader → Widget?

Returns the modal header widget

no setter, inherited

modalHeaderStyle → S2ModalHeaderStyle

Returns the modal header style

no setter, inherited

modalSetState ↔ StateSetter?

State setter of the modal

getter/setter pair, inherited

modalStyle → S2ModalStyle

Returns the modal style

no setter, inherited

modalTitle → Widget

Returns the modal title widget

no setter, inherited

modalValidation → S2Validation<S2MultiChosen<T>>?

Returns the validation function to validate the selection made in the modal, if null fallback to validation

no setter, override

mounted → bool

Whether this State object is currently in a tree.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

selected → S2MultiSelected<T>

State of the selected choice(s)

no setter, override

selection ↔ S2MultiSelection<T>?

State of the selected choice(s) State of choice(s) selection in the modal

covariant, getter/setter pair, override

theme → ThemeData

Returns ThemeData from the widget context

no setter, inherited

title → String?

Returns the text used as title in trigger tile

no setter, inherited

titleWidget → Widget

Returns title in Text widget

no setter, inherited

validation → S2Validation<S2MultiChosen<T>>?

Returns the validation function to validate the selected choice

no setter, override

widget → SmartSelect<T>

The current configuration.

no setter, inherited

Methods

activate() → void

Called when this object is reinserted into the tree after having been removed via deactivate.

inherited

build(BuildContext context) → Widget

Describes the part of the user interface represented by this widget.

override

choiceBuilder(S2Choice<T> choice) → Widget?

Returns the choice item builder from resolver by it's type

override

choiceSecondary(S2Choice<T> choice) → Widget?

Returns the secondary/avatar widget

override

choiceSelector(List<S2Choice<T>>? values) → Widget

Function to create toggle selector checkbox widget

override

choiceSubtitle(S2Choice<T> choice) → Widget?

Returns the choice subtitle widget

override

choiceTitle(S2Choice<T> choice) → Widget?

Returns the choice title widget

override

closeModal({bool confirmed = true}) → void

Function to close the choice modal

inherited

customGroup(S2Group<T> group) → Widget?

Returns the custom grouped choices widget

override

customGroupHeader(S2Group<T> group) → Widget?

Returns the custom group header widget

override

deactivate() → void

Called when this object is removed from the tree.

inherited

debugFillProperties(DiagnosticPropertiesBuilder properties) → void

Add additional properties associated with the node.

inherited

defaultChoiceSubtitle(S2Choice<T> choice) → Widget

Returns the default choice subtitle widget

inherited

defaultChoiceTitle(S2Choice<T> choice) → Widget

Returns the default choice title widget

inherited

defaultGroup(S2Group<T> group) → Widget

Returns the default grouped choices widget

inherited

defaultGroupHeader(S2Group<T> group) → Widget

Returns the default group header widget

inherited

defaultModalWillClose() → Future<bool>

inherited

didChangeDependencies() → void

Called when a dependency of this State object changes.

inherited

didUpdateWidget(covariant SmartSelect<T> oldWidget) → void

Called whenever the widget configuration changes.

override

dispose() → void

Called when this object is removed from the tree permanently.

inherited

groupChoices(S2Group<T> group) → Widget

Returns the group choices widget

inherited

groupCounter(S2Group<T> group) → Widget

Returns the group counter widget

inherited

groupedChoices(List<S2Group<T>> groups) → Widget

Returns the grouped choice items widget

inherited

groupHeader(S2Group<T> group) → Widget

Returns the group header widget

inherited

initializeFilter() → void

Function to initialize filter

inherited

initState() → void

Called when this object is inserted into the tree.

inherited

modalErrorShake() → void

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

onChange() → void

Called when the modal closed and selection has confirmed

override

onModalClose(bool confirmed) → void

Called when modal closed

override

onModalOpen() → void

Called when modal opened

override

onModalWillClose() → Future<bool>

Called when modal closed

override

onModalWillOpen() → Future<bool>?

Called when modal opened

override

onSelect(S2Choice<T> choice) → void

Called when selection has made

override

reassemble() → void

Called whenever the application is reassembled during debugging, for example during hot reload.

inherited

resolveChoices() → void

Function to resolve the choices

inherited

resolveSelected() → void

Initiate the selected choice

override

resolveSelection() → void

Function to resolve the selected

override

selectedHandler() → void

The selected listener handler

inherited

selectionHandler() → void

The selection listener handler

inherited

setState(VoidCallback fn) → void

Notify the framework that the internal state of this object has changed.

inherited

showModal() → void

Function to show the choice modal

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

toStringShort() → String

A brief description of this object, usually just the runtimeType and the hashCode.

inherited

ungroupedChoices(List<S2Choice<T>>? choiceList) → Widget

Returns the ungrouped choice items widget

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited