ru.crystals.pos.spi.ui

Interface UIForms

All Superinterfaces:

Injectable

public interface UIForms
extends Injectable

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

Method Summary

Modifier and Type	Method and Description
UIInputForms	getInputForms() Формы ввода данных кассы.
UIPaymentForms	getPaymentForms() Формы для плагинов оплат.
UIWebViewForms	getWebViewForms() Формы для WebView
default void	showDialogErrorForm(DialogFormParameters dialogFormParameters, DialogListener dialogListener) Форма с ошибкой с двумя кнопками
void	showDialogForm(DialogFormParameters dialogFormParameters, DialogListener dialogListener) Показать форму диалога с двумя вариантами выбора (кнопками). Пользователь (кассир) также может отказаться от выбора и нажать клавишу Отмена (или попытаться закрыть форму), в таком случае будет отправлено событие CancelListener.eventCanceled().
void	showErrorForm(java.lang.String errorText, ConfirmListener confirmListener) Показать экранную форму с сообщением об ошибке и ожиданием подтверждения после прочтения.
default void	showInfoPanelForm(InfoPanelFormParameters parameters, ConfirmListener confirmListener) Показать форму с информационной панелью
void	showMessageForm(MessageFormParameters parameters, ConfirmListener listener) Отображает экранную форму с текстовым сообщением.
void	showMessageForm(java.lang.String message, ConfirmListener confirmListener) Отображает экранную форму с текстовым сообщением.
default void	showQrForm(QrFormParameters parameters) Показать форму с отображением QR на основном экране кассы
default void	showRequestPositionForm(DialogProductFormParameters dialogProductFormParameters, DialogListener dialogListener) Показать форму диалога с информацией о товаре с двумя вариантами выбора
void	showSpinnerForm(java.lang.String message) Показать форму ожидания длительного процесса. На экране кассы отображается анимированный спинер и текст сообщения.
void	showSpinnerFormWithCancel(java.lang.String message, CancelListener canceledFormListener) Показать форму ожидания длительного процесса, с возможностью отмены пользователем. На экране кассы отображается анимированный спинер и текст сообщения.
default void	showTableForm(TableFormParameters parameters, ConfirmListener confirmListener) Показать форму с таблицей
default void	showTableForm(TableFormParameters parameters, DialogListener dialogListener) Показать форму с таблицей
default void	showTableSelectionForm(TableSelectionFormParameters parameters, TableSelectionFormListener listener) Показать форму с таблицей, поддерживающей выбор строк.
void	showTimingOutForm(java.lang.String message, int timeoutMs, TimeoutListener timeoutListener) Отображает форму ожидания длительного процесса, который должен завершиться не более чем за указанное время. Данная форма используется в случае, когда необходимо показать окно ожидания выполнения длительного процесса, но притом сообщить пользователю, сколько ещё времени (ориентировочно) ему предстоит подождать.

Method Detail

getInputForms

UIInputForms getInputForms()

Формы ввода данных кассы.

Returns:

UIInputForms

getPaymentForms

UIPaymentForms getPaymentForms()

Формы для плагинов оплат.

Returns:

UIPaymentForms

getWebViewForms

UIWebViewForms getWebViewForms()

Формы для WebView

Returns:

UIWebViewForms

showTimingOutForm

void showTimingOutForm(java.lang.String message,
                       int timeoutMs,
                       TimeoutListener timeoutListener)

Отображает форму ожидания длительного процесса, который должен завершиться не более чем за указанное время.
Данная форма используется в случае, когда необходимо показать окно ожидания выполнения длительного процесса, но притом сообщить пользователю, сколько ещё времени (ориентировочно) ему предстоит подождать. Для этого пользователю отображается счетчик с обратным отсчетом и информационное сообщение. По истечению отведенного времени окно может сообщать об этом, зажигая соответствующее событие через слушатель.

Parameters:

message - информационное сообщение, которое отображается пользователю в процессе показа окна.

