@serenity-is/corelib / GridRadioSelectionMixin
Class: GridRadioSelectionMixin
Defined in: src/ui/helpers/gridradioselectionmixin.tsx:19
A mixin that adds single (radio) row selection behavior to a data grid.
Constructors
Constructor
new GridRadioSelectionMixin(
grid,options?):GridRadioSelectionMixin
Defined in: src/ui/helpers/gridradioselectionmixin.tsx:33
Creates a new GridRadioSelectionMixin for the given grid.
Parameters
grid
The data grid to attach the mixin to.
options?
GridRadioSelectionMixinOptions
Optional mixin options.
Returns
GridRadioSelectionMixin
Properties
[typeInfo]
static[typeInfo]:ClassTypeInfo<"Serenity.">
Defined in: src/ui/helpers/gridradioselectionmixin.tsx:21
Methods
clear()
clear():
void
Defined in: src/ui/helpers/gridradioselectionmixin.tsx:72
Clears the current selection.
Returns
void
getSelectedAsInt32()
getSelectedAsInt32():
number
Defined in: src/ui/helpers/gridradioselectionmixin.tsx:101
Returns the selected key parsed as a 32-bit integer, or null if none is selected.
Returns
number
The selected key as an int32, or null.
getSelectedAsInt64()
getSelectedAsInt64():
number
Defined in: src/ui/helpers/gridradioselectionmixin.tsx:117
Returns the selected key parsed as a 64-bit integer, or null if none is selected.
Returns
number
The selected key as an int64, or null.
getSelectedKey()
getSelectedKey():
string
Defined in: src/ui/helpers/gridradioselectionmixin.tsx:88
Returns the key of the currently selected item, or null if none is selected.
Returns
string
The selected key, or null.
resetCheckedAndRefresh()
resetCheckedAndRefresh():
void
Defined in: src/ui/helpers/gridradioselectionmixin.tsx:79
Clears the current selection and refreshes the grid view.
Returns
void
setSelectedKey()
setSelectedKey(
key):void
Defined in: src/ui/helpers/gridradioselectionmixin.tsx:133
Selects the item with the given key, clearing any previous selection.
Parameters
key
string
The key of the item to select.
Returns
void
createSelectColumn()
staticcreateSelectColumn(getMixin,columnOptions?):Column
Defined in: src/ui/helpers/gridradioselectionmixin.tsx:144
Creates a radio select column for the grid.
Parameters
getMixin
() => GridRadioSelectionMixin
A function that returns the mixin instance.
columnOptions?
Partial<Column>
Optional column options to merge into the select column.
Returns
Column
The select column definition.