com.kuka.roboticsAPI.uiModel
Class UIEngine

java.lang.Object
  com.kuka.roboticsAPI.AbstractEngine
      com.kuka.roboticsAPI.uiModel.UIEngine

All Implemented Interfaces:

IEngine, IUIEngine

public class UIEngine
extends AbstractEngine
implements IUIEngine

The UI engine handles the life cycle of and provides access to the application UI. There is exactly one UI in the engine.

Constructor Summary

UIEngine(RoboticsAPIContext context)
Creates a new UI engine class.

Method Summary

void	dispose() Disposes the engine.
IApplicationUI	getApplicationUI() Gets the application UI of the engine.
Class<? extends IEngine>	getEngineType() Gets the type of the engine.

Methods inherited from class com.kuka.roboticsAPI.AbstractEngine

getContext, initialize, setParameters

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.IEngine

getContext, initialize, setParameters

Constructor Detail

UIEngine

public UIEngine(RoboticsAPIContext context)

Creates a new UI engine class.

Parameters:

context - The context for this controller. null is not allowed.

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.

Method Detail

getEngineType

public Class<? extends IEngine> getEngineType()

Description copied from class: AbstractEngine

Gets the type of the engine. This should be the concrete IEngine interface which the engine is implementing.

Specified by:

getEngineType in interface IEngine

Specified by:

getEngineType in class AbstractEngine

Returns:

The type of the engine. This should be the concrete IEngine interface which the engine is implementing.

getApplicationUI

public IApplicationUI getApplicationUI()

Description copied from interface: IUIEngine

Gets the application UI of the engine. If it has not been created, it will be created.

Specified by:

getApplicationUI in interface IUIEngine

Returns:

the application UI.

dispose

public void dispose()

Description copied from class: AbstractEngine

Disposes the engine. This method is automatically called by the engine context when it is disposed.

Specified by:

dispose in interface IEngine

Overrides:

dispose in class AbstractEngine