Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Методы данного класса предназначены для конфигурации списков. Например, Используйте их для управления действиями UI. списками, например, из скриптов UI-действий.

Использование глобальной переменной


Внутри каждого списка можно использовать преднастроенную глобальную переменную.

Переменная

Описание

currentUiAction

Содержит объект с ID записи UI action. Используйте данную переменную ее при вызове контекстного меню кнопки.

Одним из примеров ее использования является получение информации о действиях UI при -действии при вызове контекстного меню.

Пример:

Code Block
titlecurrentUiAction
linenumberstrue
window.currentUiAction


s_list.addErrorMessage(message)


Используйте данный метод для вывода сообщений об ошибке в правом нижнем углу окна.


Параметры:

NameНазваниеTypeТипMandatoryОбязательныйЗначение по умолчанию
messageStringYДаNНет


Возвращаемое значение:

TypeТипDescriptionОписание
VoidДанный метод не возвращает значение.


Пример:

Code Block
languagejs
themeEclipse
titleaddErrorMessage()
linenumberstrue
s_list.addErrorMessage('PleaseВведите enterадрес aэлектронной validпочты email address using the following formatв формате: joe@example.com');


s_list.addInfoMessage(message, durationMilliseconds)


Используйте данный метод для отображения информационных сообщений при работе со списками. Сообщения появляются в нижнем правом углу и исчезают через некоторое время. Настройте это время во втором парамере в миллисекундах.


Параметры:

НазваниеТипОбязательныйЗначение по умолчанию
messageStringДДаННет
durationMillisecondsNumberННетННет


Возвращаемое значение:

ТипОписание
VoidДанный метод не возвращает значение.

Пример:

Code Block
languagejs
themeEclipse
titleaddInfoMessage()
linenumberstrue
s_list.addInfoMessage('LinkСсылка скопирована copiedв toбуфер clipboardобмена', 2000);


s_list.addSuccessMessage(message, durationMilliseconds)


Данный метод выводит сообщения об успешном действии при работе со списками. Сообщения появляются в нижнем правом углу и исчезают через некоторое время. Настройте это время во втором парамере в миллисекундах.


Параметры:

НазваниеТипОбязательныйЗначение по умолчанию
messageStringДДаННет
durationMillisecondsNumberННетННет


Возвращаемое значение:

ТипОписание
VoidДанный метод не возвращает значение.


Пример:

Code Block
languagejs
themeEclipse
titleaddSuccessMessage()
linenumberstrue
s_list.addSuccessMessage('RecordЗапись wasуспешно successfully updatedобновлена!', 3000);


s_list.addWarningMessage(message, durationMilliseconds)


Используйте этот метод для отображения предупреждающих сообщений при работе со списками. Сообщения появляются в нижнем правом углу и исчезают через некоторое время. Настройте это время во втором парамере в миллисекундах.


Параметры:

НазваниеТипОбязательныйЗначение по умолчанию
messageStringДДаННет
durationMillisecondsNumberННетННет


Возвращаемое значение:

ТипОписание
VoidДанный метод не возвращает значение.


Пример:

Code Block
languagejs
themeEclipse
titleaddWarningMessage()
linenumberstrue
s_list.addWarningMessage('ThisЭта recordзапись hasбыла beenизменена modified by another userдругим пользователем', 3000);


deleteRows(tableName, sysIds)


Данный метод предназначен для удаления одной и более выбранных строк таблицыили нескольких записей, ID которых переданы ему вторым параметром.


Параметры:

НазваниеТипОбязательныйЗначение по умолчанию
tableNameStringДДаННет
sysIdsArrayДДаННет


Возвращаемое значение:

ТипОписание
ObjectЭтот объект возвращает промис, содержащий определенные данные.


Пример:

Code Block
languagejs
themeEclipse
titledeleteRows()
linenumberstrue
s_i18n.getMessage("Delete the selected record(s)?", async (translationResponse) => {
  if (confirm(translationResponse)) {
    s_list.deleteRows(table, selectedRows)
      .then(() => {
        __resolveServerResponse();
        s_list.refresh(table);
      })
  } else {
    __resolveServerResponse();
  }
});


getCheckedRow(tableName)


Используйте этот метод для получения информации о строках, отмеченных в списке.


Параметр:

НазваниеТипОбязательныйЗначение по умолчанию
tableNameStringДДаННет


Возвращаемое значение:

ТипОписание
ArrayМетод возвращает массив, содержащий ID отмеченных строк. Метод возвращает пустой массив, если строки не были отмечены.


Пример:

Code Block
languagejs
themeEclipse
titlegetCheckedRow()
linenumberstrue
const table = s_list.getTablesName()[0];
const selectedRows = s_list.getCheckedRow(table);
if (!selectedRows.length) {
  s_i18n.getMessage("NoНет selectedвыбранных rowsстрок.", (translationResponse) => {
    __resolveServerResponse();
    alert(translationResponse);
  });
}


getQuery()


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


Возвращаемое значение:

ТипОписание
StringУсловие в формате закодированного запроса.


Пример:

Code Block
languagejs
themeEclipse
titlegetQuery()
linenumberstrue
; (() => {
  const url = new URL(`${API_BASE_URL}/list/${s_list.getTablesName()[0]}`);
  url.searchParams.set('condition', s_list.getQuery());
  window.open(url, '_blank');
})();


getTablesName()


Данный метод возвращает список таблицмассив с названиями таблиц, списки которых отображаются в окне.


Возвращаемое значение:

ТипОписание
Array of stringsСписок Массив с названиями таблиц


Пример:

Code Block
languagejs
themeEclipse
titlegetTablesName()
linenumberstrue
; (() => {
  const url = new URL(`${API_BASE_URL}/list/${s_list.getTablesName()[0]}`);
  url.searchParams.set('condition', s_list.getQuery());
  window.open(url, '_blank');
})();


refresh(tableName)


Используйте этот метод, чтобы обновить данные в списке, заданном в параметре tableName.


Параметры:

НазваниеТипОбязательныйЗначение по умолчанию
tableNameStringДДаННет


Возвращаемое значение:

ТипОписание
VoidДанный метод не возвращает значение.


Пример:

Code Block
languagejs
themeEclipse
titlerefresh()
linenumberstrue
if (confirm(translationResponse)) {
  s_list.deleteRows(table, selectedRows)
    .then(() => {
      s_list.refresh(table);
    })
}


Table of Contents
absoluteUrltrue
classfixedPosition