net.java.sip.communicator.service.gui
Interface WizardContainer

All Known Implementing Classes:

AccountRegWizardContainerImpl, CreateChatRoomWizard, JoinChatRoomWizard, Wizard

public interface WizardContainer

The WizardContainer is a base wizard interface that allows to control the wizard buttons. It is extended by the AccountRegistrationWizardContainer and for now is used only there. In spite of this fact it's defined in a different interface, because of the more general character of the methods. It could be extended in the future to make a complete wizard interface.

Author:

Yana Stamcheva

Method Summary

boolean	isBackButtonEnabled() Returns TRUE if "Back" wizard button is enabled, FALSE otherwise.
boolean	isCancelButtonEnabled() Returns TRUE if "Cancel" wizard button is enabled, FALSE otherwise.
boolean	isNextFinishButtonEnabled() Returns TRUE if "Next" or "Finish" wizard button is enabled, FALSE otherwise.
void	refresh() Refreshes the current content of this wizard container.
void	setBackButtonEnabled(boolean newValue) Sets the "Back" wizard button enabled or disabled.
void	setCancelButtonEnabled(boolean newValue) Sets the "Cancel" wizard button enabled or disabled.
void	setFinishButtonText(String text) Sets the text label of the "Finish" wizard button.
void	setNextFinishButtonEnabled(boolean newValue) Sets the "Next" or "Finish" wizard button enabled or disabled.

Method Detail

isBackButtonEnabled

boolean isBackButtonEnabled()

Returns TRUE if "Back" wizard button is enabled, FALSE otherwise.

Returns:

TRUE if "Back" wizard button is enabled, FALSE otherwise.

setBackButtonEnabled

void setBackButtonEnabled(boolean newValue)

Sets the "Back" wizard button enabled or disabled.

Parameters:

newValue - TRUE to enable the "Back" wizard button, FALSE to disable it.

isNextFinishButtonEnabled

boolean isNextFinishButtonEnabled()

Returns TRUE if "Next" or "Finish" wizard button is enabled, FALSE otherwise.

Returns:

TRUE if "Next" or "Finish" wizard button is enabled, FALSE otherwise.

setNextFinishButtonEnabled

void setNextFinishButtonEnabled(boolean newValue)

Sets the "Next" or "Finish" wizard button enabled or disabled.

Parameters:

newValue - TRUE to enable the "Next" or "Finish" wizard button, FALSE to disable it.

isCancelButtonEnabled

boolean isCancelButtonEnabled()

Returns TRUE if "Cancel" wizard button is enabled, FALSE otherwise.

Returns:

TRUE if "Cancel" wizard button is enabled, FALSE otherwise.

setCancelButtonEnabled

void setCancelButtonEnabled(boolean newValue)

Sets the "Cancel" wizard button enabled or disabled.

Parameters:

newValue - TRUE to enable the "Cancel" wizard button, FALSE to disable it.

setFinishButtonText

void setFinishButtonText(String text)

Sets the text label of the "Finish" wizard button. The default value of the "Finish" button is still defined by the implementation of this WizardContainer interface, but calling this method would allow wizards to specify their own finish button.

Parameters:

text - the new label of the button

refresh

void refresh()

Refreshes the current content of this wizard container.