Versions Compared

Key

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

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

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


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

Переменная

Описание

currentUiAction

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

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

Image Removed Image Added

Пример:

Code Block
titlecurrentUiActionlinenumberstrue
window.currentUiAction

s_list.addErrorMessage(message)


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

Параметры:

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

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

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

Пример:

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

s_list.addInfoMessage(message, durationMilliseconds)


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

Параметры:

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

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

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

Пример:

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

s_list.addSuccessMessage(message, durationMilliseconds)


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

Параметры:

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

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

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

Пример:

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

s_list.addWarningMessage(message, durationMilliseconds)


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

Параметры:

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

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

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

Пример:

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

s_list.deleteRows(tableName, sysIds)


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

Параметры:

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

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

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

Пример:

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();
  }
});

s_list.getCheckedRow(tableName)


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

Параметр:

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

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

ТипОписание
Array of StringsМетод возвращает массив, содержащий 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);
  });
}

s_list.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');
})();

s_list.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');
})();

s_list.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