All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface symantec.itools.awt.WizardController

public interface WizardController

The SimpleWizardController implements the basic default behavior for this interface.

See Also:

SimpleWizardController

CANCEL

Constant wizard action value.

FINISH

Constant wizard action value.

HELP

Constant wizard action value.

NEXT

Constant wizard action value.

PREVIOUS

Constant wizard action value.

doCancel()

Called when the CANCEL action has been validated.

doFinish()

Called when the FINISH action has been validated.

doHelp()

Called when the HELP action has been validated.

doPrepare()

Called before the first page is shown.

getNextPage()

Return the next page.

getPreviousPage()

Return the previous page.

isCancelEnabled()

Tells if the Cancel button must be enabled.

isFinishEnabled()

Tells if the Finish button must be enabled.

isHelpEnabled()

Tells if the Help button must be enabled.

isNextEnabled()

Tells if the Next button must be enabled.

isPreviousEnabled()

Tells if the Previous button must be enabled.

pageHidden(Component)

Called before the page is hidden.

pageShown(Component)

Called after a page is shown.

preparePage(Component, int)

Called before a page is shown.

resetChainInfo()

Reset the chain information set by setPreviousPageIndex, setNextPageIndex, setPreviousPage and setNextPage.

setCancelEnabled(boolean)

Enables or disables the Cancel button.

setFinishEnabled(boolean)

Enables or disables the Finish button.

setHelpEnabled(boolean)

Enables or disables the Help button.

setNextEnabled(boolean)

Enables or disables the Next button.

setNextPage(Component)

Set a next page.

setNextPageIndex(int)

Set an index for the next page.

setPreviousEnabled(boolean)

Enables or disables the Previous button.

setPreviousPage(Component)

Set a previous page.

setPreviousPageIndex(int)

Set an index for the previous page.

validatePage(Component, Component, int)

Try to validate a page.

public static final int CANCEL

Constant wizard action value.

See Also:

preparePage, validatePage

public static final int FINISH

Constant wizard action value.

See Also:

preparePage, validatePage

public static final int HELP

Constant wizard action value.

See Also:

preparePage, validatePage

public static final int NEXT

Constant wizard action value.

See Also:

preparePage, validatePage

public static final int PREVIOUS

Constant wizard action value.

See Also:

preparePage, validatePage

public abstract void doCancel()

Called when the CANCEL action has been validated. Default behavior: none.

public abstract void doFinish()

Called when the FINISH action has been validated. Default behavior: none.

public abstract void doHelp()

Called when the HELP action has been validated. Default behavior: none.

public abstract void doPrepare()

Called before the first page is shown. Default behavior: none.

public abstract java.awt.Component getNextPage()

Return the next page. Default behavior: if a next page has been set with setNextPage, return this page. If a next page index has been set with setNextPageIndex, return the associated page. Else, return the next page in the Wizard components order, page 0 if no page has been shown. If there is none, return null. This method is called before and after a validatePage, and by the default implementation of isNextEnabled.

Returns:

The next page to show, null if there is none.

See Also:

setNextPage, setNextPageIndex

public abstract java.awt.Component getPreviousPage()

Return the previous page. Default behavior: if a previous page has been set with setPreviousPage, return this page. If a previous page index has been set with setPreviousPageIndex, return the associated page. Else, return the next to last element on the stack. If there is none, return null. This method is called before and after a validatePage, and by the default implementation of isPreviousEnabled.

Returns:

The previous page to show, null if there is none.

See Also:

setPreviousPage, setPreviousPageIndex, preparePage

public abstract boolean isCancelEnabled()

Tells if the Cancel button must be enabled. Default behavior: return true.

Returns:

True if the Cancel button must be enabled, false otherwise.

public abstract boolean isFinishEnabled()

Tells if the Finish button must be enabled. Default behavior: return true if the current page is the last page in the Wizard container.

Returns:

True if the Finish button must be enabled, false otherwise.

public abstract boolean isHelpEnabled()

Tells if the Help button must be enabled. Default behavior: return false.

