TextEditingTool

Defined in: tool/TextEditingTool.ts:12

Tool for editing text in place (GoJS-compatible). Double-clicking a node with an editable TextBlock in its visual tree shows an HTML input overlay for editing that TextBlock’s text.

Extends

• Tool

Constructors

Constructor

new TextEditingTool(): TextEditingTool

Returns

TextEditingTool

Inherited from

Tool.constructor

Accessors

diagram

Get Signature

get diagram(): Diagram | null

Defined in: tool/Tool.ts:13

Get the diagram this tool belongs to.

Returns

Diagram | null

Set Signature

set diagram(value): void

Defined in: tool/Tool.ts:18

Set the diagram this tool belongs to.

Parameters

value

Diagram | null

Returns

void

Inherited from

ZoomingTool.diagram

---

editingNode

Get Signature

get editingNode(): Node | null

Defined in: tool/TextEditingTool.ts:24

Get the node currently being edited.

Returns

Node | null

---

editingTextBlock

Get Signature

get editingTextBlock(): TextBlock | null

Defined in: tool/TextEditingTool.ts:29

Get the TextBlock currently being edited, or null.

Returns

TextBlock | null

---

isActive

Get Signature

get isActive(): boolean

Defined in: tool/Tool.ts:23

Check if this tool is currently active.

Returns

boolean

Inherited from

Tool.isActive

---

isEditing

Get Signature

get isEditing(): boolean

Defined in: tool/TextEditingTool.ts:19

Whether text editing is currently active.

Returns

boolean

---

isEnabled

Get Signature

get isEnabled(): boolean

Defined in: tool/Tool.ts:28

Check if this tool is enabled.

Returns

boolean

Set Signature

set isEnabled(value): void

Defined in: tool/Tool.ts:33

Enable or disable this tool.

Parameters

value

boolean

Returns

void

Inherited from

ZoomingTool.isEnabled

---

textBlock

Get Signature

get textBlock(): TextBlock | null

Defined in: tool/TextEditingTool.ts:34

GoJS-compatible: The TextBlock currently being edited, or null.

Returns

TextBlock | null

Methods

cancelEditing()

cancelEditing(): void

Defined in: tool/TextEditingTool.ts:148

Cancel editing without committing.

Returns

void

---

canStart()

canStart(_toolName, _e): boolean

Defined in: tool/Tool.ts:105

GoJS-compatible: Determines whether this tool should start given the current event. Override in subclasses to return true when this tool should handle the event.

Parameters

_toolName

string

_e

MouseEvent

Returns

boolean

Inherited from

Tool.canStart

---

doActivate()

doActivate(): void

Defined in: tool/Tool.ts:38

Called when the tool becomes the active tool.

Returns

void

Inherited from

Tool.doActivate

---

doClick()

doClick(_e): void

Defined in: tool/Tool.ts:78

Called when a click event occurs.

Parameters

_e

MouseEvent

Returns

void

Inherited from

Tool.doClick

---

doDeactivate()

doDeactivate(): void

Defined in: tool/TextEditingTool.ts:231

Called when the tool is deactivated.

Returns

void

Overrides

Tool.doDeactivate

---

doDoubleClick()

doDoubleClick(e): void

Defined in: tool/TextEditingTool.ts:222

Begin editing the node under the cursor on double-click.

Parameters

e

MouseEvent

Returns

void

Overrides

Tool.doDoubleClick

---

doKeyDown()

doKeyDown(_e): void

Defined in: tool/Tool.ts:68

Called when a key down event occurs.

Parameters

_e

KeyboardEvent

Returns

void

Inherited from

Tool.doKeyDown

---

doKeyUp()

doKeyUp(_e): void

Defined in: tool/Tool.ts:73

Called when a key up event occurs.

Parameters

_e

KeyboardEvent

Returns

void

Inherited from

Tool.doKeyUp

---

doMouseDown()

doMouseDown(_e): void

Defined in: tool/Tool.ts:48

Called when a mouse down event occurs.

Parameters

_e

MouseEvent

Returns

void

Inherited from

Tool.doMouseDown

---

doMouseMove()

doMouseMove(_e): void

Defined in: tool/Tool.ts:53

Called when a mouse move event occurs.

Parameters

_e

MouseEvent

Returns

void

Inherited from

Tool.doMouseMove

---

doMouseUp()

doMouseUp(_e): void

Defined in: tool/Tool.ts:58

Called when a mouse up event occurs.

Parameters

_e

MouseEvent

Returns

void

Inherited from

Tool.doMouseUp

---

doMouseWheel()

doMouseWheel(_e): void

Defined in: tool/Tool.ts:63

Called when a mouse wheel event occurs.

Parameters

_e

WheelEvent

Returns

void

Inherited from

Tool.doMouseWheel

---

doStart()

doStart(_e): void

Defined in: tool/Tool.ts:90

GoJS-compatible: Called when a tool operation starts (after canStart returns true).

Parameters

_e

MouseEvent

Returns

void

Inherited from

Tool.doStart

---

doStop()

doStop(): void

Defined in: tool/Tool.ts:97

GoJS-compatible: Called when a tool operation stops.

Returns

void

Inherited from

Tool.doStop

---

editNode()

editNode(node): void

Defined in: tool/TextEditingTool.ts:59

Start editing the text of a node (its editable TextBlock or its label).

Parameters

node

Node

Returns

void

---

findEditableTextBlock()

findEditableTextBlock(node): TextBlock | null

Defined in: tool/TextEditingTool.ts:39

Find the first editable TextBlock in a node’s visual tree.

Parameters

node

Node

Returns

TextBlock | null

---

findPartAt()

findPartAt(x, y): Part | null

Defined in: tool/Tool.ts:110

Find a part at the given diagram coordinates.

Parameters

x

number

y

number

Returns

Part | null

Inherited from

Tool.findPartAt

---

getDiagramPoint()

getDiagramPoint(e): object

Defined in: tool/Tool.ts:116

Get the mouse position in diagram coordinates.

Parameters

e

MouseEvent

Returns

object

x

x: number

y

y: number

Inherited from

Tool.getDiagramPoint

---

stopEditing()

stopEditing(commit?): void

Defined in: tool/TextEditingTool.ts:80

Stop editing and commit the current value.

Parameters

commit?

boolean = true

Returns

void