Action<P, T, L>

Extends

• BaseObserver<L>

Extended by

• ParameterizedAction
• ResetPreferencesAction
• ResetWorkspacesAction
• ExportShortcutsAction
• OpenCMDPalletAction

Type Parameters

Type Parameter	Default type
P extends Partial<ActionGenerics>	Partial<ActionGenerics>
T extends ActionGenerics & P	ActionGenerics & P
L extends ActionListener<T["EVENT"]>	ActionListener<T["EVENT"]>

Constructors

Constructor

new Action<P, T, L>(options): Action<P, T, L>;

Parameters

Parameter	Type
options	T["OPTIONS"]

Returns

Action<P, T, L>

Overrides

BaseObserver<L>.constructor

Properties

Property	Type
actionStore	ActionStore
options	T["OPTIONS"]

Accessors

dialogStore

---

group

Get Signature

get group(): string;

Returns

string

---

id

Get Signature

get id(): string;

Returns

string

---

visorStore

Methods

fireAction()

fireAction(event): Promise<boolean | void>;

Parameters

Parameter	Type
event	Omit<T["EVENT"], "id">

Returns

Promise<boolean | void>

---

getExclusiveExecutionLock()

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

Parameters

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

Returns

() => any

---

getTypeDisplayName()

getTypeDisplayName(): string;

Returns

string

---

renderAsButton()

renderAsButton(render, extraData?): Element;

Parameters

Parameter	Type
render	(btn) => Element
extraData	Partial<T["EVENT"]>

Returns

Element

---

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

Btn

---

representAsComboBoxItem()

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

Parameters

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

Returns

ActionComboBoxItem<Action<P, T, L>>

---

representAsControl()

representAsControl(options?): any;

Parameters

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

Returns

any

---

representAsIcon()

representAsIcon(extraData?): Btn;

Parameters

Parameter	Type
extraData	Partial<T["EVENT"]>

Returns

Btn

---

serialize()

serialize(): SerializedAction;

Returns

SerializedAction

---

setActionStore()

setActionStore(store): void;

Parameters

Parameter	Type
store	ActionStore

Returns

void

---

validate()

validate(event?): ValidationResult;

Parameters

Parameter	Type
event	Partial<T["EVENT"]>

Returns

ValidationResult