com.kuka.roboticsAPI.uiModel
Interface IApplicationUI

All Superinterfaces:

ITaskUI

All Known Implementing Classes:

AbstractApplicationUI, ConsoleApplicationUI

public interface IApplicationUI
extends ITaskUI

Interface for the application UI.

Provides the interaction with the user of RoboticsAPI application.

Method Summary

int	displayModalDialog(com.kuka.roboticsAPI.uiModel.ApplicationDialogType type, String dialogText, String... buttons) Displays a modal dialog for user interaction during the run of a robot application.

Methods inherited from interface com.kuka.roboticsAPI.uiModel.ITaskUI

createUserKeyBar, getUserKeyBar

Method Detail

displayModalDialog

int displayModalDialog(com.kuka.roboticsAPI.uiModel.ApplicationDialogType type,
                       String dialogText,
                       String... buttons)

Displays a modal dialog for user interaction during the run of a robot application.

The dialog remains active until the user chooses an answer or the application is closed.
Only one dialog can be opened simultaneously from the same application.
The dialog is displayed on the UI configured for the Station on which the application runs. If no UI is configured dialog will be shown in text form on the standard console.

Parameters:

type - the type of dialog that should be shown. The dialog icons vary according to the chosen type.

dialogText - the text that is shown to the user.

buttons - the possible responses to the dialog are represented as buttons. The user must choose and click one button to close the dialog. There is a limit of twelve buttons per dialog.

Returns:

the index of the chosen button. I.e. possible return values range from 0 to (number of buttons - 1).

Throws:

UIEngineException - if the dialog was canceled or closed not as a result of selection of one of dialog buttons, but because application exit or lost connection to the UI that displaying the dialog.
Is thrown as well if the application tries to open more that one modal dialog at the same time.