CommentEditor

Описание и методы

Класс для редактирования комментариев в таймлайне.

BX.UI.Timeline.CommentEditor

Является наследником абстрактного редактора.

Сам объект не делает никаких ajax-запросов. Он только занимается отрисовкой и отправкой событий.

Метод	Описание	С версии
`constructor(params: {})`	Конструктор. Параметры: `params` - параметры редактора `id` - идентификатор редактора; `commentId` - идентификатор комментария, если редактор должен изменить существующий.
`getVisualEditorName(): string`	Метод вернет название для объекта визуального редактора.
`getTextarea(): ?HTMLTextAreaElement`	Метод вернет `textarea`, где хранится текст комментария, если редактор был отрисован.
`renderTextarea(): HTMLTextAreaElement`	Метод отрисует `textarea`.
`getVisualEditorContainer(): ?Element`	Метод вернет DOM-элемент с визуальным редактором, если он есть.
`renderVisualEditorContainer(): Element`	Метод отрисует DOM-элемент для визуального редактора и вернет его.
`getButtonsContainer(): ?Element`	Метод вернет DOM-элемент с кнопками, если он есть.
`renderButtons(): Element`	Метод отрисует DOM-элемент с кнопками и вернет его.
`showVisualEditor()`	Метод загрузит, если нужно, визуальный редактор через аякс и покажет его.
`loadVisualEditor(): Promise`	Метод вернет `Promise`, который будет разрешен после окончания загрузки редактора.
`showEditorLoader()`	Показывает лоадер загрузки визуального редактора.
`hideEditorLoader()`	Скрывает лоадер загрузки визуального редактора.
`hideVisualEditor()`	Скрывает визуальный редактор.
`save()`	Метод сохранит данные из редактора. Вызывается при клике на кнопку сохранения.
`cancel()`	Метод сбрасывает состояние редактора до исходного. Вызывается при клике на кнопку отмены.
`getEmptyMessageNotification(): Popup`	Возвращает попап о пустом значении.
`refresh()`	Метод сбросит состояние редактора в исходное состояние.
`getAttachments(): Array`	Метод вернет массив с идентификаторами прикрепленных файлов.

События

Событие	Описание
namespace: `BX.UI.Timeline.CommentEditor`
`error`	Событие бросается при возникновении ошибки, в `message` будет находиться текст. `message` - сообщение об ошибке.
`onLoadVisualEditor`	Это асинхронное событие. Бросается при необходимости отображения визуального редактора. После разрешения `Promise` в `data` события по ключу `html` должен находиться html-код визуального редактора. `name` - имя визуального редактора; `commentId` - идентификатор комментария.
`beforeSave`	Это событие бросается перед сохранением комментария. Если присвоить `isCancel` значение `true`, то сохранение будет отменено. `description` - текст; `isCancel` - флаг отмены; `files` - идентификаторы файлов.
`onSave`	Это асинхронное событие. Бросается на сохранении комментария. После разрешения `Promise` в `data` события по ключу `comment` должны быть данные для создания элемента Comment. `description` - текст; `files` - идентификаторы файлов; `commentId` - идентификатор комментария.
`afterSave`	Событие бросается после сохранения комментария. `comment` - данные для создания элемента Comment.
`cancel`	Событие бросается при клике на кнопку Отмена.

Пользовательские комментарии

Мы будем рады, если разработчики добавят свои комментарии по практическому использованию методов системы.

Для этого нужно всего лишь авторизоваться на сайте

Но помните, что Пользовательские комментарии, несмотря на модерацию, не являются официальной документацией. Ответственность за их использование несет сам пользователь.

Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.

Наверх