Constructor

Ui

new Ui(block, element, oldValue, newValue)

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.

Parameter

block

Blockly.Block

The affected block.

element

string

One of 'selected', 'comment', 'mutator', etc.

oldValue

any type

Previous value of element.

newValue

any type

New value of element.

Extends
Blockly.Events.Abstract

Properties

group

unknown

The event group id for the group this event belongs to. Groups define events that should be treated as an single action from the user's perspective, and should be undone together.

Inherited from
Blockly.Events.Abstract#group

recordUndo

unknown

Sets whether the event should be added to the undo stack.

Inherited from
Blockly.Events.Abstract#recordUndo

type

string

Type of this event.

workspaceId

unknown

The workspace identifier for this event.

Inherited from
Blockly.Events.Abstract#workspaceId

Methods

fromJson

fromJson(json)

Decode the JSON event.

Parameter

json

Object

JSON representation.

Value must not be null.

getEventWorkspace_

protected

getEventWorkspace_() returns Blockly.Workspace

Get workspace the event belongs to.

Inherited from
Blockly.Events.Abstract#getEventWorkspace_
Throws

if workspace is null.

Returns

The workspace the event belongs to.

isNull

isNull() returns boolean

Does this event record any change of state?

Inherited from
Blockly.Events.Abstract#isNull
Returns

True if null, false if something changed.

run

run(_forward)

Run an event.

Parameter

_forward

True if run forward, false if run backward (undo).

Inherited from
Blockly.Events.Abstract#run

toJson

toJson() returns Object

Encode the event as JSON.

Returns

non-null Object JSON representation.