Class Wizard

java.lang.Object
com.reportmill.wizard.Wizard
Direct Known Subclasses:
FormsBasic, GraphsBar, TablesBasic

public class Wizard extends Object
This class manages a specific wizard, like "Form 1040EZ" or "Table with Groupings"
  • Constructor Details

    • Wizard

      public Wizard()
      Creates a new wizard for the given name.
  • Method Details

    • getWizard

      public static Wizard getWizard(String aName, String aCategory, WizardPanel aWizardPanel)
      Returns an instance of the wizard for the given category and name.
    • getName

      public String getName()
      Returns the name for this wizard.
    • setName

      public void setName(String aName)
      Sets the name for this wizard.
    • getCategory

      public String getCategory()
      Returns the category name for this wizard.
    • setCategory

      public void setCategory(String aName)
      Sets the category name for this wizard.
    • getPrettyName

      public String getPrettyName()
      Returns the name for this wizard.
    • getDescription

      public String getDescription()
      Returns the description for this wizard.
    • getThumbnailImage

      public Icon getThumbnailImage()
      Returns the image for this wizard.
    • getPanelCount

      public int getPanelCount()
      Returns the number of screens in this Wizard.
    • getScreen

      public WizardScreen getScreen(int anIndex)
      Returns the specific wizard screen at the given index.
    • addScreen

      public void addScreen(WizardScreen aWS)
      Adds a wizard screen to this wizard.
    • removeScreen

      public void removeScreen(WizardScreen aWS)
      Removes a wizard screen from this wizard.
    • getPanel

      public RJPanel getPanel(int anIndex)
      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

      public RJPanel 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

      public RMDataSource getDataSource()
      Returns the datasource for this wizard's wizard panel's document's datasource.
    • getDataSourceDefault

      public RMDataSource getDataSourceDefault()
      Returns the default datasource to be used when document doesn't have one.
    • getListKey

      public String getListKey()
      Returns the list key for this wizard.
    • setListKey

      public void setListKey(String aKey)
      Sets the list key for this wizard.
    • resetUI

      public void resetUI()
      Updates UI.
    • respondUI

      public void respondUI(Object anObj)
      Responds to UI.
    • finish

      public boolean finish()
      Does finish.
    • prepareFinishShapes

      protected void prepareFinishShapes()
      Does initialization prior to get finish shapes.
    • getFinishShapes

      protected RMShape[] getFinishShapes()
      Returns an array of finish shapes.