com.ibm.xtools.pluglets.host
Interface IPlugletMessageDialog

public interface IPlugletMessageDialog

Displays messages and error dialogs for the pluglet.

This interface is implemented by the pluglet host.

Method Summary

boolean	confirm(String message, String title) Displays a message dialog with OK and Cancel buttons.
void	error(String message, String title) Displays an error dialog with an OK button.
void	inform(String message, String title) Displays an information dialog with an OK button.
String	prompt(String message, String initialText, String title) Displays an input dialog with a prompt message, a text input field, and OK and Cancel buttons.
boolean	question(String message, String title) Displays a question message dialog with Yes and No buttons.
void	warning(String message, String title) Displays a warning dialog with an OK button.

Method Detail

confirm

boolean confirm(String message,
                String title)

Displays a message dialog with OK and Cancel buttons.

Parameters:

message - The message to be displayed.

title - The title of the message dialog.

Returns:

Returns a boolean value of true when the OK button is pressed. Otherwise, it returns a value of false.

error

void error(String message,
           String title)

Displays an error dialog with an OK button.

Parameters:

message - The message to be displayed.

title - The title of the error dialog.

inform

void inform(String message,
            String title)

Displays an information dialog with an OK button.

Parameters:

message - The message to be displayed.

title - The title of the information dialog.

prompt

String prompt(String message,
              String initialText,
              String title)

Displays an input dialog with a prompt message, a text input field, and OK and Cancel buttons.

Parameters:

message - The prompt to be displayed.

initialText - The initial text to be displayed in the text input field.

title - The title of the dialog.

Returns:

Returns the text input when the OK button is pressed, which is a non-null value but possibly zero-length. Otherwise, it returns a value of null.

question

boolean question(String message,
                 String title)

Displays a question message dialog with Yes and No buttons.

Parameters:

message - The question message to be displayed.

title - The title of the question message dialog.

Returns:

Returns a boolean value of true when the Yes button is pressed. Otherwise, it returns a value of false.

warning

void warning(String message,
             String title)

Displays a warning dialog with an OK button.

Parameters:

message - The message to be displayed.

title - The title of the warning dialog.