Class SelectionTool

Allows users to select/transform portions of the EditorImage. With respect to extending, SelectionTool is not stable.

Hierarchy (View Summary)

BaseTool
- SelectionTool

Constructors

constructor

new SelectionTool(editor: Editor, description: string): SelectionTool
Parameters
- editor: Editor
- description: string
Returns SelectionTool
Overrides BaseTool.constructor
- Defined in js-draw/src/tools/SelectionTool/SelectionTool.ts:73

Properties

`Readonly`description

description: string

`Readonly`modeValue

modeValue: MutableReactiveValue<SelectionMode>

Methods

canReceiveInputInReadOnlyEditor

canReceiveInputInReadOnlyEditor(): boolean
Override this to allow this tool to be enabled in a read-only editor

Returns boolean
Inherited from BaseTool.canReceiveInputInReadOnlyEditor
- Defined in js-draw/src/tools/BaseTool.ts:53

clearSelection

clearSelection(): void
Returns void
- Defined in js-draw/src/tools/SelectionTool/SelectionTool.ts:679

enabledValue

enabledValue(): ReactiveValue<boolean>
Returns a ReactiveValue that updates based on whether this tool is enabled.

Returns ReactiveValue<boolean>
Example
```
const tool = new SomeTool();

// Watch for changes in enabled status
tool.enabledValue().onUpdate(enabled => doSomething(enabled));
```
Inherited from BaseTool.enabledValue
- Defined in js-draw/src/tools/BaseTool.ts:180

getInputMapper

getInputMapper(): null | InputMapper
Returns null | InputMapper
Inherited from BaseTool.getInputMapper
- Defined in js-draw/src/tools/BaseTool.ts:64

getSelectedObjects

getSelectedObjects(): AbstractComponent[]
Returns AbstractComponent[]
- Defined in js-draw/src/tools/SelectionTool/SelectionTool.ts:635

getToolGroup

getToolGroup(): null | ToolEnabledGroup
Returns null | ToolEnabledGroup
Inherited from BaseTool.getToolGroup
- Defined in js-draw/src/tools/BaseTool.ts:194

isEnabled

isEnabled(): boolean
Returns boolean
Inherited from BaseTool.isEnabled
- Defined in js-draw/src/tools/BaseTool.ts:164

isSelecting

isSelecting(): boolean
Returns boolean
true if the selection is currently being created by the user.
- Defined in js-draw/src/tools/SelectionTool/SelectionTool.ts:631

onContextMenu

onContextMenu(event: ContextMenuEvt): boolean
Parameters
- event: ContextMenuEvt
Returns boolean
Overrides BaseTool.onContextMenu
- Defined in js-draw/src/tools/SelectionTool/SelectionTool.ts:153

onCopy

onCopy(event: CopyEvent): boolean
Parameters
- event: CopyEvent
Returns boolean
Overrides BaseTool.onCopy
- Defined in js-draw/src/tools/SelectionTool/SelectionTool.ts:526

onDestroy

onDestroy(): void
Called when the tool is removed/when the editor is destroyed. Subclasses that override this method must call super.onDestroy().

Returns void
Inherited from BaseTool.onDestroy
- Defined in js-draw/src/tools/BaseTool.ts:204

onGestureCancel

onGestureCancel(): void
Returns void
Overrides BaseTool.onGestureCancel
- Defined in js-draw/src/tools/SelectionTool/SelectionTool.ts:274

onKeyPress

onKeyPress(event: KeyPressEvent): boolean
Parameters
- event: KeyPressEvent
Returns boolean
Overrides BaseTool.onKeyPress
- Defined in js-draw/src/tools/SelectionTool/SelectionTool.ts:349

onKeyUp

onKeyUp(evt: KeyUpEvent): boolean
Parameters
- evt: KeyUpEvent
Returns boolean
Overrides BaseTool.onKeyUp
- Defined in js-draw/src/tools/SelectionTool/SelectionTool.ts:471

onPaste

onPaste(_event: PasteEvent): boolean
Parameters
- _event: PasteEvent
Returns boolean
Inherited from BaseTool.onPaste
- Defined in js-draw/src/tools/BaseTool.ts:135

onPointerDown

onPointerDown(__namedParameters: PointerEvt): boolean
Returns true iff the tool handled the event and thus should receive additional events.
Parameters
- __namedParameters: PointerEvt
Returns boolean
Overrides BaseTool.onPointerDown
- Defined in js-draw/src/tools/SelectionTool/SelectionTool.ts:162

onPointerMove

onPointerMove(event: PointerEvt): void
Parameters
- event: PointerEvt
Returns void
Overrides BaseTool.onPointerMove
- Defined in js-draw/src/tools/SelectionTool/SelectionTool.ts:212

onPointerUp

onPointerUp(event: PointerEvt): void
Returns true iff there are additional pointers down and the tool should remain active to handle the additional events.

For most purposes, this should return false or nothing.
Parameters
- event: PointerEvt
Returns void
Overrides BaseTool.onPointerUp
- Defined in js-draw/src/tools/SelectionTool/SelectionTool.ts:250

onWheel

onWheel(_event: WheelEvt): boolean
Parameters
- _event: WheelEvt
Returns boolean
Inherited from BaseTool.onWheel
- Defined in js-draw/src/tools/BaseTool.ts:127

setEnabled

setEnabled(enabled: boolean): void
Parameters
- enabled: boolean
Returns void
Overrides BaseTool.setEnabled
- Defined in js-draw/src/tools/SelectionTool/SelectionTool.ts:595

setInputMapper

setInputMapper(mapper: null | InputMapper): void
Parameters
- mapper: null | InputMapper
Returns void
Inherited from BaseTool.setInputMapper
- Defined in js-draw/src/tools/BaseTool.ts:57

setSelection

setSelection(objects: AbstractComponent[]): void
Select the given objects. Any non-selectable objects in objects are ignored.
Parameters
- objects: AbstractComponent[]
Returns void
- Defined in js-draw/src/tools/SelectionTool/SelectionTool.ts:640

setToolGroup

setToolGroup(group: ToolEnabledGroup): void
Connect this tool to a set of other tools, ensuring that at most one of the tools in the group is enabled.
Parameters
- group: ToolEnabledGroup
Returns void
Inherited from BaseTool.setToolGroup
- Defined in js-draw/src/tools/BaseTool.ts:186

OpenSource licenses