Class TextTool

Text: click the insertion point, type, Enter to place.

Implements

Tool

Index

Constructors

Properties

cursor id label shortcut

Methods

activate cancel capturesKeyboard key pointerDown

Constructors

constructor

new TextTool(heightPx?: number): TextTool
Text height in CSS pixels at the current zoom when placed.
Parameters
- heightPx: number = 16
Returns TextTool
- Defined in packages/sdk/src/editor/tools/draw.ts:452

Properties

`Readonly`cursor

cursor: "text" = 'text'

`Readonly`id

id: "text" = 'text'

`Readonly`label

label: "tool.text" = 'tool.text'

i18n key or plain label.

`Readonly`shortcut

shortcut: "t" = 't'

Single-key shortcut (e.g. l).

Methods

activate

activate(ctx: ToolContext): void
Parameters
- ctx: ToolContext
Returns void
Implementation of Tool.activate
- Defined in packages/sdk/src/editor/tools/draw.ts:454

cancel

cancel(ctx: ToolContext): void
Abort the current operation and return to idle.
Parameters
- ctx: ToolContext
Returns void
Implementation of Tool.cancel
- Defined in packages/sdk/src/editor/tools/draw.ts:510

capturesKeyboard

capturesKeyboard(): boolean
While true, every key goes to key first (text entry); shortcuts are suspended.

Returns boolean
Implementation of Tool.capturesKeyboard
- Defined in packages/sdk/src/editor/tools/draw.ts:458

key

key(ctx: ToolContext, k: InputKey): Promise<boolean>
Keys not consumed by global shortcuts (Enter, Backspace, …). Return true if handled.
Parameters
- ctx: ToolContext
- k: InputKey
Returns Promise<boolean>
Implementation of Tool.key
- Defined in packages/sdk/src/editor/tools/draw.ts:487

pointerDown

pointerDown(ctx: ToolContext, p: ToolPointer): void
Parameters
- ctx: ToolContext
- p: ToolPointer
Returns void
Implementation of Tool.pointerDown
- Defined in packages/sdk/src/editor/tools/draw.ts:462