Class TouchGesture

Fake class which should be extended to avoid inheriting static properties

Hierarchy (View Summary)

TouchGesture__Class
- TouchGesture

Constructors

constructor

new TouchGesture(e: Event, creatorWorkspace: WorkspaceSvg): Blockly.TouchGesture
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.TouchGesture
Inherited from TouchGesture__Class.constructor
- Defined in node_modules/.pnpm/blockly@6.20210701.0/node_modules/blockly/blockly.d.ts:10240

Methods

bindMouseEvents

bindMouseEvents(e: Event): void
Bind gesture events. Overriding the gesture definition of this function, binding the same functions for onMoveWrapper_ and onUpWrapper_ but passing opt_noCaptureIdentifier. In addition, binding a second mouse down event to detect multi-touch events.
Parameters
- e: Event
  A mouse down or touch start event.
Returns void
Package
Inherited from TouchGesture__Class.bindMouseEvents
- Defined in node_modules/.pnpm/blockly@6.20210701.0/node_modules/blockly/blockly.d.ts:10259

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 TouchGesture__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 TouchGesture__Class.dispose
- Defined in node_modules/.pnpm/blockly@6.20210701.0/node_modules/blockly/blockly.d.ts:10293

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, touch start or pointer down event.
Returns void
Package
Inherited from TouchGesture__Class.doStart
- Defined in node_modules/.pnpm/blockly@6.20210701.0/node_modules/blockly/blockly.d.ts:10248

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 TouchGesture__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 TouchGesture__Class.getInsertionMarkers
- Defined in node_modules/.pnpm/blockly@6.20210701.0/node_modules/blockly/blockly.d.ts:7224

getTouchPoint

getTouchPoint(e: Event): Blockly.utils.Coordinate
Helper function returning the current touch point coordinate.
Parameters
- e: Event
  A touch or pointer event.
Returns Blockly.utils.Coordinate
The current touch point coordinate

Package
Inherited from TouchGesture__Class.getTouchPoint
- Defined in node_modules/.pnpm/blockly@6.20210701.0/node_modules/blockly/blockly.d.ts:10324

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 TouchGesture__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 TouchGesture__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 TouchGesture__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, touch move, or pointer move event.
Parameters
- e: Event
  A mouse move, touch move, or pointer move event.
Returns void
Package
Inherited from TouchGesture__Class.handleMove
- Defined in node_modules/.pnpm/blockly@6.20210701.0/node_modules/blockly/blockly.d.ts:10273

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 TouchGesture__Class.handleRightClick
- Defined in node_modules/.pnpm/blockly@6.20210701.0/node_modules/blockly/blockly.d.ts:7143

handleStart

handleStart(e: Event): void
Handle a mouse down, touch start, or pointer down event.
Parameters
- e: Event
  A mouse down, touch start, or pointer down event.
Returns void
Package
Inherited from TouchGesture__Class.handleStart
- Defined in node_modules/.pnpm/blockly@6.20210701.0/node_modules/blockly/blockly.d.ts:10266

handleTouchEnd

handleTouchEnd(e: Event): void
Handle a touch end or pointer end event and end the gesture.
Parameters
- e: Event
  A touch end, or pointer end event.
Returns void
Package
Inherited from TouchGesture__Class.handleTouchEnd
- Defined in node_modules/.pnpm/blockly@6.20210701.0/node_modules/blockly/blockly.d.ts:10316

handleTouchMove

handleTouchMove(e: Event): void
Handle a touch move or pointer move event and zoom in/out if two pointers are on the screen.
Parameters
- e: Event
  A touch move, or pointer move event.
Returns void
Package
Inherited from TouchGesture__Class.handleTouchMove
- Defined in node_modules/.pnpm/blockly@6.20210701.0/node_modules/blockly/blockly.d.ts:10309

handleTouchStart

handleTouchStart(e: Event): void
Handle a touch start or pointer down event and keep track of current pointers.
Parameters
- e: Event
  A touch start, or pointer down event.
Returns void
Package
Inherited from TouchGesture__Class.handleTouchStart
- Defined in node_modules/.pnpm/blockly@6.20210701.0/node_modules/blockly/blockly.d.ts:10301

handleUp

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

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 TouchGesture__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 TouchGesture__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 TouchGesture__Class.isDragging
- Defined in node_modules/.pnpm/blockly@6.20210701.0/node_modules/blockly/blockly.d.ts:7206

isMultiTouch

isMultiTouch(): boolean
Whether this gesture is part of a multi-touch gesture.

Returns boolean
Whether this gesture is part of a multi-touch gesture.

Package
Inherited from TouchGesture__Class.isMultiTouch
- Defined in node_modules/.pnpm/blockly@6.20210701.0/node_modules/blockly/blockly.d.ts:10287

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 TouchGesture__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 TouchGesture__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 TouchGesture__Class.setStartField
- Defined in node_modules/.pnpm/blockly@6.20210701.0/node_modules/blockly/blockly.d.ts:7182

Class TouchGesture

Hierarchy (View Summary)

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Blockly.TouchGesture

Methods

bindMouseEvents

Parameters

Returns void

Package

cancel

Returns void

Package

dispose

Returns void

Package

doStart

Parameters

Returns void

Package

getCurrentDragger

Returns any

getInsertionMarkers

Returns Blockly.BlockSvg[]

Package

getTouchPoint

Parameters

Returns Blockly.utils.Coordinate

Package

handleBlockStart

Parameters

Returns void

Package

handleBubbleStart

Parameters

Returns void

Package

handleFlyoutStart

Parameters

Returns void

Package

handleMove

Parameters

Returns void

Package

handleRightClick

Parameters

Returns void

Package

handleStart

Parameters

Returns void

Package

handleTouchEnd

Parameters

Returns void

Package

handleTouchMove

Parameters

Returns void

Package

handleTouchStart

Parameters

Returns void

Package

handleUp

Parameters

Returns void

Package

handleWsStart

Parameters

Returns void

Package

hasStarted

Returns boolean

Package