ru.crystals.pos.spi.ui.input

Interface UIInputForms

All Superinterfaces:

Injectable

public interface UIInputForms
extends Injectable

Интерфейс для взаимодействия с пользовательским интерфейсом кассы. Формы ввода данных.

Method Summary

Modifier and Type	Method and Description
void	showFieldListForm(FieldListFormParameters parameters, FieldListFormListener listener) Показать форму с набором полей.
void	showInputNumberForm(java.lang.String caption, java.lang.String text, java.lang.String inputFieldHint, int maxLength, InputListener listener) Показать форму для ввода номера.
void	showInputScanNumberForm(java.lang.String caption, java.lang.String text, java.lang.String inputFieldHint, int maxLength, InputScanNumberFormListener listener) Показать форму для ввода номера или сканирования.
default void	showPatternInputForm(PatternFormParameters parameters, InputListener listener) Аналог showPatternInputForm(String, String, String, String, String, InputListener), но текстовые поля запакованы в отдельную модель, также добавлено поле footerText для текста под кнопкой подтверждения
default void	showPatternInputForm(java.lang.String caption, java.lang.String text, java.lang.String defaultValue, java.lang.String inputHint, java.lang.String pattern, InputListener listener) Deprecated. В новом методе все параметры обернуты в новую, расширяемую модель, в которую также добавлен параметр для текста под кнопкой подтверждения.
default void	showQRScanWithTextForm(QRWithTextFormParameters parameters, ScanFormListener scanFormListener) Показать форму сканирования сгенерированного QR код
void	showScanForm(java.lang.String caption, java.lang.String text, ScanFormListener listener) Показать форму для сканирования штрихкода.
void	showSelectionForm(java.lang.String caption, java.util.Map<java.lang.String,java.util.List<java.lang.String>> items, InputListener listener) Показать форму выбора из нескольких значений.

Method Detail

showScanForm

void showScanForm(java.lang.String caption,
                  java.lang.String text,
                  ScanFormListener listener)
           throws IncorrectStateException

Показать форму для сканирования штрихкода.

Parameters:

caption - заголовок формы

text - текст формы

listener - получатель событий формы

Throws:

IncorrectStateException - если невозможно отобразить форму в данный момент

showInputNumberForm

void showInputNumberForm(java.lang.String caption,
                         java.lang.String text,
                         java.lang.String inputFieldHint,
                         int maxLength,
                         InputListener listener)
                  throws IncorrectStateException

Показать форму для ввода номера.

Parameters:

caption - заголовок формы

text - текст формы

inputFieldHint - текст в поле ввода номера

maxLength - максимальное количество символов ввода

listener - получатель событий формы

Throws:

IncorrectStateException - если невозможно отобразить форму в данный момент

showPatternInputForm

@Deprecated
default void showPatternInputForm(java.lang.String caption,
                                              java.lang.String text,
                                              java.lang.String defaultValue,
                                              java.lang.String inputHint,
                                              java.lang.String pattern,
                                              InputListener listener)
                                       throws IncorrectStateException

Deprecated. В новом методе все параметры обернуты в новую, расширяемую модель, в которую также добавлен параметр для текста под кнопкой подтверждения.

Показать форму ввода шаблонизированного текста.
Позволяет ввести текст в заранее заданный шаблон, подходит для ввода номеров телефонов по маске.

Parameters:

caption - заголовок формы.

text - текст формы

defaultValue - предустановленное значение в поле ввода

inputHint - текст-подсказка в поле ввода текста в случае, если в него не осуществлялся ввод

pattern - шаблон, согласно которому фильтруются и форматируются вводимые символы.

 # - цифра
 L - буква
 * - любой символ
 0-9 - число в заданном диапазоне
 '13246' - неизменяемый текст обрамляется одиночными кавычками
 Пример:
 "+'7'(###)###-##-##" - шаблон для ввода номера телефона
 

listener - слушатель событий формы

Throws:

IncorrectStateException - если форму нельзя отобразить в настоящий момент.

See Also:

showPatternInputForm(PatternFormParameters, InputListener)

showPatternInputForm

default void showPatternInputForm(PatternFormParameters parameters,
                                  InputListener listener)
                           throws IncorrectStateException

Аналог showPatternInputForm(String, String, String, String, String, InputListener), но текстовые поля запакованы в отдельную модель, также добавлено поле footerText для текста под кнопкой подтверждения

Parameters:

parameters - Параметры формы

listener - Слушатель событий формы

Throws:

IncorrectStateException - если форму нельзя отобразить в настоящий момент.

showInputScanNumberForm

void showInputScanNumberForm(java.lang.String caption,
                             java.lang.String text,
                             java.lang.String inputFieldHint,
                             int maxLength,
                             InputScanNumberFormListener listener)
                      throws IncorrectStateException

Показать форму для ввода номера или сканирования.

Parameters:

caption - заголовок формы

text - текст формы

inputFieldHint - текст в поле ввода номера

maxLength - максимальное количество символов ввода

listener - получатель событий формы

Throws:

IncorrectStateException - если невозможно отобразить форму в данный момент

showSelectionForm

void showSelectionForm(java.lang.String caption,
                       java.util.Map<java.lang.String,java.util.List<java.lang.String>> items,
                       InputListener listener)
                throws IncorrectStateException

Показать форму выбора из нескольких значений.

Parameters:

caption - заголовок формы

items - таблица выбора, где ключ произвольная строка, а значения отображаются в виде списка для выбора

listener - слушатель событий формы, в качестве введенного значения возвращает ключ из таблицы выбора

Throws:

IncorrectStateException - если невозможно отобразить форму в данный момент

showFieldListForm

void showFieldListForm(FieldListFormParameters parameters,
                       FieldListFormListener listener)
                throws IncorrectStateException

Показать форму с набором полей.

Parameters:

parameters - параметры формы

listener - слушатель событий формы

Throws:

IncorrectStateException - если невозможно отобразить форму в данный момент

Since:

1.23.0

showQRScanWithTextForm

default void showQRScanWithTextForm(QRWithTextFormParameters parameters,
                                    ScanFormListener scanFormListener)
                             throws IncorrectStateException

Показать форму сканирования сгенерированного QR код

Parameters:

parameters - параметры формы

scanFormListener - слушатель сканирования и закрытия внутри формы

Throws:

IncorrectStateException - если невозможно отобразить форму в данный момент