ParameterizedAction<P, T>
Extends
Action<P,T,ParameterizedActionListener<T["EVENT"]>>
Extended by
Type Parameters
| Type Parameter | Default type |
|---|---|
P extends Partial<ParameterizedActionGenerics> | Partial<ParameterizedActionGenerics> |
T extends ParameterizedActionGenerics & P | ParameterizedActionGenerics & P |
Constructors
Constructor
new ParameterizedAction<P, T>(options): ParameterizedAction<P, T>;
Parameters
| Parameter | Type |
|---|---|
options | P["OPTIONS"] |
Returns
ParameterizedAction<P, T>
Overrides
Properties
| Property | Type | Inherited from |
|---|---|---|
actionStore | ActionStore | Action.actionStore |
options | T["OPTIONS"] | Action.options |
Accessors
dialogStore
Inherited from
group
Get Signature
get group(): string;
Returns
string
Inherited from
id
Get Signature
get id(): string;
Returns
string
Inherited from
visorStore
Inherited from
Methods
collectParams()
collectParams(event): Promise<boolean>;
Parameters
| Parameter | Type |
|---|---|
event | Omit<T["EVENT"], "id"> |
Returns
Promise<boolean>
fireAction()
fireAction(event): Promise<boolean>;
Parameters
| Parameter | Type |
|---|---|
event | Omit<T["EVENT"], "id"> |
Returns
Promise<boolean>
Overrides
getExclusiveExecutionLock()
getExclusiveExecutionLock(event?): () => any;
Parameters
| Parameter | Type |
|---|---|
event? | { allowed?: (e) => boolean; } |
event.allowed? | (e) => boolean |
Returns
() => any
Inherited from
Action.getExclusiveExecutionLock
getTypeDisplayName()
getTypeDisplayName(): string;
Returns
string
Overrides
renderAsButton()
renderAsButton(render, extraData?): Element;
Parameters
| Parameter | Type |
|---|---|
render | (btn) => Element |
extraData | Partial<T["EVENT"]> |
Returns
Element
Inherited from
representAsButton()
representAsButton(extraData?): Btn;
Create a button representation of this action.
The button carries a live validation function, so consumers that render a Btn directly get the same dynamic enabled/disabled behavior as action controls.
Parameters
| Parameter | Type |
|---|---|
extraData | Partial<T["EVENT"]> |
Returns
Inherited from
representAsComboBoxItem()
representAsComboBoxItem(options?): ActionComboBoxItem<ParameterizedAction<P, T>>;
Parameters
| Parameter | Type |
|---|---|
options | { eventData?: Partial<T["EVENT"]>; installAction: boolean; } |
options.eventData? | Partial<T["EVENT"]> |
options.installAction | boolean |
Returns
ActionComboBoxItem<ParameterizedAction<P, T>>
Inherited from
Action.representAsComboBoxItem
representAsControl()
representAsControl(options?): any;
Parameters
| Parameter | Type |
|---|---|
options | { eventData?: Partial<T["EVENT"]>; } |
options.eventData? | Partial<T["EVENT"]> |
Returns
any
Inherited from
representAsIcon()
representAsIcon(extraData?): Btn;
Parameters
| Parameter | Type |
|---|---|
extraData | Partial<T["EVENT"]> |
Returns
Inherited from
serialize()
serialize(): SerializedAction;
Returns
Inherited from
setActionStore()
setActionStore(store): void;
Parameters
| Parameter | Type |
|---|---|
store | ActionStore |
Returns
void
Inherited from
validate()
validate(event?): ValidationResult;
Parameters
| Parameter | Type |
|---|---|
event | Partial<T["EVENT"]> |