Skip to main content

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​

PropertyDescription
groupAn ID for the group of events this block is associated with.
isBlankWhether or not the event was constructed without necessary parameters (to be populated by fromJson).
isUiEventWhether or not the event is a UI event.
parameterThe parameter model associated with this event.
procedureThe procedure model associated with this event.
recordUndoWhether this event is undoable or not.
typeA string used to check the type of the event.
workspaceIdThe workspace identifier for this event.
TYPE-

Methods index​

MethodDescription
getEventWorkspace_Get workspace the event belongs to.
isNullDoes this event record any change of state?
runRun an event.
toJsonEncode 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​

ParameterTypeDescription
workspaceWorkspaceThe workspace the parameter model exists in.
procedureIProcedureModelThe procedure model the parameter model belongs to.
parameterIParameterModelThe parameter model associated with this event.

Returns​

ProcedureParameterBase

Overrides​

ProcedureBase.constructor

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​

ProcedureBase.group


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​

ProcedureBase.isBlank


isUiEvent​

isUiEvent: boolean;

Whether or not the event is a UI event.

Inherited from​

ProcedureBase.isUiEvent


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​

ProcedureBase.procedure


recordUndo​

recordUndo: boolean;

Whether this event is undoable or not.

Inherited from​

ProcedureBase.recordUndo


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​

ProcedureBase.type


workspaceId?​

workspaceId?: string;

The workspace identifier for this event.

Inherited from​

ProcedureBase.workspaceId


TYPE​

readonly static TYPE: string = 'procedure_parameter_base';

Defined in: plugins/block-shareable-procedures/src/events_procedure_parameter_base.ts:15

Overrides​

ProcedureBase.TYPE

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​

ProcedureBase.isNull


run()​

run(_forward): void;

Run an event.

Parameters​

ParameterTypeDescription
_forwardbooleanTrue if run forward, false if run backward (undo).

Returns​

void

Inherited from​

ProcedureBase.run


toJson()​

toJson(): ProcedureParameterBaseJson;

Defined in: plugins/block-shareable-procedures/src/events_procedure_parameter_base.ts:66

Encode the event as JSON.

Returns​

ProcedureParameterBaseJson

JSON representation.

Overrides​

ProcedureBase.toJson