BlockSuite API Documentation / @blocksuite/affine-block-root / TemplateTool

Class: TemplateTool

Defined in: packages/affine/blocks/block-root/src/edgeless/gfx-tool/template-tool.ts:3

Extends

• BaseTool

Constructors

new TemplateTool()

new TemplateTool(gfx): TemplateTool

Defined in: packages/framework/block-std/dist/gfx/tool/tool.d.ts:23

Parameters

gfx

GfxController

Returns

TemplateTool

Inherited from

BaseTool.constructor

Properties

activatedOption

activatedOption: Record

Defined in: packages/framework/block-std/dist/gfx/tool/tool.d.ts:11

Inherited from

BaseTool.activatedOption

---

addHook()

addHook: <K>(evtName, handler) => void

Defined in: packages/framework/block-std/dist/gfx/tool/tool.d.ts:12

Add a hook before the event is handled by the tool. Return false to prevent the tool from handling the event.

Type Parameters

K

K extends "click" | "doubleClick" | "tripleClick" | "pointerDown" | "pointerMove" | "pointerUp" | "pointerOut" | "dragStart" | "dragMove" | "dragEnd" | "contextMenu" | keyof BuiltInEventMap

Parameters

evtName

K

handler

(evtState) => boolean | void

Returns

void

Inherited from

BaseTool.addHook

---

disposable

protected readonly disposable: DisposableGroup

Defined in: packages/framework/block-std/dist/gfx/tool/tool.d.ts:16

The disposable will be disposed when the tool is unloaded.

Inherited from

BaseTool.disposable

---

gfx

readonly gfx: GfxController

Defined in: packages/framework/block-std/dist/gfx/tool/tool.d.ts:8

Inherited from

BaseTool.gfx

---

toolName

static toolName: string = 'template'

Defined in: packages/affine/blocks/block-root/src/edgeless/gfx-tool/template-tool.ts:4

Overrides

BaseTool.toolName

Accessors

active

Get Signature

get active(): boolean

Defined in: packages/framework/block-std/dist/gfx/tool/tool.d.ts:17

Returns

boolean

Inherited from

BaseTool.active

---

allowDragWithRightButton

Get Signature

get allowDragWithRightButton(): boolean

Defined in: packages/framework/block-std/dist/gfx/tool/tool.d.ts:18

Returns

boolean

Inherited from

BaseTool.allowDragWithRightButton

---

controller

Get Signature

get controller(): ToolController

Defined in: packages/framework/block-std/dist/gfx/tool/tool.d.ts:19

Returns

ToolController

Inherited from

BaseTool.controller

---

doc

Get Signature

get doc(): Store

Defined in: packages/framework/block-std/dist/gfx/tool/tool.d.ts:20

Returns

Store

Inherited from

BaseTool.doc

---

std

Get Signature

get std(): BlockStdScope

Defined in: packages/framework/block-std/dist/gfx/tool/tool.d.ts:21

Returns

BlockStdScope

Inherited from

BaseTool.std

---

toolName

Get Signature

get toolName(): string

Defined in: packages/framework/block-std/dist/gfx/tool/tool.d.ts:22

Returns

string

Inherited from

BaseTool.toolName

Methods

activate()

activate(_): void

Defined in: packages/framework/block-std/dist/gfx/tool/tool.d.ts:29

Called when the tool is activated.

Parameters

_

Record

The data passed as second argument when calling ToolController.use.

Returns

void

Inherited from

BaseTool.activate

---

click()

click(_): void

Defined in: packages/framework/block-std/dist/gfx/tool/tool.d.ts:30

Parameters

_

PointerEventState

Returns

void

Inherited from

BaseTool.click

---

contextMenu()

contextMenu(_): void

Defined in: packages/framework/block-std/dist/gfx/tool/tool.d.ts:31

Parameters

_

PointerEventState

Returns

void

Inherited from

BaseTool.contextMenu

---

deactivate()

deactivate(): void

Defined in: packages/framework/block-std/dist/gfx/tool/tool.d.ts:35

Called when the tool is deactivated.

Returns

void

Inherited from

BaseTool.deactivate

---

doubleClick()

doubleClick(_): void

Defined in: packages/framework/block-std/dist/gfx/tool/tool.d.ts:36

Parameters

_

PointerEventState

Returns

void

Inherited from

BaseTool.doubleClick

---

dragEnd()

dragEnd(_): void

Defined in: packages/framework/block-std/dist/gfx/tool/tool.d.ts:37

Parameters

_

PointerEventState

Returns

void

Inherited from

BaseTool.dragEnd

---

dragMove()

dragMove(_): void

Defined in: packages/framework/block-std/dist/gfx/tool/tool.d.ts:38

Parameters

_

PointerEventState

Returns

void

Inherited from

BaseTool.dragMove

---

dragStart()

dragStart(_): void

Defined in: packages/framework/block-std/dist/gfx/tool/tool.d.ts:39

Parameters

_

PointerEventState

Returns

void

Inherited from

BaseTool.dragStart

---

mounted()

mounted(): void

Defined in: packages/framework/block-std/dist/gfx/tool/tool.d.ts:43

Called when the tool is registered.

Returns

void

Inherited from

BaseTool.mounted

---

pointerDown()

pointerDown(_): void

Defined in: packages/framework/block-std/dist/gfx/tool/tool.d.ts:44

Parameters

_

PointerEventState

Returns

void

Inherited from

BaseTool.pointerDown

---

pointerMove()

pointerMove(_): void

Defined in: packages/framework/block-std/dist/gfx/tool/tool.d.ts:45

Parameters

_

PointerEventState

Returns

void

Inherited from

BaseTool.pointerMove

---

pointerOut()

pointerOut(_): void

Defined in: packages/framework/block-std/dist/gfx/tool/tool.d.ts:46

Parameters

_

PointerEventState

Returns

void

Inherited from

BaseTool.pointerOut

---

pointerUp()

pointerUp(_): void

Defined in: packages/framework/block-std/dist/gfx/tool/tool.d.ts:47

Parameters

_

PointerEventState

Returns

void

Inherited from

BaseTool.pointerUp

---

tripleClick()

tripleClick(_): void

Defined in: packages/framework/block-std/dist/gfx/tool/tool.d.ts:48

Parameters

_

PointerEventState

Returns

void

Inherited from

BaseTool.tripleClick

---

unmounted()

unmounted(): void

Defined in: packages/framework/block-std/dist/gfx/tool/tool.d.ts:52

Called when the tool is unloaded, usually when the whole ToolController is destroyed.

Returns

void

Inherited from

BaseTool.unmounted

---

setup()

static setup(di): void

Defined in: packages/framework/block-std/dist/gfx/tool/tool.d.ts:24

Parameters

di

Container

Returns

void

Inherited from

BaseTool.setup