SelectorRow class
Row component which allows children to be selected with left and right arrow keys. Passes keys through to the selected child.
- Inheritance
-
- Object
- Renderable
- Component
- StatefulComponent<
int?> - SelectorFlex
- SelectorRow
Constructors
-
SelectorRow({required String? key, required bool focused, required List<
Renderable Function(bool focused)> children, FlexAlignment alignment = FlexAlignment.start, CrossAxisAlignment crossAxisAlignment = CrossAxisAlignment.stretch, bool crossAxisTight = false, bool extraControl(ProviderContainer container, KeyInput key, int getState(ProviderContainer), void setState(ProviderContainer container, int update(int)), int length)?, bool controlOverrideChild = false, int startingState = 0, dynamic dependency}) -
Row component which allows children to be selected with left and right arrow keys.
Passes keys through to the selected child.
const
Properties
- alignment → FlexAlignment
-
Main axis flex alignment.
finalinherited
- axis → Axis
-
Main axis of the flex.
finalinherited
-
children
→ List<
Renderable Function(bool focused)> -
List of builders returning children (depending on focused for their decoration).
Children should not change in size depending on focused.
finalinherited
- controlOverrideChild → bool
-
Adds extra controls before consulting the child.
finalinherited
- crossAxisAlignment → CrossAxisAlignment
-
Cross axis flex alignment.
finalinherited
- crossAxisTight → bool
-
Whether to be tight to children in the cross axis.
finalinherited
- dependency → dynamic
-
Provider dependency; when it changes this component's state is invalidated.
finalinherited
- extraControl → bool Function(ProviderContainer container, KeyInput key, int getState(ProviderContainer), void setState(ProviderContainer container, int update(int)), int length)?
-
Adds extra controls.
finalinherited
- focused → bool
-
Whether to pass focused to selected child.
finalinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- key → String?
-
Key used to differentiate the states of different instances of this component.
finalinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
selectableChildren
→ Iterable<
Renderable Function(bool focused)> -
Children which can be selected (i.e. not wrapped in SkipSelect).
no setterinherited
- startingState → int
-
Starting selected child.
finalinherited
- stateProvider → dynamic
-
Reference to this class's state provider. Provide a static final StateProvider of the correct type, using key if relevant.
no setterinherited
Methods
-
build(
ProviderContainer container) → Renderable -
Return a Renderable which is to be displayed.
inherited
-
getSize(
ProviderContainer container, Axis axis, int crossSize) → int? -
Report this item's intrinsic size, or null if it has none.
inherited
-
getState(
ProviderContainer container) → int -
Read the current state of this component.
inherited
-
getUsageInfo(
ProviderContainer container) → UsageInfo -
Return usage info for this renderable, or redirect to its child.
inherited
-
keyPressed(
ProviderContainer container, KeyInput key) → bool -
Handle key presses. Return
trueif the key was absorbed, orfalseif another listener further up the tree should handle it.inherited -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
render(
ProviderContainer container, int width, int height) → AxelMap -
Produce an AxelMap of the specified size to be shown on screen.
inherited
-
setState(
ProviderContainer container, int? update(int?)) → void -
Update this component's state.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Properties
- provider → dynamic
-
Get this component's internal state provider.
no setter
Static Methods
-
read(
ProviderContainer container, String? key, [int startingState = 0]) → int -
Read this component's internal state.
override