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 Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
addScreen
(WizardScreen aWS) Adds a wizard screen to this wizard.boolean
finish()
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.int
Returns the max selected panel index.getName()
Returns the name for this wizard.getPanel
(int anIndex) Returns the specific panel at the given index.int
Returns 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.int
Returns the currently selected screen index.Returns the image for this wizard.static Wizard
getWizard
(String aName, String aCategory, WizardPanel aWizardPanel) Returns an instance of the wizard for the given category and name.protected void
Does initialization prior to get finish shapes.void
removeScreen
(WizardScreen aWS) Removes a wizard screen from this wizard.void
resetUI()
Updates UI.void
Responds to UI.void
setCategory
(String aName) Sets the category name for this wizard.void
setListKey
(String aKey) Sets the list key for this wizard.void
setMaxSelectedPanelIndex
(int anIndex) Sets the max selected panel index.void
Sets the name for this wizard.void
setSelectedPanelIndex
(int anIndex) Sets the currently selected screen index.
-
Constructor Details
-
Wizard
public Wizard()Creates a new wizard for the given name.
-
-
Method Details
-
getWizard
Returns an instance of the wizard for the given category and name. -
getName
Returns the name for this wizard. -
setName
Sets the name for this wizard. -
getCategory
Returns the category name for this wizard. -
setCategory
Sets the category name for this wizard. -
getPrettyName
Returns the name for this wizard. -
getDescription
Returns the description for this wizard. -
getThumbnailImage
Returns the image for this wizard. -
getPanelCount
public int getPanelCount()Returns the number of screens in this Wizard. -
getScreen
Returns the specific wizard screen at the given index. -
addScreen
Adds a wizard screen to this wizard. -
removeScreen
Removes a wizard screen from this wizard. -
getPanel
Returns the specific panel at the given index. -
getSelectedPanelIndex
public int getSelectedPanelIndex()Returns the currently selected screen index. -
setSelectedPanelIndex
public void setSelectedPanelIndex(int anIndex) Sets the currently selected screen index. -
getSelectedPanel
Returns the currently selected screen. -
getMaxSelectedPanelIndex
public int getMaxSelectedPanelIndex()Returns the max selected panel index. -
setMaxSelectedPanelIndex
public void setMaxSelectedPanelIndex(int anIndex) Sets the max selected panel index. -
getDataSource
Returns the datasource for this wizard's wizard panel's document's datasource. -
getDataSourceDefault
Returns the default datasource to be used when document doesn't have one. -
getListKey
Returns the list key for this wizard. -
setListKey
Sets the list key for this wizard. -
resetUI
public void resetUI()Updates UI. -
respondUI
Responds to UI. -
finish
public boolean finish()Does finish. -
prepareFinishShapes
protected void prepareFinishShapes()Does initialization prior to get finish shapes. -
getFinishShapes
Returns an array of finish shapes.
-