| com.xoetrope.swing.wizard.XWizard
All known Subclasses: com.xoetrope.svgscanner.wizard.BindingWizard,
| XWizard | | public class XWizard extends XDialog implements ActionListener(Code) | |
The XWizard class manages the display and navigation actions of a wizard dialog.
Wizards consist of multiple pages for the capture of user input, which upon
completion paramaterize a task. The wizard can be dynamic, displaying a
varying number of pages in response to user inputs and selections.
The styles available are:
wizard - for the card, user and nav panels
wizard/help - for the left hand help panel
Copyright (c) Xoetrope Ltd., 2001-2006, This software is licensed under
the GNU Public License (GPL), please see license.txt for more details. If
you make commercial use of this software you must purchase a commercial
license from Xoetrope.
$Revision: 1.2 $
|
| Constructor Summary | |
| public | XWizard(XProject project, String[] pages)
| | public | XWizard(XProject project, String[] pages, boolean showHelp)
|
| cancelButton | | protected XButton cancelButton(Code) | | |
| finishButton | | protected XButton finishButton(Code) | | |
| hasError | | protected boolean hasError(Code) | | |
| nextButton | | protected XButton nextButton(Code) | | |
| prevButton | | protected XButton prevButton(Code) | | |
| XWizard | | public XWizard(XProject project, String[] pages)(Code) | | Creates a new instance of XWizard
Parameters:
project - the owner project
Parameters:
pages - an array of page names |
| XWizard | | public XWizard(XProject project, String[] pages, boolean showHelp)(Code) | | Creates a new instance of XWizard
Parameters:
project - the owner project
Parameters:
pages - an array of page names
Parameters:
showHelp - true to show help texts for each page |
| actionPerformed | | public void actionPerformed(ActionEvent ae)(Code) | | Respond to button clicks
Parameters:
ae - the action event contaion details of the click |
| addPanel | | public void addPanel(String panelName, Container panel)(Code) | | Show the help text for a given wizard panel
Parameters:
panelName - the wizard panel name |
| canFinish | | public boolean canFinish()(Code) | | Has the wizard captured enough input to complete?
true if the wizard can finish |
| finishProcessing | | public boolean finishProcessing()(Code) | | Finish processing and cleanup any resource usages
true if the cleanup is successful |
| finished | | public void finished()(Code) | | The wizard is complete, do any post creation action now
|
| getProperty | | public Object getProperty(String key)(Code) | | Get a wizard setting
Parameters:
key - the value key the value |
| getTemplateResources | | protected String[] getTemplateResources()(Code) | | |
| initProcessing | | public boolean initProcessing()(Code) | | Start processing and prepare for any new resources and/or setup the
resources needed to complete the wizard
true if the initialization is successful |
| loadPages | | protected void loadPages(String[] pageNames)(Code) | | Load the pages that comprise the wizard
Parameters:
pageNames - an array of page names |
| processResources | | public int processResources()(Code) | | Process the resources
zero if processing is sucessful or a positive integer if processing is completed, but with warnings, and a negative value if an error occursthat prevents complete processing |
| setBounds | | public void setBounds(int x, int y, int w, int h)(Code) | | Moves and resizes this component. The new location of the top-left
corner is specified by x and y, and the
new size is specified by width and height.
Sets the size of the help panel, if any to one quarter of the width
Parameters:
x - the new x-coordinate of this component
Parameters:
y - the new y-coordinate of this component
Parameters:
width - the new width of this component
Parameters:
height - the new height of this component
See Also: XWizard.getBounds
See Also: XWizard.setLocation(int,int)
See Also: XWizard.setLocation(Point)
See Also: XWizard.setSize(int,int)
See Also: XWizard.setSize(Dimension) |
| setErrorMessage | | public void setErrorMessage(String msg)(Code) | | Display an error
Parameters:
msg - the message, or null to clear the error |
| setProperty | | public void setProperty(String key, Object value)(Code) | | Save a setting
Parameters:
key - the lookup key
Parameters:
value - the value to store |
| showNextWizardPage | | protected void showNextWizardPage()(Code) | | Show the next page in the wizard
|
| showPanel | | protected void showPanel(String panelName)(Code) | | Show the help text for a given wizard panel
Parameters:
panelName - the wizard panel name |
| showPreviousWizardPage | | protected void showPreviousWizardPage()(Code) | | Show the previous page in the wizard
Parameters:
panelName - the wizard panel name |
| updateState | | protected void updateState()(Code) | | Update the components that depend on the page selection s
|
|
|