Abstract Class: Abstract

Defined in: packages/blockly/core/events/events_abstract.ts:22

Abstract class for an event.

Extended by

• BlockBase
• CommentBase
• UiBase
• VarBase
• FinishedLoading

Properties index

Property	Description
isBlank	Whether or not the event was constructed without necessary parameters (to be populated by fromJson).
workspaceId	The workspace identifier for this event.
group	An ID for the group of events this block is associated with.
recordUndo	Whether this event is undoable or not.
isUiEvent	Whether or not the event is a UI event.
type	Type of this event.

Methods index

Method	Description
toJson	Encode the event as JSON.
isNull	Does this event record any change of state?
run	Run an event.
getEventWorkspace_	Get workspace the event belongs to.

Constructors

Constructor

new Abstract(): Abstract;

Defined in: packages/blockly/core/events/events_abstract.ts:49

Returns

Abstract

Properties

isBlank

abstract isBlank: boolean;

Defined in: packages/blockly/core/events/events_abstract.ts:27

Whether or not the event was constructed without necessary parameters (to be populated by fromJson).

---

workspaceId?

optional workspaceId?: string = undefined;

Defined in: packages/blockly/core/events/events_abstract.ts:30

The workspace identifier for this event.

---

group

group: string;

Defined in: packages/blockly/core/events/events_abstract.ts:38

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.

---

recordUndo

recordUndo: boolean;

Defined in: packages/blockly/core/events/events_abstract.ts:41

Whether this event is undoable or not.

---

isUiEvent

isUiEvent: boolean = false;

Defined in: packages/blockly/core/events/events_abstract.ts:44

Whether or not the event is a UI event.

---

type

type: string = '';

Defined in: packages/blockly/core/events/events_abstract.ts:47

Type of this event.

Methods

toJson()

toJson(): AbstractEventJson;

Defined in: packages/blockly/core/events/events_abstract.ts:59

Encode the event as JSON.

Returns

AbstractEventJson

JSON representation.

---

isNull()

isNull(): boolean;

Defined in: packages/blockly/core/events/events_abstract.ts:91

Does this event record any change of state?

Returns

boolean

True if null, false if something changed.

---

run()

run(_forward): void;

Defined in: packages/blockly/core/events/events_abstract.ts:100

Run an event.

Parameters

Parameter	Type	Description
_forward	boolean	True if run forward, false if run backward (undo).

Returns

void

---

getEventWorkspace_()

getEventWorkspace_(): Workspace;

Defined in: packages/blockly/core/events/events_abstract.ts:111

Get workspace the event belongs to.

Returns

Workspace

The workspace the event belongs to.

Throws

if workspace is null.