BlockSuite API Documentation / @blocksuite/blocks / FrameTool

Class: FrameTool

Extends

• BaseTool

Constructors

new FrameTool()

new FrameTool(gfx): FrameTool

Parameters

• gfx: GfxController

Returns

FrameTool

Inherited from

BaseTool.constructor

Defined in

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

Properties

activatedOption

activatedOption: Record<string, unknown>

Inherited from

BaseTool.activatedOption

Defined in

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

---

addHook()

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

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

Type Parameters

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

Parameters

• evtName: K

• handler

Returns

void

Inherited from

BaseTool.addHook

Defined in

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

---

disposable

protected readonly disposable: DisposableGroup

The disposable will be disposed when the tool is unloaded.

Inherited from

BaseTool.disposable

Defined in

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

---

gfx

readonly gfx: GfxController

Inherited from

BaseTool.gfx

Defined in

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

---

toolName

static toolName: string = 'frame'

Overrides

BaseTool.toolName

Defined in

packages/blocks/src/root-block/edgeless/gfx-tool/frame-tool.ts:18

Accessors

active

get active(): boolean

Returns

boolean

Inherited from

BaseTool.active

Defined in

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

---

allowDragWithRightButton

get allowDragWithRightButton(): boolean

Returns

boolean

Inherited from

BaseTool.allowDragWithRightButton

Defined in

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

---

controller

get controller(): ToolController

Returns

ToolController

Inherited from

BaseTool.controller

Defined in

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

---

doc

get doc(): Doc

Returns

Doc

Inherited from

BaseTool.doc

Defined in

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

---

frameManager

get frameManager(): EdgelessFrameManager

Returns

EdgelessFrameManager

Defined in

packages/blocks/src/root-block/edgeless/gfx-tool/frame-tool.ts:24

---

frameOverlay

get frameOverlay(): FrameOverlay

Returns

FrameOverlay

Defined in

packages/blocks/src/root-block/edgeless/gfx-tool/frame-tool.ts:30

---

std

get std(): BlockStdScope

Returns

BlockStdScope

Inherited from

BaseTool.std

Defined in

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

---

toolName

get toolName(): string

Returns

string

Inherited from

BaseTool.toolName

Defined in

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

Methods

activate()

activate(_): void

Called when the tool is activated.

Parameters

• _: Record<string, unknown>

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

Returns

void

Inherited from

BaseTool.activate

Defined in

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

---

click()

click(_): void

Parameters

• _: PointerEventState

Returns

void

Inherited from

BaseTool.click

Defined in

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

---

contextMenu()

contextMenu(_): void

Parameters

• _: PointerEventState

Returns

void

Inherited from

BaseTool.contextMenu

Defined in

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

---

deactivate()

deactivate(): void

Called when the tool is deactivated.

Returns

void

Inherited from

BaseTool.deactivate

Defined in

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

---

doubleClick()

doubleClick(_): void

Parameters

• _: PointerEventState

Returns

void

Inherited from

BaseTool.doubleClick

Defined in

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

---

dragEnd()

dragEnd(): void

Returns

void

Overrides

BaseTool.dragEnd

Defined in

packages/blocks/src/root-block/edgeless/gfx-tool/frame-tool.ts:38

---

dragMove()

dragMove(e): void

Parameters

• e: PointerEventState

Returns

void

Overrides

BaseTool.dragMove

Defined in

packages/blocks/src/root-block/edgeless/gfx-tool/frame-tool.ts:63

---

dragStart()

dragStart(e): void

Parameters

• e: PointerEventState

Returns

void

Overrides

BaseTool.dragStart

Defined in

packages/blocks/src/root-block/edgeless/gfx-tool/frame-tool.ts:103

---

mounted()

mounted(): void

Called when the tool is registered.

Returns

void

Inherited from

BaseTool.mounted

Defined in

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

---

pointerDown()

pointerDown(_): void

Parameters

• _: PointerEventState

Returns

void

Inherited from

BaseTool.pointerDown

Defined in

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

---

pointerMove()

pointerMove(_): void

Parameters

• _: PointerEventState

Returns

void

Inherited from

BaseTool.pointerMove

Defined in

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

---

pointerOut()

pointerOut(_): void

Parameters

• _: PointerEventState

Returns

void

Inherited from

BaseTool.pointerOut

Defined in

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

---

pointerUp()

pointerUp(_): void

Parameters

• _: PointerEventState

Returns

void

Inherited from

BaseTool.pointerUp

Defined in

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

---

tripleClick()

tripleClick(_): void

Parameters

• _: PointerEventState

Returns

void

Inherited from

BaseTool.tripleClick

Defined in

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

---

unmounted()

unmounted(): void

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

Returns

void

Inherited from

BaseTool.unmounted

Defined in

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

---

setup()

static setup(di): void

Parameters

• di: Container

Returns

void

Inherited from

BaseTool.setup

Defined in

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