com.izforge.izpack.api.handler

Interface AbstractUIHandler

public interface AbstractUIHandler

This interface describes basic functionality neccessary for user interaction.

All methods or functions which perform work and need to notify or ask the user use a listener for such purposes. This way, we can separate UI from function.

Field Summary

Fields

Modifier and Type	Field and Description
static int	ANSWER_CANCEL
static int	ANSWER_NO
static int	ANSWER_YES
static int	CHOICES_YES_NO

Method Summary

Modifier and Type	Method and Description
int	askQuestion(String title, String question, int choices) Ask the user a question.
int	askQuestion(String title, String question, int choices, int default_choice) Ask the user a question.
int	askWarningQuestion(String title, String question, int choices, int default_choice) Ask the use a question in the form of a warning.
void	emitError(String title, String message) Notify the user of some error.
void	emitNotification(String message) Notify the user about something.
boolean	emitWarning(String title, String message) Warn the user about something.

Field Detail

ANSWER_CANCEL

static final int ANSWER_CANCEL

See Also:

Constant Field Values

ANSWER_YES

static final int ANSWER_YES

See Also:

Constant Field Values

ANSWER_NO

static final int ANSWER_NO

See Also:

Constant Field Values

CHOICES_YES_NO

static final int CHOICES_YES_NO

See Also:

Constant Field Values

Method Detail

emitNotification

void emitNotification(String message)

Notify the user about something.

The difference between notification and warning is that a notification should not need user interaction and can safely be ignored.

Parameters:

message - The notification.

emitWarning

boolean emitWarning(String title,
                    String message)

Warn the user about something.

Parameters:

title - The message title (used for dialog name, might not be displayed)

message - The warning message.

Returns:

true if the user decided to continue

emitError

void emitError(String title,
               String message)

Notify the user of some error.

Parameters:

title - The message title (used for dialog name, might not be displayed)

message - The error message.

askQuestion

int askQuestion(String title,
                String question,
                int choices)

Ask the user a question.

Parameters:

title - The title of the question (useful for dialogs). Might be null.

question - The question.

choices - The set of choices to present. Either CHOICES_YES_NO or CHOICES_YES_NO_CANCEL

Returns:

The user's choice. (ANSWER_CANCEL, ANSWER_YES or ANSWER_NO)

askQuestion

int askQuestion(String title,
                String question,
                int choices,
                int default_choice)

Ask the user a question.

Parameters:

title - The title of the question (useful for dialogs). Might be null.

question - The question.

choices - The set of choices to present. Either CHOICES_YES_NO or CHOICES_YES_NO_CANCEL

default_choice - The default choice. One of ANSWER_CANCEL, ANSWER_YES or ANSWER_NO.

Returns:

The user's choice. (ANSWER_CANCEL, ANSWER_YES or ANSWER_NO)

askWarningQuestion

int askWarningQuestion(String title,
                       String question,
                       int choices,
                       int default_choice)

Ask the use a question in the form of a warning.

Parameters:

title - The title of the question (useful for dialogs). Might be null.

question - The question.

choices - The set of choices to present. Either CHOICES_YES_NO or CHOICES_YES_NO_CANCEL

default_choice - The default choice. One of ANSWER_CANCEL, ANSWER_YES or ANSWER_NO.

Returns:

The user's choice. (ANSWER_CANCEL, ANSWER_YES or ANSWER_NO)