api.utils Форматирование данных
Для доступа к операциям используется утилитарный метод api.utils или его короткий псевдоним utils.
-
utils.formatters.escapeHtmlSymbols(text).asString()
Заменяет специальные символы (<, >, &) на их html-эквивалент, чтобы они отображались в строке, как обычные символы. Если text равен null, то возвращает пустой html
-
utils.formatters.format(obj)
Возвращает название объекта или его uuid, если у объекта нет атрибута "Название" (title).
Форматирование даты и времени
-
utils.formatters.formatDate(date)
Возвращает строку с датой в формате dd.MM.yyyy.
-
utils.formatters.formatDateTime(dateTime)
Возвращает строку с датой в формате dd.MM.yyyy HH:mm.
-
utils.formatters.strToDate(str, dateFormat)
Перевод строки заданного формата в дату.
Параметры метода:
- str — строка;
- dateFormat — формат даты.
-
utils.formatters.strToDateTime(str)
Перевод строки формата dd.MM.yyyy HH:mm в дату.
-
utils.formatters.strToDate(str)
Перевод строки формата dd.MM.yyyy в дату.
-
utils.formatters.formatDateTimeInterval(dateTimeInterval)
Возвращает строковое представление временного интервала.
-
utils.formatters.formatLongToTime(value, roundUp).asString()
Преобразование количества миллисекунд во время ЧЧ:ММ.
Параметры метода:
- value — значение в миллисекундах. Long
-
roundUp;
- true (миллисекунды округляются до минут в сторону большего значения);
- false (миллисекунды округляются до минут в сторону меньшего значения).
Возвращаемое значение: Время ЧЧ:ММ (количество часов может быть больше 0 любым целым значением).
-
utils.formatters.formatTimePeriod(ms)
Форматирование периода времени по шаблону "xx ч. yy д. zz мин.".
Параметр метода:
- ms — период времени. Long
Форматирование гиперссылки
-
utils.formatters.formatHyperlink(hyperlink)
Возвращает гиперссылку в виде текста.
-
utils.formatters.formatHyperlinkAsHtml(hyperlink).asString()
Форматирование гиперссылки для добавления ее на веб-страницу рабочей ссылкой.
Форматирование логических значений
-
utils.formatters.oneZeroFormatter(booleanValue)
Возвращаемое значение:
- 1, если значение true
- 0, если значение false
-
utils.formatters.yesNoFormatter(booleanValue)
Возвращаемое значение:
- да, если значение true
- нет, если значение false.
Форматирование числовых значений
-
utils.formatters.bytesToKb(value, roundUp)
Конвертация величины в байтах в килобайты.
Параметры метода:
- value — число в байтах
- roundUp = true (округляется в сторону большего значения)
- roundUp = false (округляется в сторону меньшего значения)
Возвращает целое число размер value в килобайтах округленный вверх или вниз.
-
utils.formatters.bytesToMb(value, roundUp)
Конвертация величины в байтах в мегабайты.
Параметры метода:
- value — число в байтах
- roundUp = true (округляется в сторону большего значения)
- roundUp = false (округляется в сторону меньшего значения)
Возвращает целое число размер value в мегабайтах округленный вверх или вниз.
-
utils.formatToHtml(subject."attrCode")
Форматирование простого текста (text) для представления в html.
Возвращает фрагмент HTML. Преобразование происходит заменой переносов строк ("\n") на теги <br>.
Пример. Конструкция для передачи описания запроса в оповещении:
${utils.formatToHtml(subject.description)}