Class: Click

Constructor

Click

new Click(opt_block, opt_workspaceId, opt_targetType)

Class for a click event.

Parameter
opt_block	Optional Blockly.Block The affected block. Null for click events that do not have an associated block (i.e. workspace click). Undefined for a blank event. Value may be null.
opt_workspaceId	Optional string The workspace identifier for this event. Not used if block is passed. Undefined for a blank event. Value may be null.
opt_targetType	Optional string The type of element targeted by this click event. Undefined for a blank event.

Parameter

opt_block

Optional

The affected block. Null for click events that do not have an associated block (i.e. workspace click). Undefined for a blank event.

Value may be null.

opt_workspaceId

Optional

string

The workspace identifier for this event. Not used if block is passed. Undefined for a blank event.

Value may be null.

opt_targetType

Optional

string

The type of element targeted by this click event. Undefined for a blank event.

Extends: Blockly.Events.UiBase

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

isBlank

unknown

Whether or not the event is blank (to be populated by fromJson).

Inherited from: Blockly.Events.UiBase#isBlank

isUiEvent

unknown

Whether or not the event is a UI event.

Inherited from: Blockly.Events.UiBase#isUiEvent

recordUndo

unknown

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

Inherited from: Blockly.Events.Abstract#recordUndo

targetType

(string or undefined)

The type of element targeted by this click event.

type

string

Type of this event.

workspaceId

unknown

The workspace identifier for this event.

Inherited from: Blockly.Events.UiBase#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.