|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface GUIBuilderService
A service for creating simple GUIs for user interaction. This service
provides several methods for popping up dialog boxes to get or give very
simple information and a more flexible way to create GUI
s using a
standard OSGi MetaTypeProvider
. The MetaTypeProvider basically lists
what input is needed (String, Integer, Float, etc...), a description of the
input, and a way to validate input.
See the
CIShell Specification 1.0 for documentation on creating GUIs with this
service.
Algorithm writers are encouraged to use this service if they need to get
additional input from the user rather than creating their own GUI. This is
to ensure a consistent user input method and so that the GUI can easily be
routed to the user when running remotely.
Method Summary | |
---|---|
GUI |
createGUI(String id,
MetaTypeProvider parameters)
Creates a GUI for user interaction |
Dictionary |
createGUIandWait(String id,
MetaTypeProvider parameters)
Creates a GUI, gets data from the user, and returns what they entered. |
boolean |
showConfirm(String title,
String message,
String detail)
Pops up a confirmation box to the user with an 'Ok' and 'Cancel' button |
void |
showError(String title,
String message,
String detail)
Pops up an error box to the user. |
void |
showError(String title,
String message,
Throwable error)
Pops up an error box to the user. |
void |
showInformation(String title,
String message,
String detail)
Pops up an information box to the user. |
boolean |
showQuestion(String title,
String message,
String detail)
Pops up a question box to the user with a 'Yes' and 'No' button |
void |
showWarning(String title,
String message,
String detail)
Pops up a warning box to the user. |
Method Detail |
---|
GUI createGUI(String id, MetaTypeProvider parameters)
id
- The id to use to get the correct
ObjectClassDefinition
from the provided
MetaTypeProviderparameters
- Provides the parameters needed to get information from
the user
Dictionary createGUIandWait(String id, MetaTypeProvider parameters)
MetaTypeProvider
, then pops the GUI up to the user, who then
enters in the needed information, which is then taken and put into a
Dictionary
, and is given to this method's caller.
id
- The id to use to get the correct
ObjectClassDefinition
from the provided
MetaTypeProviderparameters
- Provides the parameters needed to get information from
the user
null
if the operation
was cancelledboolean showConfirm(String title, String message, String detail)
title
- The title of the pop-upmessage
- The message to displaydetail
- Additional details
true
, otherwise
false
boolean showQuestion(String title, String message, String detail)
title
- The title of the pop-upmessage
- The question to displaydetail
- Additional details
true
, otherwise
false
void showInformation(String title, String message, String detail)
LogService
instead.
title
- The title of the pop-upmessage
- The message to displaydetail
- Additional detailsvoid showWarning(String title, String message, String detail)
LogService
instead.
title
- The title of the pop-upmessage
- The message to displaydetail
- Additional detailsvoid showError(String title, String message, String detail)
LogService
instead.
title
- The title of the pop-upmessage
- The message to displaydetail
- Additional detailsvoid showError(String title, String message, Throwable error)
LogService
instead.
title
- The title of the pop-upmessage
- The message to displayerror
- The actual exception that was thrown
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |