CommentEditor

Description

Comment editor for the Comments plugin.

Description

Initializes the comment editor, builds its DOM structure, and attaches the resize observer.

Members

CLASS_CELL

Ask AI

Source code

CommentEditor.CLASS_CELL

Returns the CSS class name applied to cells that have comments attached.

CLASS_EDITOR

Ask AI

Source code

CommentEditor.CLASS_EDITOR

Returns the CSS class name applied to the comment editor element.

CLASS_EDITOR_CONTAINER

Ask AI

Source code

CommentEditor.CLASS_EDITOR_CONTAINER

Returns the CSS class name applied to the outer comments container element.

CLASS_INPUT

Ask AI

Source code

CommentEditor.CLASS_INPUT

Returns the CSS class name applied to the comment textarea input element.

Methods

createEditor

Ask AI

Source code

commentEditor.createEditor() ⇒ HTMLElement

Create the textarea to be used as a comments editor.

destroy

Ask AI

Source code

commentEditor.destroy()

Destroy the comments editor.

focus

Ask AI

Source code

commentEditor.focus()

Focus the comments input element.

getEditorElement

Ask AI

Source code

commentEditor.getEditorElement() ⇒ HTMLElement

Get the editor element.

Returns: HTMLElement - The editor element.

getInputElement

Ask AI

Source code

commentEditor.getInputElement() ⇒ HTMLTextAreaElement | null

Get the input element.

getSize

Ask AI

Source code

commentEditor.getSize() ⇒ Object

Returns the size of the comments editor.

getValue

Ask AI

Source code

commentEditor.getValue() ⇒ string

Get the comment value.

hide

Ask AI

Source code

commentEditor.hide()

Hide the comments editor.

isFocused

Ask AI

Source code

commentEditor.isFocused() ⇒ boolean

Checks if the comment input element is focused.

isVisible

Ask AI

Source code

commentEditor.isVisible() ⇒ boolean

Checks if the editor is visible.

observeSize

Ask AI

Source code

commentEditor.observeSize()

Starts observing the editor size.

resetSize

Ask AI

Source code

commentEditor.resetSize()

Reset the editor size to its initial state.

setPosition

Ask AI

Source code

commentEditor.setPosition(x, y)

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

Param	Type	Description
x	number	X position (in pixels).
y	number	Y position (in pixels).

setReadOnlyState

Ask AI

Source code

commentEditor.setReadOnlyState(state)

Set the read-only state for the comments editor.

Param	Type	Description
state	boolean	The new read only state.

setSize

Ask AI

Source code

commentEditor.setSize(width, height)

Set the editor size according to the provided arguments.

Param	Type	Description
width	number	Width in pixels.
height	number	Height in pixels.

setValue

Ask AI

Source code

commentEditor.setValue([value])

Set the comment value.

Param	Type	Description
[value]	string	optional The value to use.

show

Ask AI

Source code

commentEditor.show()

Show the comments editor.