com.kuka.roboticsAPI.uiModel
Class AbstractApplicationUI

java.lang.Object
  com.kuka.roboticsAPI.uiModel.AbstractApplicationUI

All Implemented Interfaces:

IApplicationUI, ITaskUI

Direct Known Subclasses:

ConsoleApplicationUI

public abstract class AbstractApplicationUI
extends Object
implements IApplicationUI

Abstract base class for application UIs.

This element is an undocumented internal feature. It is not intended to be used by applications as it might change or be removed in future versions.

Constructor Summary

AbstractApplicationUI()

Method Summary

abstract void	cancelCurrentDialog(String reason) Cancels the currently displayed dialog.
protected void	checkDialogParams(com.kuka.roboticsAPI.uiModel.ApplicationDialogType type, String captionText, String dialogText, String... buttons) Checks the parameter given to the for the modal dialog that should be displayed.
void	dispose() Disposes the currently active dialog.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

displayModalDialog

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

createUserKeyBar, getUserKeyBar

Constructor Detail

AbstractApplicationUI

public AbstractApplicationUI()

Method Detail

cancelCurrentDialog

public abstract void cancelCurrentDialog(String reason)

Cancels the currently displayed dialog.
An UIEngineException will be thrown with the given reason.

Parameters:

reason - the reason for canceling the dialog.

This element is an undocumented internal feature. It is not intended to be used by applications as it might change or be removed in future versions.

dispose

public void dispose()

Disposes the currently active dialog.

This element is an undocumented internal feature. It is not intended to be used by applications as it might change or be removed in future versions.

checkDialogParams

protected void checkDialogParams(com.kuka.roboticsAPI.uiModel.ApplicationDialogType type,
                                 String captionText,
                                 String dialogText,
                                 String... buttons)

Checks the parameter given to the for the modal dialog that should be displayed.

Parameters:

type - the type of the dialog. null is not allowed.

captionText - the caption of the dialog. null is not allowed.

dialogText - the text for the dialog. Must not be null or empty.

buttons - the possible responses. Must not be null or empty.

Throws:

IllegalArgumentException - if a parameter is not valid.