Class: CommentEditor

CommentEditor

handsontable/src/plugins/comments/commentEditor.js, line 3

Comment editor for the Comments plugin.

Methods

handsontable/src/plugins/comments/commentEditor.js, line 147

createEditor(){HTMLElement}

Create the textarea to be used as a comments editor.

Returns: {HTMLElement}
handsontable/src/plugins/comments/commentEditor.js, line 181

destroy()

Destroy the comments editor.

handsontable/src/plugins/comments/commentEditor.js, line 138

focus()

Focus the comments input element.

handsontable/src/plugins/comments/commentEditor.js, line 174

getInputElement(){HTMLElement}

Get the input element.

Returns: {HTMLElement}
handsontable/src/plugins/comments/commentEditor.js, line 122

getValue(){String}

Get the comment value.

Returns: {String}
handsontable/src/plugins/comments/commentEditor.js, line 93

hide()

Hide the comments editor.

handsontable/src/plugins/comments/commentEditor.js, line 131

isFocused(){Boolean}

Checks if the comment input element is focused.

Returns: {Boolean}
handsontable/src/plugins/comments/commentEditor.js, line 103

isVisible(){Boolean}

Checks if the editor is visible.

Returns: {Boolean}
handsontable/src/plugins/comments/commentEditor.js, line 64

resetSize()

Reset the editor size to its initial state.

handsontable/src/plugins/comments/commentEditor.js, line 41

setPosition(x, y)

Set position of the comments editor according to the provided x and y coordinates.

Parameters:
Name Type Description
x Number

X position (in pixels).

y Number

Y position (in pixels).

handsontable/src/plugins/comments/commentEditor.js, line 76

setReadOnlyState(state)

Set the read-only state for the comments editor.

Parameters:
Name Type Description
state Boolean

The new read only state.

handsontable/src/plugins/comments/commentEditor.js, line 52

setSize(width, height)

Set the editor size according to the provided arguments.

Parameters:
Name Type Description
width Number

Width in pixels.

height Number

Height in pixels.

handsontable/src/plugins/comments/commentEditor.js, line 112

setValue(value)

Set the comment value.

Parameters:
Name Type Description
value String optional

The value to use.

handsontable/src/plugins/comments/commentEditor.js, line 85

show()

Show the comments editor.