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

All Known Implementing Classes:

AccountRegSummaryPage, CreateChatRoomWizardPage1, CreateChatRoomWizardPage2, EmptyAccountRegistrationWizardPage, FirstWizardPage, FirstWizardPage, FirstWizardPage, FirstWizardPage, FirstWizardPage, FirstWizardPage, FirstWizardPage, FirstWizardPage, FirstWizardPage, FirstWizardPage, FirstWizardPage, FirstWizardPage, JoinChatRoomWizardPage1, JoinChatRoomWizardPage2

public interface WizardPage

The WizardPage represents a page in a WizardContainer. A page has a unique identifier. Each page should specify the identifier of both next and previous page to be displayed when user clicks "Next" or "Back" wizard button. These identifiers will be used from the WizardContainer to determine, which page should be displayed when the "Next" wizard button is clicked and which when "Back" is clicked.

In the construction of an account registration wizard container the UI Service implementation could implement this interface to define a Default wizard page and a Summary page. Each AccountRegistrationWizard could obtain the identifier of both Default and Summary page from the corresponding AccountRegistrationWizardContainer, where it is added.

The predefined FINISH_PAGE_IDENTIFIER should be used to mark the end of a wizard.

Author:

Yana Stamcheva

Field Summary

static String	DEFAULT_PAGE_IDENTIFIER The identifier of the default wizard page.
static String	FINISH_PAGE_IDENTIFIER The identifier of the last wizard page.
static String	SUMMARY_PAGE_IDENTIFIER The identifier of the summary wizard page.

Method Summary

void	commitPage() Invoked when user clicks on the "Next" wizard button.
Object	getBackPageIdentifier() Returns the identifier of the previous wizard page.
Object	getIdentifier() Returns the identifier of this WizardPage.
Object	getNextPageIdentifier() Returns the identifier of the next wizard page.
Object	getWizardForm() Returns the user interface form represented by this page.
void	pageBack() Invoked when user clicks on the "Back" wizard button.
void	pageHiding() Invoked when this WizardPage will be hidden eighter because the user has clicked "Back" or "Next".
void	pageShowing() Invoked when this WizardPage will be shown eighter because the user has clicked "Back" on the next wizard page or "Next" on the previous one.
void	pageShown() Invoked when this WizardPage is shown to the user and has become the current wizard page.

Field Detail

FINISH_PAGE_IDENTIFIER

static final String FINISH_PAGE_IDENTIFIER

The identifier of the last wizard page.

See Also:

Constant Field Values

SUMMARY_PAGE_IDENTIFIER

static final String SUMMARY_PAGE_IDENTIFIER

The identifier of the summary wizard page.

See Also:

Constant Field Values

DEFAULT_PAGE_IDENTIFIER

static final String DEFAULT_PAGE_IDENTIFIER

The identifier of the default wizard page.

At the time of this writing, it seems from its current uses that the constant indicates a null back page.

See Also:

Constant Field Values

Method Detail

getIdentifier

Object getIdentifier()

Returns the identifier of this WizardPage.

Returns:

the identifier of this WizardPage

getNextPageIdentifier

Object getNextPageIdentifier()

Returns the identifier of the next wizard page. Meant to be used by the WizardContainer to determine which is the next page to display when user clicks on the "Next" wizard button.

When this instance corresponds to the last page of the wizard this method should return WizardPage.FINISH_PAGE_IDENTIFIER

Returns:

the identifier of the next wizard page

getBackPageIdentifier

Object getBackPageIdentifier()

Returns the identifier of the previous wizard page. Meant to be used by the WizardContainer to determine which is the page to display when user clicks on the "Back" wizard button.

Returns:

the identifier of the prevoious wizard page

getWizardForm

Object getWizardForm()

Returns the user interface form represented by this page. The form should be developed by using a library that is supported from current UI Service implementation. For example if the current UI Service implementation is made usind Java Swing, this method should return a java.awt.Component to be added properly in the WizardContainer implemented in UI Service implementation.

Returns:

the user interface form represented by this page

pageHiding

void pageHiding()

Invoked when this WizardPage will be hidden eighter because the user has clicked "Back" or "Next". This method should be invoked from the WizardContainer implementation just before this page is hidden when replacing it with the previous or the next one.

You should add here all operations you need to be executed when this WizardPage is about to be hidden.

pageShown

void pageShown()

Invoked when this WizardPage is shown to the user and has become the current wizard page. This method should be invoked from the WizardContainer implementation just after this page is shown to the user.

You should add here all operations you need to be executed when this WizardPage is shown.

pageShowing

void pageShowing()

Invoked when this WizardPage will be shown eighter because the user has clicked "Back" on the next wizard page or "Next" on the previous one. This method should be invoked from the WizardContainer implementation just before this page is shown to the user.

You should add here all operations you need to be executed when this WizardPage is about to be shown.

commitPage

void commitPage()

Invoked when user clicks on the "Next" wizard button. You should add here all operations you need to be executed when user clicks "Next" on this WizardPage.

pageBack

void pageBack()

Invoked when user clicks on the "Back" wizard button. You should add here all operations you need to be executed when user clicks "Back" on this WizardPage.