net.sf.okapi.common

Interface IUserPrompt

All Known Implementing Classes:

UserPrompt

public interface IUserPrompt

An interface for prompting the user for confirmation before continuing.

Method Summary

Modifier and Type	Method and Description
void	initialize(Object uiParent, String title) Initialize the prompt.
boolean	promptOKCancel(String message) Prompt the user to decide between "OK" and "Cancel".
boolean	promptYesNoCancel(String message) Prompt the user to decide between "Yes", "No", and "Cancel".

Method Detail

initialize

void initialize(Object uiParent,
                String title)

Initialize the prompt.

Parameters:

uiParent - The UI parent (used in GUI mode only; can be null otherwise)

title - The title of the dialog (used in GUI mode only; can be null)

promptYesNoCancel

boolean promptYesNoCancel(String message)
                   throws OkapiUserCanceledException

Prompt the user to decide between "Yes", "No", and "Cancel".

Parameters:

message - The text message to display

Returns:

true if yes, false if no

Throws:

OkapiUserCanceledException - If user cancels

promptOKCancel

boolean promptOKCancel(String message)
                throws OkapiUserCanceledException

Prompt the user to decide between "OK" and "Cancel".

Parameters:

message - The text message to display

Returns:

true if OK

Throws:

OkapiUserCanceledException - If user cancels