Interface symantec.itools.awt.WizardInterface
All Packages Class Hierarchy This Package Previous Next Index
Interface symantec.itools.awt.WizardInterface
- public interface WizardInterface
The Wizard API.
A Wizard is a dialog that leads the user through a series of steps in order
to accomplish some task.
- See Also:
- Wizard
-
doCancel()
- Performs the actions needed when the Cancel button is pressed.
-
doFinish()
- Performs the actions needed when the Finish button is pressed.
-
doHelp()
- Performs the actions needed when the Help button is pressed.
-
getComponentAt(int)
- Gets the component for the page at the given index.
-
getPageCount()
- Gets the number of pages in the Wizard.
-
getSelectedIndex()
- Returns the zero-relative index of the currently selected page.
-
goNext()
- Go to the next page.
-
goPrevious()
- Go to the previous page.
-
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)
- Sets the page to show when goNext is called.
-
setNextPageIndex(int)
- Sets the index of the page to show when goNext is called.
-
setPreviousEnabled(boolean)
- Enables or disables the Previous button.
-
setPreviousPage(Component)
- Sets the page to show when goPrevious is called.
-
setPreviousPageIndex(int)
- Sets the index of the page to show when goPrevious is called.
-
updateButtonsState()
- Sets a default status for the Previous, Next and Finish buttons.
doCancel
public abstract void doCancel()
- Performs the actions needed when the Cancel button is pressed.
- See Also:
- doFinish, doHelp
doFinish
public abstract void doFinish()
- Performs the actions needed when the Finish button is pressed.
- See Also:
- doCancel, doHelp
doHelp
public abstract void doHelp()
- Performs the actions needed when the Help button is pressed.
- See Also:
- doFinish, doCancel
getComponentAt
public abstract java.awt.Component getComponentAt(int index)
- Gets the component for the page at the given index.
- Parameters:
- index - the zero-relative page index
- Returns:
- returns the component associated with the page
- Throws: ArrayIndexOutOfBoundsException
- if the index is invalid
getPageCount
public abstract int getPageCount()
- Gets the number of pages in the Wizard.
- Returns:
- the number of pages currently in the Wizard
getSelectedIndex
public abstract int getSelectedIndex()
- Returns the zero-relative index of the currently selected page.
- Returns:
- the currently selected page or -1 if none are shown
goNext
public abstract void goNext()
- Go to the next page.
If a page has been selected with setNextPage it will be used.
If a page index has been selected with setNextPageIndex it will be
used unless a page has been specified. The chain information will be
reset.
- See Also:
- goPrevious, setNextPage, setNextPageIndex
goPrevious
public abstract void goPrevious()
- Go to the previous page.
If a page has been selected with setPreviousPage it will be used.
If a page index has been selected with setPreviousPageIndex it will be
used unless a page has been specified. The chain information will be
reset.
- See Also:
- goNext, setPreviousPage, setPreviousPageIndex
setCancelEnabled
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
setFinishEnabled
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
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
setNextEnabled
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
setNextPage
public abstract void setNextPage(Component comp)
- Sets the page to show when goNext is called.
- See Also:
- setPreviousPageIndex, goNext, WizardController, SimpleWizardController
setNextPageIndex
public abstract void setNextPageIndex(int index)
- Sets the index of the page to show when goNext is called.
- Parameters:
- index - the zero-relative page index
- See Also:
- setPreviousPageIndex, goNext, WizardController, SimpleWizardController
setPreviousEnabled
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
setPreviousPage
public abstract void setPreviousPage(Component comp)
- Sets the page to show when goPrevious is called.
- See Also:
- setNextPageIndex, goPrevious, WizardController, SimpleWizardController
setPreviousPageIndex
public abstract void setPreviousPageIndex(int index)
- Sets the index of the page to show when goPrevious is called.
- Parameters:
- index - the zero-relative page index
- See Also:
- setNextPageIndex, goPrevious, WizardController, SimpleWizardController
updateButtonsState
public abstract void updateButtonsState()
- Sets a default status for the Previous, Next and Finish buttons.
- See Also:
- setPreviousEnabled, setNextEnabled, setFinishEnabled, setCancelEnabled, setHelpEnabled
All Packages Class Hierarchy This Package Previous Next Index