Package aQute.bnd.service.message
Interface Dialogs
public interface Dialogs
A simple dialog handler for prompting for an input string from the user,
displaying a message to the user, or showing a set of errors and warnings.
These methods can be called on any thread.
-
Method Summary
Modifier and TypeMethodDescriptioncreateProgress
(String title) Create a progress monitorvoid
Display a list of errors and warnings.org.osgi.util.promise.Promise<Integer>
Display a message and optionally a set of buttons.org.osgi.util.promise.Promise<String>
Display a dialog where the user can input a string.
-
Method Details
-
message
org.osgi.util.promise.Promise<Integer> message(String title, String message, String[] buttons, int defaultIndex) throws Exception Display a message and optionally a set of buttons. Return the index of the selected button or -1 if the dialog was canceled.- Parameters:
title
- The title of the dialog, must not be nullmessage
- The message displayed, must not be nullbuttons
- A list of buttons, may be nulldefaultIndex
- The default index. Must be -1 for none or between 0..n, where n is the number of buttons specified.- Returns:
- -1 if canceled, otherwise the index of the given button that was pressed.
- Throws:
Exception
-
prompt
org.osgi.util.promise.Promise<String> prompt(String title, String query, String initialValue, Pattern validator) throws Exception Display a dialog where the user can input a string. An initial value can be supplied and a validator can optionally beused to validate any input. Either null is returned when the user cancels or a string with valid input.- Parameters:
title
- The title of the dialog, must not be nullquery
- The query displayed, must not be nullinitialValue
- The initial value, can be nullvalidator
- A pattern that must match the input, can be null if no validator is necessary- Returns:
- A string object or null if no input was given
- Throws:
Exception
-
errors
Display a list of errors and warnings. This method will return immediately, it will not wait for the user to dismiss this window. Multiple calls might actually be aggregated into a single dialog- Parameters:
message
- The message displayed, must not be nullreporter
- Contains the errors and warnings- Throws:
Exception
-
createProgress
Create a progress monitor- Throws:
Exception
-