CoupledAction<TARGET, SOURCE, Event>

Extends

• EntityAction<TARGET, Event, CoupledActionOptions>

Type Parameters

Type Parameter	Default type
TARGET	any
SOURCE	any
Event extends CoupledActionEvent<TARGET, SOURCE>	CoupledActionEvent<TARGET, SOURCE>

Constructors

Constructor

new CoupledAction<TARGET, SOURCE, Event>(options): CoupledAction<TARGET, SOURCE, Event>;

Parameters

Parameter	Type
options	CoupledActionOptions

Returns

CoupledAction<TARGET, SOURCE, Event>

Overrides

EntityAction.constructor

Properties

Property	Type	Inherited from
actionStore	ActionStore	EntityAction.actionStore
options	ParameterizedActionOptions & CoupledActionOptions	EntityAction.options

Accessors

dialogStore

Inherited from

EntityAction.dialogStore

---

group

Get Signature

get group(): string;

Returns

string

Inherited from

EntityAction.group

---

id

Get Signature

get id(): string;

Returns

string

Inherited from

EntityAction.id

---

visorStore

Inherited from

EntityAction.visorStore

Methods

collectParams()

collectParams(event): Promise<boolean>;

Parameters

Parameter	Type
event	Event

Returns

Promise<boolean>

Overrides

EntityAction.collectParams

---

fireAction()

fireAction(event): Promise<boolean>;

Parameters

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

Returns

Promise<boolean>

Inherited from

EntityAction.fireAction

---

getExclusiveExecutionLock()

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

Parameters

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

Returns

() => any

Inherited from

EntityAction.getExclusiveExecutionLock

---

getTypeDisplayName()

getTypeDisplayName(): string;

Returns

string

Overrides

EntityAction.getTypeDisplayName

---

renderAsButton()

renderAsButton(render, extraData?): Element;

Parameters

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

Returns

Element

Inherited from

EntityAction.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

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

Returns

Btn

Inherited from

EntityAction.representAsButton

---

representAsComboBoxItem()

representAsComboBoxItem(options?): ActionComboBoxItem<CoupledAction<TARGET, SOURCE, Event>>;

Parameters

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

Returns

ActionComboBoxItem<CoupledAction<TARGET, SOURCE, Event>>

Inherited from

EntityAction.representAsComboBoxItem

---

representAsControl()

representAsControl(options?): any;

Parameters

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

Returns

any

Inherited from

EntityAction.representAsControl

---

representAsIcon()

representAsIcon(extraData?): Btn;

Parameters

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

Returns

Btn

Inherited from

EntityAction.representAsIcon

---

serialize()

serialize(): SerializedAction;

Returns

SerializedAction

Inherited from

EntityAction.serialize

---

setActionStore()

setActionStore(store): void;

Parameters

Parameter	Type
store	ActionStore

Returns

void

Inherited from

EntityAction.setActionStore

---

validate()

validate(event?): ValidationResult;

Parameters

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

Returns

ValidationResult

Inherited from

EntityAction.validate