Package com.reportmill.wizard
Class Wizard
java.lang.Object
com.reportmill.wizard.Wizard
- Direct Known Subclasses:
- FormsBasic,- GraphsBar,- TablesBasic
This class manages a specific wizard, like "Form 1040EZ" or "Table with Groupings"
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionvoidaddScreen(WizardScreen aWS) Adds a wizard screen to this wizard.booleanfinish()Does finish.Returns the category name for this wizard.Returns the datasource for this wizard's wizard panel's document's datasource.Returns the default datasource to be used when document doesn't have one.Returns the description for this wizard.protected RMShape[]Returns an array of finish shapes.Returns the list key for this wizard.intReturns the max selected panel index.getName()Returns the name for this wizard.getPanel(int anIndex) Returns the specific panel at the given index.intReturns the number of screens in this Wizard.Returns the name for this wizard.getScreen(int anIndex) Returns the specific wizard screen at the given index.Returns the currently selected screen.intReturns the currently selected screen index.Returns the image for this wizard.static WizardgetWizard(String aName, String aCategory, WizardPanel aWizardPanel) Returns an instance of the wizard for the given category and name.protected voidDoes initialization prior to get finish shapes.voidremoveScreen(WizardScreen aWS) Removes a wizard screen from this wizard.voidresetUI()Updates UI.voidResponds to UI.voidsetCategory(String aName) Sets the category name for this wizard.voidsetListKey(String aKey) Sets the list key for this wizard.voidsetMaxSelectedPanelIndex(int anIndex) Sets the max selected panel index.voidSets the name for this wizard.voidsetSelectedPanelIndex(int anIndex) Sets the currently selected screen index.
- 
Constructor Details- 
Wizardpublic Wizard()Creates a new wizard for the given name.
 
- 
- 
Method Details- 
getWizardReturns an instance of the wizard for the given category and name.
- 
getNameReturns the name for this wizard.
- 
setNameSets the name for this wizard.
- 
getCategoryReturns the category name for this wizard.
- 
setCategorySets the category name for this wizard.
- 
getPrettyNameReturns the name for this wizard.
- 
getDescriptionReturns the description for this wizard.
- 
getThumbnailImageReturns the image for this wizard.
- 
getPanelCountpublic int getPanelCount()Returns the number of screens in this Wizard.
- 
getScreenReturns the specific wizard screen at the given index.
- 
addScreenAdds a wizard screen to this wizard.
- 
removeScreenRemoves a wizard screen from this wizard.
- 
getPanelReturns the specific panel at the given index.
- 
getSelectedPanelIndexpublic int getSelectedPanelIndex()Returns the currently selected screen index.
- 
setSelectedPanelIndexpublic void setSelectedPanelIndex(int anIndex) Sets the currently selected screen index.
- 
getSelectedPanelReturns the currently selected screen.
- 
getMaxSelectedPanelIndexpublic int getMaxSelectedPanelIndex()Returns the max selected panel index.
- 
setMaxSelectedPanelIndexpublic void setMaxSelectedPanelIndex(int anIndex) Sets the max selected panel index.
- 
getDataSourceReturns the datasource for this wizard's wizard panel's document's datasource.
- 
getDataSourceDefaultReturns the default datasource to be used when document doesn't have one.
- 
getListKeyReturns the list key for this wizard.
- 
setListKeySets the list key for this wizard.
- 
resetUIpublic void resetUI()Updates UI.
- 
respondUIResponds to UI.
- 
finishpublic boolean finish()Does finish.
- 
prepareFinishShapesprotected void prepareFinishShapes()Does initialization prior to get finish shapes.
- 
getFinishShapesReturns an array of finish shapes.
 
-