org.patterncoder.wizard
Class WizardPanelDescriptor

java.lang.Object
  extended by org.patterncoder.wizard.WizardPanelDescriptor

public class WizardPanelDescriptor
extends java.lang.Object

This class is used to hold details of a stage within the wizard. Details include the Component which is displayed and the next and previous steps.


Constructor Summary
WizardPanelDescriptor(java.lang.Object panelID, java.lang.Object next, java.lang.Object previous, java.lang.String step, java.lang.String desc, AbstractWizardPanel panel)
          Creates a new instance of WizardPanelDescriptor, giving variable values for each of the required variables of this class.
 
Method Summary
 void closingPanel()
           
 void displayingPanel()
           
 java.lang.Object getNextPanelID()
          Returns the identity oblect value of the next step inline to be displayed.
 javax.swing.JPanel getPanel()
          Returns the component registered.
 java.lang.Object getPanelID()
          returns the id value of this descriptor.
 java.lang.Object getPreviousPanelID()
          Returns the identity object value of the previous step inline to be displayed.
 java.lang.String getStep()
          Returns the step string supplied when created.
 java.lang.String getStepDesc()
          Returns the step description.
 int getStepNumber()
          Returns an integer value representing the position of this panel in the wizard process.
 void setNextPanelID(java.lang.Object id)
          Sets the next Panel id.
 void setPreviousID(java.lang.Object id)
          Sets the previous panel id.
 void setStepNum(int num)
          Sets step number value of this descriptor.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WizardPanelDescriptor

public WizardPanelDescriptor(java.lang.Object panelID,
                             java.lang.Object next,
                             java.lang.Object previous,
                             java.lang.String step,
                             java.lang.String desc,
                             AbstractWizardPanel panel)
Creates a new instance of WizardPanelDescriptor, giving variable values for each of the required variables of this class.

Parameters:
panelID - the id used to identify this panel.
next - the id of the panel next inline in the wizard.
previous - the id of the panel previously inline in the wizard.
step - the step name, displayed in bold at the top of the wizard.
desc - the description of the stage of the wizard, displayed at the top of the wizard.
panel - the component which is displayed.
Method Detail

getStep

public java.lang.String getStep()
Returns the step string supplied when created. The step value is displayed at the top of the wizard panel, as title to te step.

Returns:
the wizard step string.

getStepDesc

public java.lang.String getStepDesc()
Returns the step description. The step description is displayed at the top of the wizard to provide the user with a small amount of instruction for the step.

Returns:
the step description.

getPanel

public javax.swing.JPanel getPanel()
Returns the component registered.

Returns:
the JPanel component of this wizard step.

getPanelID

public java.lang.Object getPanelID()
returns the id value of this descriptor.

Returns:
the step id.

getNextPanelID

public java.lang.Object getNextPanelID()
Returns the identity oblect value of the next step inline to be displayed.

Returns:
the next panel id.

getPreviousPanelID

public java.lang.Object getPreviousPanelID()
Returns the identity object value of the previous step inline to be displayed.

Returns:
the previous step id.

setNextPanelID

public void setNextPanelID(java.lang.Object id)
Sets the next Panel id.

Parameters:
id - the panel id.

setPreviousID

public void setPreviousID(java.lang.Object id)
Sets the previous panel id.

Parameters:
id - the panel id.

getStepNumber

public int getStepNumber()
Returns an integer value representing the position of this panel in the wizard process. Used to display the step number at the top of the wizard.

Returns:
the step number.

setStepNum

public void setStepNum(int num)
Sets step number value of this descriptor.

Parameters:
num - the step number value.

closingPanel

public void closingPanel()
                  throws PatternCoderException
Throws:
PatternCoderException

displayingPanel

public void displayingPanel()
                     throws PatternCoderException
Throws:
PatternCoderException