EntityHandlerComponent<T>
Extends
Extended by
Type Parameters
| Type Parameter | Default type |
|---|---|
T extends any | any |
Constructors
Constructor
new EntityHandlerComponent<T>(options?): EntityHandlerComponent<T>;
Parameters
| Parameter | Type |
|---|---|
options | EntityHandlerComponentOptions |
Returns
EntityHandlerComponent<T>
Overrides
EntityDefinitionComponent.constructor
Properties
| Property | Modifier | Type | Default value | Inherited from |
|---|---|---|---|---|
definition | public | EntityDefinition | undefined | EntityDefinitionComponent.definition |
preferred | readonly | boolean | undefined | - |
type | public | string | undefined | EntityDefinitionComponent.type |
uuid | public | string | undefined | - |
TYPE | static | string | 'handler' | - |
Accessors
system
Get Signature
get system(): System;
Returns
Inherited from
EntityDefinitionComponent.system
Methods
getDescription()
abstract getDescription(entity): Omit<ComboBoxItem, "key">;
Parameters
| Parameter | Type |
|---|---|
entity | T |
Returns
Omit<ComboBoxItem, "key">
getPreferredActionId()
getPreferredActionId(): string;
Returns
string
openEntity()
abstract openEntity(event): Promise<any>;
Parameters
| Parameter | Type |
|---|---|
event | OpenEntityEvent<T> |
Returns
Promise<any>
setDefinition()
setDefinition(definition): void;
Parameters
| Parameter | Type |
|---|---|
definition | EntityDefinition |
Returns
void