com.kuka.roboticsAPI.uiModel
Interface ITaskUI

All Known Subinterfaces:

IApplicationUI

All Known Implementing Classes:

AbstractApplicationUI, ConsoleApplicationUI

public interface ITaskUI

Interface for the task UI.

Provides the interaction with the user of RoboticsAPI application and background tasks.

Method Summary

IUserKeyBar	createUserKeyBar(String name) Creates a IUserKeyBar for user interaction during the execution of a robot application or background task.
IUserKeyBar	getUserKeyBar(String name) Gets the user key bar with the specified name.

Method Detail

createUserKeyBar

IUserKeyBar createUserKeyBar(String name)

Creates a IUserKeyBar for user interaction during the execution of a robot application or background task.

A user key bar can hold one or more IUserKeys. A user key can be set up by the programmer with custom functionality and appearance.
The user key bar is displayed on the UI configured for the Station on which the application or background task is running.
The user key bar needs to be published to be displayed on the UI. To do this use the publish()-Method, after all user keys have been added.

Parameters:

name - the name of the user key bar. Must be unique. Can not be null or empty string.

Returns:

a new user key bar

getUserKeyBar

IUserKeyBar getUserKeyBar(String name)

Gets the user key bar with the specified name.

Parameters:

name - the name of the user key bar.

Returns:

the user key bar