Class Gesture

Fake class which should be extended to avoid inheriting static properties

Hierarchy (View Summary)

Gesture__Class
- Gesture

Index

Constructors

Methods

bindMouseEvents cancel dispose doStart getCurrentDragger getInsertionMarkers handleBlockStart handleBubbleStart handleFlyoutStart handleMove handleRightClick handleUp handleWsStart hasStarted isDragging setStartBlock setStartBubble setStartField

Constructors

constructor

new Gesture(e: Event, creatorWorkspace: WorkspaceSvg): Blockly.Gesture
Class for one gesture.
Parameters
- e: Event
  The event that kicked off this gesture.
- creatorWorkspace: WorkspaceSvg
  The workspace that created this gesture and has a reference to it.
Returns Blockly.Gesture
Inherited from Gesture__Class.constructor
- Defined in node_modules/.pnpm/blockly@6.20210701.0/node_modules/blockly/blockly.d.ts:7062

Methods

bindMouseEvents

bindMouseEvents(e: Event): void
Bind gesture events.
Parameters
- e: Event
  A mouse down or touch start event.
Returns void
Package
Inherited from Gesture__Class.bindMouseEvents
- Defined in node_modules/.pnpm/blockly@6.20210701.0/node_modules/blockly/blockly.d.ts:7115

cancel

cancel(): void
Cancel an in-progress gesture. If a workspace or block drag is in progress, end the drag at the most recent location.

Returns void
Package
Inherited from Gesture__Class.cancel
- Defined in node_modules/.pnpm/blockly@6.20210701.0/node_modules/blockly/blockly.d.ts:7136

dispose

dispose(): void
Sever all links from this object.

Returns void
Package
Inherited from Gesture__Class.dispose
- Defined in node_modules/.pnpm/blockly@6.20210701.0/node_modules/blockly/blockly.d.ts:7100

doStart

doStart(e: Event): void
Start a gesture: update the workspace to indicate that a gesture is in progress and bind mousemove and mouseup handlers.
Parameters
- e: Event
  A mouse down or touch start event.
Returns void
Package
Inherited from Gesture__Class.doStart
- Defined in node_modules/.pnpm/blockly@6.20210701.0/node_modules/blockly/blockly.d.ts:7108

getCurrentDragger

getCurrentDragger(): any
Gets the current dragger if an item is being dragged. Null if nothing is being dragged.

Returns any
The dragger that is currently in use or null if no drag is in progress.
Inherited from Gesture__Class.getCurrentDragger
- Defined in node_modules/.pnpm/blockly@6.20210701.0/node_modules/blockly/blockly.d.ts:7232

getInsertionMarkers

getInsertionMarkers(): Blockly.BlockSvg[]
Get a list of the insertion markers that currently exist. Block drags have 0, 1, or 2 insertion markers.

Returns Blockly.BlockSvg[]
A possibly empty list of insertion marker blocks.

Package
Inherited from Gesture__Class.getInsertionMarkers
- Defined in node_modules/.pnpm/blockly@6.20210701.0/node_modules/blockly/blockly.d.ts:7224

handleBlockStart

handleBlockStart(e: Event, block: Blockly.BlockSvg): void
Handle a mousedown/touchstart event on a block.
Parameters
- e: Event
  A mouse down or touch start event.
- block: Blockly.BlockSvg
  The block the event hit.
Returns void
Package
Inherited from Gesture__Class.handleBlockStart
- Defined in node_modules/.pnpm/blockly@6.20210701.0/node_modules/blockly/blockly.d.ts:7167

handleBubbleStart

handleBubbleStart(e: Event, bubble: IBubble): void
Handle a mousedown/touchstart event on a bubble.
Parameters
- e: Event
  A mouse down or touch start event.
- bubble: IBubble
  The bubble the event hit.
Returns void
Package
Inherited from Gesture__Class.handleBubbleStart
- Defined in node_modules/.pnpm/blockly@6.20210701.0/node_modules/blockly/blockly.d.ts:7175