Returns:

True if the Help button must be enabled, false otherwise.

public abstract boolean isNextEnabled()

Tells if the Next button must be enabled. Default behavior: return true if the getNextPage method returns a page, false otherwise.

Returns:

True if the Next button must be enabled, false otherwise.

public abstract boolean isPreviousEnabled()

Tells if the Previous button must be enabled. Default behavior: return true if the getPreviousPage method returns a page, false otherwise.

Returns:

True if the Previous button must be enabled, false otherwise.

public abstract void pageHidden(Component comp)

Called before the page is hidden. Default behavior: none.

Parameters:

comp - The page that has been shown.

public abstract void pageShown(Component comp)

Called after a page is shown. Default behavior: none.

Parameters:

comp - The page that has been shown.

public abstract void preparePage(Component comp,
                                 int action)

Called before a page is shown. Default behavior: add the page to the history stack if the action is NEXT, remove the last page from the history stack if the action is PREVIOUS.

Parameters:

comp - The page that will be shown.

action - The action that has led to this page, either PREVIOUS or NEXT. If it is the first page of the wizard, the action is NEXT.

See Also:

getPreviousPage

public abstract void resetChainInfo()

Reset the chain information set by setPreviousPageIndex, setNextPageIndex, setPreviousPage and setNextPage.

See Also:

setPreviousPageIndex, setNextPageIndex, setPreviousPage, setNextPage

public abstract void setCancelEnabled(boolean status)

Enables or disables the Cancel button.

Parameters:

status - true to enable the button

See Also:

setPreviousEnabled, setNextEnabled, setFinishEnabled, setHelpEnabled

public abstract void setFinishEnabled(boolean status)

Enables or disables the Finish button.

Parameters:

status - true to enable the button

See Also:

setPreviousEnabled, setNextEnabled, setCancelEnabled, setHelpEnabled

public abstract void setHelpEnabled(boolean status)

Enables or disables the Help button.

Parameters:

status - true to enable the button

See Also:

setPreviousEnabled, setNextEnabled, setFinishEnabled, setCancelEnabled

public abstract void setNextEnabled(boolean status)

Enables or disables the Next button.

Parameters:

status - true to enable the button

See Also:

setPreviousEnabled, setFinishEnabled, setCancelEnabled, setHelpEnabled

public abstract void setNextPage(Component comp)

Set a next page. This page is used by the default implementation of getNextPage. It is reset after a page has been shown.

See Also:

getNextPage, resetChainInfo

public abstract void setNextPageIndex(int index)

Set an index for the next page. This index is used by the default implementation of getNextPage. It is reset after a page has been shown.

See Also:

getNextPage, resetChainInfo

public abstract void setPreviousEnabled(boolean status)

Enables or disables the Previous button.

Parameters:

status - true to enable the button

See Also:

setNextEnabled, setFinishEnabled, setCancelEnabled, setHelpEnabled

public abstract void setPreviousPage(Component comp)

Set a previous page. This page is used by the default implementation of getPreviousPage. It is reset after a page has been shown.

See Also:

getPreviousPage, resetChainInfo

public abstract void setPreviousPageIndex(int index)

Set an index for the previous page. This index is used by the default implementation of getPreviousPage. It is reset after a page has been shown.

See Also:

getPreviousPage, resetChainInfo

public abstract boolean validatePage(Component comp,
                                     Component target,
                                     int action)

Try to validate a page. Default behavior: return the state of the button associated with the action, using the isXxxEnabled methods. For example, if the controller has the Previous button enabled, this method will return true, meaning that it is valid to go back. If the result is true, then the Wizard will proceed with the action, else the state will not change.

Parameters:

comp - The page that must be validated.

target - The page that will be shown if the action is PREVIOUS or NEXT, null otherwise.

action - The action that must be validated, PREVIOUS, NEXT, FINISH, CANCEL or HELP.

Returns:

True if the action is validated, false otherwise.

All Packages  Class Hierarchy  This Package  Previous  Next  Index