timeoutMs - начальное значение счетчика обратного отсчета. Задаётся в миллисекундах.

timeoutListener - слушатель события обнуления счетчика. Событие носит информационный характер.

showSpinnerForm

void showSpinnerForm(java.lang.String message)
              throws IncorrectStateException

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

Важно:

Во время отображения данной формы весь пользовательский ввод (клавиатура, сканер и пр.) блокируется.

Parameters:

message - сообщение на форме ожидания

Throws:

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

showSpinnerFormWithCancel

void showSpinnerFormWithCancel(java.lang.String message,
                               CancelListener canceledFormListener)
                        throws IncorrectStateException

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

Parameters:

message - сообщение на форме ожидания

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

Throws:

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

showErrorForm

void showErrorForm(java.lang.String errorText,
                   ConfirmListener confirmListener)
            throws IncorrectStateException

Показать экранную форму с сообщением об ошибке и ожиданием подтверждения после прочтения.

Parameters:

errorText - текст ошибки

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

Throws:

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

See Also:

showMessageForm(MessageFormParameters, ConfirmListener)

showDialogErrorForm

default void showDialogErrorForm(DialogFormParameters dialogFormParameters,
                                 DialogListener dialogListener)
                          throws IncorrectStateException

Форма с ошибкой с двумя кнопками

Parameters:

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

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

Throws:

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

showMessageForm

void showMessageForm(java.lang.String message,
                     ConfirmListener confirmListener)
              throws IncorrectStateException

Отображает экранную форму с текстовым сообщением.

Parameters:

message - текст сообщения

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

Throws:

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

See Also:

showMessageForm(MessageFormParameters, ConfirmListener)

showMessageForm

void showMessageForm(MessageFormParameters parameters,
                     ConfirmListener listener)
              throws IncorrectStateException

Отображает экранную форму с текстовым сообщением. Сообщения могут иметь иконку и заголовок.

Parameters:

parameters - параметры сообщения.

listener - получатель события реакции пользователя на сообщение.

Throws:

IncorrectStateException - в случае, если на данном этапе нельзя отобразить экранную форму.

showDialogForm

void showDialogForm(DialogFormParameters dialogFormParameters,
                    DialogListener dialogListener)
             throws IncorrectStateException

Показать форму диалога с двумя вариантами выбора (кнопками).
Пользователь (кассир) также может отказаться от выбора и нажать клавишу Отмена (или попытаться закрыть форму), в таком случае будет отправлено событие CancelListener.eventCanceled().

Parameters:

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

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

Throws:

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

showTableForm

default void showTableForm(TableFormParameters parameters,
                           ConfirmListener confirmListener)
                    throws IncorrectStateException

Показать форму с таблицей

Parameters:

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

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

Throws:

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

showTableForm

default void showTableForm(TableFormParameters parameters,
                           DialogListener dialogListener)
                    throws IncorrectStateException

Показать форму с таблицей

Parameters:

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

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

Throws:

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

showTableSelectionForm

default void showTableSelectionForm(TableSelectionFormParameters parameters,
                                    TableSelectionFormListener listener)
                             throws IncorrectStateException

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

Parameters:

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

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

Throws:

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

Since:

1.1.0

showInfoPanelForm

default void showInfoPanelForm(InfoPanelFormParameters parameters,
                               ConfirmListener confirmListener)
                        throws IncorrectStateException

Показать форму с информационной панелью

Parameters:

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

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

Throws:

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

showQrForm

default void showQrForm(QrFormParameters parameters)

Показать форму с отображением QR на основном экране кассы

Parameters:

parameters - параметры отображения форма

Throws:

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

Since:

1.10.0

showRequestPositionForm

default void showRequestPositionForm(DialogProductFormParameters dialogProductFormParameters,
                                     DialogListener dialogListener)
                              throws IncorrectStateException

Показать форму диалога с информацией о товаре с двумя вариантами выбора

Parameters:

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

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

Throws:

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