handleFlyoutStart

handleFlyoutStart(e: Event, flyout: IFlyout): void
Handle a mousedown/touchstart event on a flyout.
Parameters
- e: Event
  A mouse down or touch start event.
- flyout: IFlyout
  The flyout the event hit.
Returns void
Package
Inherited from Gesture__Class.handleFlyoutStart
- Defined in node_modules/.pnpm/blockly@6.20210701.0/node_modules/blockly/blockly.d.ts:7159

handleMove

handleMove(e: Event): void
Handle a mouse move or touch move event.
Parameters
- e: Event
  A mouse move or touch move event.
Returns void
Package
Inherited from Gesture__Class.handleMove
- Defined in node_modules/.pnpm/blockly@6.20210701.0/node_modules/blockly/blockly.d.ts:7122

handleRightClick

handleRightClick(e: Event): void
Handle a real or faked right-click event by showing a context menu.
Parameters
- e: Event
  A mouse move or touch move event.
Returns void
Package
Inherited from Gesture__Class.handleRightClick
- Defined in node_modules/.pnpm/blockly@6.20210701.0/node_modules/blockly/blockly.d.ts:7143

handleUp

handleUp(e: Event): void
Handle a mouse up or touch end event.
Parameters
- e: Event
  A mouse up or touch end event.
Returns void
Package
Inherited from Gesture__Class.handleUp
- Defined in node_modules/.pnpm/blockly@6.20210701.0/node_modules/blockly/blockly.d.ts:7129

handleWsStart

handleWsStart(e: Event, ws: WorkspaceSvg): void
Handle a mousedown/touchstart event on a workspace.
Parameters
- e: Event
  A mouse down or touch start event.
- ws: WorkspaceSvg
  The workspace the event hit.
Returns void
Package
Inherited from Gesture__Class.handleWsStart
- Defined in node_modules/.pnpm/blockly@6.20210701.0/node_modules/blockly/blockly.d.ts:7151

hasStarted

hasStarted(): boolean
Whether this gesture has already been started. In theory every mouse down has a corresponding mouse up, but in reality it is possible to lose a mouse up, leaving an in-process gesture hanging.

Returns boolean
Whether this gesture was a click on a workspace.

Package
Inherited from Gesture__Class.hasStarted
- Defined in node_modules/.pnpm/blockly@6.20210701.0/node_modules/blockly/blockly.d.ts:7215

isDragging

isDragging(): boolean
Whether this gesture is a drag of either a workspace or block. This function is called externally to block actions that cannot be taken mid-drag (e.g. using the keyboard to delete the selected blocks).

Returns boolean
True if this gesture is a drag of a workspace or block.

Package
Inherited from Gesture__Class.isDragging
- Defined in node_modules/.pnpm/blockly@6.20210701.0/node_modules/blockly/blockly.d.ts:7206

setStartBlock

setStartBlock(block: Blockly.BlockSvg): void
Record the block that a gesture started on, and set the target block appropriately.
Parameters
- block: Blockly.BlockSvg
  The block the gesture started on.
Returns void
Package
Inherited from Gesture__Class.setStartBlock
- Defined in node_modules/.pnpm/blockly@6.20210701.0/node_modules/blockly/blockly.d.ts:7197

setStartBubble

setStartBubble(bubble: IBubble): void
Record the bubble that a gesture started on
Parameters
- bubble: IBubble
  The bubble the gesture started on.
Returns void
Package
Inherited from Gesture__Class.setStartBubble
- Defined in node_modules/.pnpm/blockly@6.20210701.0/node_modules/blockly/blockly.d.ts:7189

setStartField

setStartField(field: Blockly.Field): void
Record the field that a gesture started on.
Parameters
- field: Blockly.Field
  The field the gesture started on.
Returns void
Package
Inherited from Gesture__Class.setStartField
- Defined in node_modules/.pnpm/blockly@6.20210701.0/node_modules/blockly/blockly.d.ts:7182