Class: UiBase

Defined in: packages/blockly/core/events/events_ui_base.ts:24

Base class for a UI event. UI events are events that don't need to be sent over the wire for multi-user editing to work (e.g. scrolling the workspace, zooming, opening toolbox categories). UI events do not undo or redo.

Extends

• Abstract

Extended by

• BlockDrag
• BubbleOpen
• Click
• CommentDrag
• Selected
• ThemeChange
• ToolboxItemSelect
• TrashcanOpen
• ViewportChange

Properties index

Property	Description
group	An ID for the group of events this block is associated with.
type	Type of this event.
isBlank	Whether or not the event was constructed without necessary parameters (to be populated by fromJson).
workspaceId	The workspace identifier for this event.
recordUndo	Whether this event is undoable or not.
isUiEvent	Whether or not the event is a UI 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 UiBase(opt_workspaceId?): UiBase;

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

Parameters

Parameter	Type	Description
opt_workspaceId?	string	The workspace identifier for this event. Undefined for a blank event.

Returns

UiBase

Overrides

Abstract.constructor

Properties

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.

Inherited from

Abstract.group

---

type

type: string = '';

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

Type of this event.

Inherited from

Abstract.type

---

isBlank

isBlank: boolean = true;

Defined in: packages/blockly/core/events/events_ui_base.ts:25

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

Overrides

Abstract.isBlank

---

workspaceId

workspaceId: string;

Defined in: packages/blockly/core/events/events_ui_base.ts:26

The workspace identifier for this event.

Overrides

Abstract.workspaceId

---

recordUndo

recordUndo: boolean = false;

Defined in: packages/blockly/core/events/events_ui_base.ts:29

Whether this event is undoable or not.

Overrides

Abstract.recordUndo

---

isUiEvent

isUiEvent: boolean = true;

Defined in: packages/blockly/core/events/events_ui_base.ts:32

Whether or not the event is a UI event.

Overrides

Abstract.isUiEvent

Methods

toJson()

toJson(): AbstractEventJson;

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

Encode the event as JSON.

Returns

AbstractEventJson

JSON representation.

Inherited from

Abstract.toJson

---

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.

Inherited from

Abstract.isNull

---

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

Inherited from

Abstract.run

---

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.

Inherited from

Abstract.getEventWorkspace_