Abstract Class: ProcedureParameterBase
Defined in: plugins/block-shareable-procedures/src/events_procedure_parameter_base.ts:14
The base event for an event associated with a procedure parameter.
Extends
Extended by
Properties index
| Property | Description |
|---|---|
| group | An ID for the group of events this block is associated with. |
| isBlank | Whether or not the event was constructed without necessary parameters (to be populated by fromJson). |
| isUiEvent | Whether or not the event is a UI event. |
| parameter | The parameter model associated with this event. |
| procedure | The procedure model associated with this event. |
| recordUndo | Whether this event is undoable or not. |
| type | A string used to check the type of the event. |
| workspaceId | The workspace identifier for this event. |
| TYPE | - |
Methods index
| Method | Description |
|---|---|
| getEventWorkspace_ | Get workspace the event belongs to. |
| isNull | Does this event record any change of state? |
| run | Run an event. |
| toJson | Encode the event as JSON. |
Constructors
Constructor
new ProcedureParameterBase(
workspace,
procedure,
parameter
): ProcedureParameterBase;
Defined in: plugins/block-shareable-procedures/src/events_procedure_parameter_base.ts:27
Constructs the procedure parameter base event.
Parameters
| Parameter | Type | Description |
|---|---|---|
workspace | Workspace | The workspace the parameter model exists in. |
procedure | IProcedureModel | The procedure model the parameter model belongs to. |
parameter | IParameterModel | The parameter model associated with this event. |
Returns
ProcedureParameterBase
Overrides
Properties
group
group: string;
An ID for the group of events this block is associated with.
Groups define events that should be treated as an single action from the user's perspective, and should be undone together.
Inherited from
isBlank
isBlank: boolean = false;
Defined in: plugins/block-shareable-procedures/src/events_procedure_base.ts:18
Whether or not the event was constructed without necessary parameters (to be populated by fromJson).
Inherited from
isUiEvent
isUiEvent: boolean;
Whether or not the event is a UI event.
Inherited from
parameter
readonly parameter: IParameterModel;
Defined in: plugins/block-shareable-procedures/src/events_procedure_parameter_base.ts:30
The parameter model associated with this event.
procedure
readonly procedure: IProcedureModel;
Defined in: plugins/block-shareable-procedures/src/events_procedure_base.ts:28
The procedure model associated with this event.
Inherited from
recordUndo
recordUndo: boolean;
Whether this event is undoable or not.
Inherited from
type
type: string = ProcedureParameterBase.TYPE;
Defined in: plugins/block-shareable-procedures/src/events_procedure_parameter_base.ts:18
A string used to check the type of the event.
Overrides
workspaceId?
workspaceId?: string;
The workspace identifier for this event.
Inherited from
TYPE
readonly static TYPE: string = 'procedure_parameter_base';
Defined in: plugins/block-shareable-procedures/src/events_procedure_parameter_base.ts:15
Overrides
Methods
getEventWorkspace_()
getEventWorkspace_(): Workspace;
Get workspace the event belongs to.
Returns
Workspace
The workspace the event belongs to.
Throws
if workspace is null.
Inherited from
ProcedureBase.getEventWorkspace_
isNull()
isNull(): boolean;
Does this event record any change of state?
Returns
boolean
True if null, false if something changed.
Inherited from
run()
run(_forward): void;
Run an event.
Parameters
| Parameter | Type | Description |
|---|---|---|
_forward | boolean | True if run forward, false if run backward (undo). |
Returns
void
Inherited from
toJson()
toJson(): ProcedureParameterBaseJson;
Defined in: plugins/block-shareable-procedures/src/events_procedure_parameter_base.ts:66
Encode the event as JSON.
Returns
JSON representation.