Skip to main content

ParameterizedAction<P, T>

Extends

Extended by

Type Parameters

Type ParameterDefault type
P extends Partial<ParameterizedActionGenerics>Partial<ParameterizedActionGenerics>
T extends ParameterizedActionGenerics & PParameterizedActionGenerics & P

Constructors

Constructor

new ParameterizedAction<P, T>(options): ParameterizedAction<P, T>;

Parameters

ParameterType
optionsP["OPTIONS"]

Returns

ParameterizedAction<P, T>

Overrides

Action.constructor

Properties

PropertyTypeInherited from
actionStoreActionStoreAction.actionStore
optionsT["OPTIONS"]Action.options

Accessors

dialogStore

Inherited from

Action.dialogStore


group

Get Signature

get group(): string;
Returns

string

Inherited from

Action.group


id

Get Signature

get id(): string;
Returns

string

Inherited from

Action.id


visorStore

Inherited from

Action.visorStore

Methods

collectParams()

collectParams(event): Promise<boolean>;

Parameters

ParameterType
eventOmit<T["EVENT"], "id">

Returns

Promise<boolean>


fireAction()

fireAction(event): Promise<boolean>;

Parameters

ParameterType
eventOmit<T["EVENT"], "id">

Returns

Promise<boolean>

Overrides

Action.fireAction


getExclusiveExecutionLock()

getExclusiveExecutionLock(event?): () => any;

Parameters

ParameterType
event?{ allowed?: (e) => boolean; }
event.allowed?(e) => boolean

Returns

() => any

Inherited from

Action.getExclusiveExecutionLock


getTypeDisplayName()

getTypeDisplayName(): string;

Returns

string

Overrides

Action.getTypeDisplayName


renderAsButton()

renderAsButton(render, extraData?): Element;

Parameters

ParameterType
render(btn) => Element
extraDataPartial<T["EVENT"]>

Returns

Element

Inherited from

Action.renderAsButton


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

ParameterType
extraDataPartial<T["EVENT"]>

Returns

Btn

Inherited from

Action.representAsButton


representAsComboBoxItem()

representAsComboBoxItem(options?): ActionComboBoxItem<ParameterizedAction<P, T>>;

Parameters

ParameterType
options{ eventData?: Partial<T["EVENT"]>; installAction: boolean; }
options.eventData?Partial<T["EVENT"]>
options.installActionboolean

Returns

ActionComboBoxItem<ParameterizedAction<P, T>>

Inherited from

Action.representAsComboBoxItem


representAsControl()

representAsControl(options?): any;

Parameters

ParameterType
options{ eventData?: Partial<T["EVENT"]>; }
options.eventData?Partial<T["EVENT"]>

Returns

any

Inherited from

Action.representAsControl


representAsIcon()

representAsIcon(extraData?): Btn;

Parameters

ParameterType
extraDataPartial<T["EVENT"]>

Returns

Btn

Inherited from

Action.representAsIcon


serialize()

serialize(): SerializedAction;

Returns

SerializedAction

Inherited from

Action.serialize


setActionStore()

setActionStore(store): void;

Parameters

ParameterType
storeActionStore

Returns

void

Inherited from

Action.setActionStore


validate()

validate(event?): ValidationResult;

Parameters

ParameterType
eventPartial<T["EVENT"]>

Returns

ValidationResult

Inherited from

Action.validate