Class: TrashcanOpen

Defined in: packages/blockly/core/events/events_trashcan_open.ts:23

Notifies listeners when the trashcan is opening or closing.

Extends

• UiBase

Properties index

Property	Description
group	An ID for the group of events this block is associated with.
isOpen	True if the trashcan is currently opening (previously closed). False if it is currently closing (previously open).
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
isNull	Does this event record any change of state?
run	Run an event.
getEventWorkspace_	Get workspace the event belongs to.
toJson	Encode the event as JSON.

Constructors

Constructor

new TrashcanOpen(opt_isOpen?, opt_workspaceId?): TrashcanOpen;

Defined in: packages/blockly/core/events/events_trashcan_open.ts:37

Parameters

Parameter	Type	Description
opt_isOpen?	boolean	Whether the trashcan flyout is opening (false if opening). Undefined for a blank event.
opt_workspaceId?	string	The workspace identifier for this event. Undefined for a blank event.

Returns

TrashcanOpen

Overrides

UiBase.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

UiBase.group

---

isOpen?

optional isOpen?: boolean;

Defined in: packages/blockly/core/events/events_trashcan_open.ts:28

True if the trashcan is currently opening (previously closed). False if it is currently closing (previously open).

---

type

type: EventType = EventType.TRASHCAN_OPEN;

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

Type of this event.

Overrides

UiBase.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).

Inherited from

UiBase.isBlank

---

workspaceId

workspaceId: string;

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

The workspace identifier for this event.

Inherited from

UiBase.workspaceId

---

recordUndo

recordUndo: boolean = false;

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

Whether this event is undoable or not.

Inherited from

UiBase.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.

Inherited from

UiBase.isUiEvent

Methods

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

UiBase.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

UiBase.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

UiBase.getEventWorkspace_

---

toJson()

toJson(): TrashcanOpenJson;

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

Encode the event as JSON.

Returns

TrashcanOpenJson

JSON representation.

Overrides

UiBase.toJson