org.jboss.forge.addon.ui

Interface UIProvider

All Known Subinterfaces:

Shell

All Known Implementing Classes:

UIProviderImpl

public interface UIProvider

A UIProvider provides access to the underlying UI implementation. Information like, if it is running under a GUI, as well as the out/err streams are available from implementations of this interface

Author:

George Gastaldi

Method Summary

Modifier and Type	Method and Description
UIDesktop	getDesktop()
String	getName()
UIOutput	getOutput()
boolean	isEmbedded()
boolean	isGUI()

Method Detail

getName

String getName()

Returns:

a human-friendly name of this UIProvider

isGUI

boolean isGUI()

Returns:

true if this UIProvider is running a Graphical User Interface.

isEmbedded

boolean isEmbedded()

Returns:

true if this UIProvider is being executed in an embedded environment (eg: as a Shell in IDE or as part of an application)

getOutput

UIOutput getOutput()

Returns:

the UIOutput used to display messages during a UI interaction

getDesktop

UIDesktop getDesktop()

Returns:

the UIDesktop associated with this UIProvider.