Class ColorTool`Abstract`

Hierarchy (View Summary, Expand)

Tool
- ColorTool
  - ForeColorTool
  - BackColorTool

Index

Constructors

Properties

colorName command? icon inputs? keys? name tags?

Accessors

active title usable

Methods

edit execute getActive getColor render

Constructors

constructor

new ColorTool(): ColorTool
Returns ColorTool
Inherited from Tool.constructor

Properties

`Abstract`colorName

colorName: ColorName

`Optional`command

command?: string

`Abstract`icon

icon: string

`Optional`inputs

inputs?: string[]

`Optional`keys

keys?: string[]

`Abstract`name

name: string

`Optional`tags

tags?: string[]

Accessors

active

get active(): boolean
Returns boolean
Overrides Tool.active
- Defined in source/tools/Color.ts:26

title

get title(): string
Returns string
Inherited from Tool.title
- Defined in source/Tool.ts:48

usable

get usable(): boolean
Returns boolean
Inherited from Tool.usable
- Defined in source/Tool.ts:18

Methods

`Protected`edit

edit(editor: HTMLElement, ...data: any[]): void
Parameters
- editor: HTMLElement
- ...data: any[]
Returns void
Inherited from Tool.edit
- Defined in source/Tool.ts:60

execute

execute(editor: HTMLElement, color: string): void
Parameters
- editor: HTMLElement
- color: string
Returns void
Overrides Tool.execute
- Defined in source/tools/Color.ts:30

`Protected`getActive

getActive(): boolean
Returns boolean
Inherited from Tool.getActive
- Defined in source/Tool.ts:28

getColor

getColor(): string
Returns string
- Defined in source/tools/Color.ts:8

`Abstract`render

render(editor: any): any
Render a Tool control
Parameters
- editor: any
  An HTMLElement object or its wrapper for [contenteditable="true"]
Returns any
Virtual DOM of UI engines
Inherited from Tool.render
- Defined in source/Tool.ts:86