All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.ibm.as400.ui.framework.java.WizardManager

java.lang.Object
   |
   +----com.ibm.as400.ui.framework.java.WizardManager

public class WizardManager
extends Object
implements PaneManager, WindowManager
Creates a wizard panel containing a series of windows which guide the user through a particular task. Each window consists of a panel defined using the Panel Definition Markup Language (PDML). The wizard may be either a standalone window or a modal dialog.

WizardManager performs the following processing on behalf of the application:

The total size of the wizard is a function of the size of the largest wizard panel.

To locate a wizard definition, WizardManager needs three pieces of information:

The framework first searches the specified location for a file with a name matching the wizard name, and an extension of .pdml.ser. If the serialized wizard definition is not found, an attempt will be made to load a ResourceBundle and a PDML file which correspond to the specified resource name. If the resources cannot be located a DisplayManagerException will be thrown.

The default path through the wizard panels is sequential. Applications may dynamically customize the order in which panels are displayed. This is done by defining a class that implements the WizardStateMachine interface, and passing an instance of this class to the WizardManager.

If desired, a "task list" may be defined in the wizard definition. The task list will appear on the left-hand side of the wizard window, and will show the user's progress through the wizard by "checking off" each task as it is performed.

Examples

Assume that the wizard MyWizard is defined in the file TestPanels.pdml, and that a properties file TestPanels.properties is associated with the wizard definition. Both files reside in the directory com/ourCompany/ourPackage, which is accessible from a directory defined in the classpath, or from a ZIP or JAR file defined in the classpath. The following code creates the wizard and displays it:

 import com.ibm.as400.ui.framework.java.*;
  
 // Create the wizard manager. Parameters:
 // 1. Resource name of the wizard definition
 // 2. Name of wizard
 // 3. List of DataBeans omitted
 // 5. Wizard navigation defaulted to sequential
  
 WizardManager wm = null;
 try {
 wm = new WizardManager("com.ourCompany.ourPackage.TestPanels",
                        "MyWizard",
                        null,
                        null);
 }
 catch (DisplayManagerException e) {
     e.displayUserMessage(null);
     System.exit(-1);
 }
  
 // Display the wizard
 wm.setVisible(true);
 
Once the DataBeans that supply data to the wizard panels have been implemented and the attributes have been identified in the PDML, the following code may be used to construct a fully-functioning wizard:

 import com.ibm.as400.ui.framework.java.*;
 import java.awt.Frame;
  
 // Instantiate the objects which supply data to the wizard
 TestDataBean1 db1 = new TestDataBean1();
 TestDataBean2 db2 = new TestDataBean2();
  
 // Initialize the objects
 db1.load();
 db2.load();
  
 // Set up to pass the objects to the UI framework
 DataBean[] dataBeans = { db1, db2 };
  
 // Create an application-defined state machine for
 // customized navigation through the panels
 MyStateMachine sm = new MyStateMachine();
  
 // Create the wizard manager. Parameters:
 // 1. Resource name of the wizard definition
 // 2. Name of wizard
 // 3. List of DataBeans
 // 4. Owner frame window
 // 5. Application-defined state machine
  
 Frame owner;
 ...
 WizardManager wm = null;
 try {
 wm = new WizardManager("com.ourCompany.ourPackage.TestPanels",
                        "MyWizard",
                        dataBeans,
                        owner,
                        sm);
 }
 catch (DisplayManagerException e) {
 e.displayUserMessage(null);
 System.exit(-1);
 }
  
 // Display the wizard
 wm.setVisible(true);
 

Command Line Interface

The command line interface may be used to display newly-defined wizards, or to serialize PDML wizard definitions.
 java com.ibm.as400.ui.framework.java.WizardManager
     [-serialize]
     [-locale <language code>_<country code>_<variant>]
     <resource name>
     <wizard name>
 
Options:
-serialize
Parses the PDML wizard definition and creates a serialized version of the wizard. The name of the serialized file will match the wizard name, and the file extension will be .pdml.ser. If this option is specified the wizard will not be displayed on the screen.

-locale <language code>_<country code>_<variant>
Identifies the locale which should be used to locate the wizard definition. The locale string should consist of a two-letter lowercase ISO Language Code, a two-letter uppercase ISO country code, and an optional variant string, each delimited by an underscore ("_") character. If this parameter is omitted the default locale will be used. If resources for the default locale cannot be found, an attempt will be made to use the base resources for the wizard.

<resource name>
The fully-qualified resource name of the PDML document/resource bundle combination which defines the wizard specification.

<wizard name>
The name of the wizard, as specified on the WIZARD tag in the PDML document.

Examples:

Test a base sample wizard:

java com.ibm.as400.ui.framework.java.WizardManager com.ourCompany.ourPackage.TestPanels MyWizard

Serialize the base wizard:

java com.ibm.as400.ui.framework.java.WizardManager -serialize com.ourCompany.ourPackage.TestPanels MyWizard

Test the UK version:

java com.ibm.as400.ui.framework.java.WizardManager -locale en_UK com.ourCompany.ourPackage.TestPanels MyWizard

Serialize the UK version:

java com.ibm.as400.ui.framework.java.WizardManager -serialize -locale en_UK com.ourCompany.ourPackage.TestPanels MyWizard

See Also:
DisplayManagerException, WizardStateMachine, PanelManager

Variable Index

 o BACK_BUTTON
Used to identify the Back button on the wizard panel.
 o CANCEL_BUTTON
Used to identify the Cancel button on the wizard panel.
 o FINISH_BUTTON
Used to identify the Finish button on the wizard panel.
 o HELP_BUTTON
Used to identify the Help button on the wizard panel.
 o NEXT_BUTTON
Used to identify the Next button on the wizard panel.

Constructor Index

 o WizardManager(String, Locale, String)
Constructs a WizardManager object for the specified wizard, and then serializes the wizard definition.
 o WizardManager(String, Locale, String, DataBean[], Container, WizardStateMachine)
Constructs a WizardManager for the specified wizard, using the specified container.
 o WizardManager(String, Locale, String, DataBean[], Container, WizardStateMachine, boolean)
Constructs a WizardManager for the specified wizard, using the specified container.
 o WizardManager(String, Locale, String, DataBean[], Frame, WizardStateMachine)
Constructs a WizardManager object for the specified wizard.
 o WizardManager(String, Locale, String, DataBean[], Frame, WizardStateMachine, boolean)
Constructs a WizardManager object for the specified wizard.
 o WizardManager(String, Locale, String, DataBean[], WizardStateMachine)
Constructs a WizardManager object for the specified wizard.
 o WizardManager(String, Locale, String, DataBean[], WizardStateMachine, boolean)
Constructs a WizardManager object for the specified wizard.
 o WizardManager(String, String, DataBean[], Container, WizardStateMachine)
Constructs a WizardManager for the specified wizard, using the specified container.
 o WizardManager(String, String, DataBean[], Container, WizardStateMachine, boolean)
Constructs a WizardManager for the specified wizard, using the specified container.
 o WizardManager(String, String, DataBean[], Frame, WizardStateMachine)
Constructs a WizardManager object for the specified wizard.
 o WizardManager(String, String, DataBean[], Frame, WizardStateMachine, boolean)
Constructs a WizardManager object for the specified wizard.
 o WizardManager(String, String, DataBean[], WizardStateMachine)
Constructs a WizardManager object for the specified wizard.
 o WizardManager(String, String, DataBean[], WizardStateMachine, boolean)
Constructs a WizardManager object for the specified wizard.

Method Index

 o activatePanel()
Runs the activation handlers for the currently selected pane.
 o addButtons(int)
Adds the Back, Next, Finish, Cancel or Help buttons to the wizard panel if they have been previously removed.
 o addCancelListener(ActionListener)
Adds an ActionListener which is notified when the user cancels out of a window.
 o addCommitListener(ActionListener)
Adds an ActionListener which is notified when commit processing is complete.
 o addPanel(PanelManager, int, int)
Adds a panel to the wizard managed by the receiver.
 o applyChanges()
Transmits changes to user data to the DataBeans which manage the data.
 o commit(Vector)
Commits the changes to data displayed on the panel.
 o disableButtons(int)
Disables the Back, Next, Finish, Cancel or Help buttons on the wizard panel.
 o enableButtons(int)
Enables the Back, Next, Finish, Cancel or Help buttons on the wizard panel if they have been previously disabled.
 o getAggregateManager()
Returns the owning PaneManager for the receiver.
 o getBackButton()
Returns the wizard's Back button.
 o getCancelButton()
Returns the wizard's Cancel button.
 o getComponent(String)
Returns the requested user interface component.
 o getComponentDescriptor(String)
Returns the JavaComponentDescriptor for the specified user interface component.
 o getDelegateManager(String)
Returns the PaneManager to which the receiver is delegating management of the specified subpane.
 o getExitOnClose()
Determines whether the application exits when this wizard is closed.
 o getFinishButton()
Returns the wizard's Finish button.
 o getFormatter(String)
Returns the data formatter associated with the specified user interface component.
 o getNextButton()
Returns the wizard's Next button.
 o getOwnerManager()
Returns the WindowManager in relation to which the receiver has been set modal, or null if the receiver is not modal relative to another window.
 o getPage(int)
Returns the PanelManager for the specified wizard page.
 o getPage(String)
Returns the PanelManager for the specified wizard page.
 o getPreferredSize()
Gets the preferred size of this wizard.
 o getRootManager()
Returns the root PaneManager for the receiver.
 o getTitle()
Returns the wizard's title.
 o getWindow()
Returns the main wizard window.
 o isVisible()
Determines whether this wizard is visible.
 o loadData()
Called during initialization to load data into the panel.
 o main(String[])
Provides a command line interface to WizardManager.
 o prepareToCommit(Vector)
Request the DataBeans which manage data for the panel to verify that their data is in a consistent state.
 o removeButtons(int)
Removes the Back, Next, Finish, Cancel or Help buttons from the wizard panel.
 o removePanel(int)
Removes a panel from the wizard managed by the receiver.
 o serialize()
Serializes the wizard definition.
 o setAggregateManager(PaneManager)
Sets the owning PaneManager for the receiver.
 o setExitOnClose(boolean)
Controls whether the application exits when the wizard is closed, based on the value of parameter exit.
 o setFormatter(String, DataFormatter, boolean)
Sets the data formatter associated with the specified user interface component.
 o setHelpPath(String)
 o setModalRelativeTo(WindowManager)
Sets the location of the panel being managed relative to a panel managed by the specified WindowManager.
 o setVisible(boolean)
Shows or hides the wizard, depending on the value of parameter show.
 o showPane(String)
Displays the specified pane.

Variables

 o BACK_BUTTON
 public static final int BACK_BUTTON
Used to identify the Back button on the wizard panel.

 o NEXT_BUTTON
 public static final int NEXT_BUTTON
Used to identify the Next button on the wizard panel.

 o FINISH_BUTTON
 public static final int FINISH_BUTTON
Used to identify the Finish button on the wizard panel.

 o CANCEL_BUTTON
 public static final int CANCEL_BUTTON
Used to identify the Cancel button on the wizard panel.

 o HELP_BUTTON
 public static final int HELP_BUTTON
Used to identify the Help button on the wizard panel.

Constructors

 o WizardManager
 public WizardManager(String baseName,
                      String wizardName,
                      DataBean dataBeans[],
                      WizardStateMachine stateMachine) throws DisplayManagerException
Constructs a WizardManager object for the specified wizard. The wizard will be modeless.

The default locale will be used to load the wizard definition.

Parameters:
baseName - the resource name of the PDML document/resource bundle combination which define the wizard specification
wizardName - the name of the wizard, as specified on the WIZARD tag in the PDML document
dataBeans - a list of DataBeans which supply data to the wizard (may be null)
wizardStateMachine - the object that track's the user's path through the wizard panels (may be null)
Throws: DisplayManagerException
if an error was encountered accessing the panel definition
See Also:
DisplayManagerException
 o WizardManager
 public WizardManager(String baseName,
                      String wizardName,
                      DataBean dataBeans[],
                      WizardStateMachine stateMachine,
                      boolean resize) throws DisplayManagerException
Constructs a WizardManager object for the specified wizard. The wizard will be modeless.

The default locale will be used to load the wizard definition.

Parameters:
baseName - the resource name of the PDML document/resource bundle combination which define the wizard specification
wizardName - the name of the wizard, as specified on the WIZARD tag in the PDML document
dataBeans - a list of DataBeans which supply data to the wizard (may be null)
wizardStateMachine - the object that track's the user's path through the wizard panels (may be null)
resize - specifies whether the wizard should be dynamically resizable
Throws: DisplayManagerException
if an error was encountered accessing the panel definition
See Also:
DisplayManagerException
 o WizardManager
 public WizardManager(String baseName,
                      Locale locale,
                      String wizardName,
                      DataBean dataBeans[],
                      WizardStateMachine stateMachine) throws DisplayManagerException
Constructs a WizardManager object for the specified wizard. The wizard will be modeless.

Parameters:
baseName - the resource name of the PDML document/resource bundle combination which define the wizard specification
locale - the desired locale to be used to load the property sheet definition
wizardName - the name of the wizard, as specified on the WIZARD tag in the PDML document
dataBeans - a list of DataBeans which supply data to the wizard (may be null)
wizardStateMachine - the object that track's the user's path through the wizard panels (may be null)
Throws: DisplayManagerException
if an error was encountered accessing the panel definition
See Also:
DisplayManagerException
 o WizardManager
 public WizardManager(String baseName,
                      Locale locale,
                      String wizardName,
                      DataBean dataBeans[],
                      WizardStateMachine stateMachine,
                      boolean resize) throws DisplayManagerException
Constructs a WizardManager object for the specified wizard. The wizard will be modeless.

Parameters:
baseName - the resource name of the PDML document/resource bundle combination which define the wizard specification
locale - the desired locale to be used to load the property sheet definition
wizardName - the name of the wizard, as specified on the WIZARD tag in the PDML document
dataBeans - a list of DataBeans which supply data to the wizard (may be null)
wizardStateMachine - the object that track's the user's path through the wizard panels (may be null)
resize - specifies whether the wizard should be dynamically resizable
Throws: DisplayManagerException
if an error was encountered accessing the panel definition
See Also:
DisplayManagerException
 o WizardManager
 public WizardManager(String baseName,
                      String wizardName,
                      DataBean dataBeans[],
                      Frame owner,
                      WizardStateMachine stateMachine) throws DisplayManagerException
Constructs a WizardManager object for the specified wizard. The wizard will be modal, with the specified Frame as its owner. The application will block on the call to setVisible until the wizard has closed.

The default locale will be used to load the wizard definition.

Parameters:
baseName - the resource name of the PDML document/resource bundle combination which define the wizard specification
wizardName - the name of the wizard, as specified on the WIZARD tag in the PDML document
dataBeans - a list of DataBeans which supply data to the wizard (may be null)
owner - the owning frame
wizardStateMachine - the object that track's the user's path through the wizard panels (may be null)
Throws: DisplayManagerException
if an error was encountered accessing the panel definition
See Also:
DisplayManagerException, setVisible
 o WizardManager
 public WizardManager(String baseName,
                      String wizardName,
                      DataBean dataBeans[],
                      Frame owner,
                      WizardStateMachine stateMachine,
                      boolean resize) throws DisplayManagerException
Constructs a WizardManager object for the specified wizard. The wizard will be modal, with the specified Frame as its owner. The application will block on the call to setVisible until the wizard has closed.

The default locale will be used to load the wizard definition.

Parameters:
baseName - the resource name of the PDML document/resource bundle combination which define the wizard specification
wizardName - the name of the wizard, as specified on the WIZARD tag in the PDML document
dataBeans - a list of DataBeans which supply data to the wizard (may be null)
owner - the owning frame
wizardStateMachine - the object that track's the user's path through the wizard panels (may be null)
resize - specifies whether the wizard should be dynamically resizable
Throws: DisplayManagerException
if an error was encountered accessing the panel definition
See Also:
DisplayManagerException, setVisible
 o WizardManager
 public WizardManager(String baseName,
                      Locale locale,
                      String wizardName,
                      DataBean dataBeans[],
                      Frame owner,
                      WizardStateMachine stateMachine) throws DisplayManagerException
Constructs a WizardManager object for the specified wizard. The wizard will be modal, with the specified Frame as its owner. The application will block on the call to setVisible until the wizard has closed.

Parameters:
baseName - the resource name of the PDML document/resource bundle combination which define the wizard specification
locale - the desired locale to be used to load the wizard definition
wizardName - the name of the wizard, as specified on the WIZARD tag in the PDML document
dataBeans - a list of DataBeans which supply data to the wizard (may be null)
owner - the owning frame
wizardStateMachine - the object that track's the user's path through the wizard panels (may be null)
Throws: DisplayManagerException
if an error was encountered accessing the panel definition
See Also:
DisplayManagerException, setVisible
 o WizardManager
 public WizardManager(String baseName,
                      Locale locale,
                      String wizardName,
                      DataBean dataBeans[],
                      Frame owner,
                      WizardStateMachine stateMachine,
                      boolean resize) throws DisplayManagerException
Constructs a WizardManager object for the specified wizard. The wizard will be modal, with the specified Frame as its owner. The application will block on the call to setVisible until the wizard has closed.

Parameters:
baseName - the resource name of the PDML document/resource bundle combination which define the wizard specification
locale - the desired locale to be used to load the wizard definition
wizardName - the name of the wizard, as specified on the WIZARD tag in the PDML document
dataBeans - a list of DataBeans which supply data to the wizard (may be null)
owner - the owning frame
wizardStateMachine - the object that track's the user's path through the wizard panels (may be null)
resize - specifies whether the wizard should be dynamically resizable
Throws: DisplayManagerException
if an error was encountered accessing the panel definition
See Also:
DisplayManagerException, setVisible
 o WizardManager
 public WizardManager(String baseName,
                      String wizardName,
                      DataBean dataBeans[],
                      Container container,
                      WizardStateMachine stateMachine) throws DisplayManagerException
Constructs a WizardManager for the specified wizard, using the specified container. This constructor allows the application to supply its own container, rather than relying on this object to create a container of the appropriate type.

The default locale will be used to load the wizard definition.

Parameters:
baseName - the resource name of the PDML document/resource bundle combination which defines the wizard specification
panelName - the name of the panel, as specified on the WIZARD tag in the PDML
dataBeans - a list of DataBeans which supply data to the wizard (may be null)
container - the application's container
wizardStateMachine - the object that track's the user's path through the wizard panels (may be null)
Throws: DisplayManagerException
if an error was encountered accessing the panel definition
See Also:
DisplayManagerException
 o WizardManager
 public WizardManager(String baseName,
                      String wizardName,
                      DataBean dataBeans[],
                      Container container,
                      WizardStateMachine stateMachine,
                      boolean resize) throws DisplayManagerException
Constructs a WizardManager for the specified wizard, using the specified container. This constructor allows the application to supply its own container, rather than relying on this object to create a container of the appropriate type.

The default locale will be used to load the wizard definition.

Parameters:
baseName - the resource name of the PDML document/resource bundle combination which defines the wizard specification
panelName - the name of the panel, as specified on the WIZARD tag in the PDML
dataBeans - a list of DataBeans which supply data to the wizard (may be null)
container - the application's container
wizardStateMachine - the object that track's the user's path through the wizard panels (may be null)
resize - specifies whether the wizard should be dynamically resizable
Throws: DisplayManagerException
if an error was encountered accessing the panel definition
See Also:
DisplayManagerException
 o WizardManager
 public WizardManager(String baseName,
                      Locale locale,
                      String wizardName,
                      DataBean dataBeans[],
                      Container container,
                      WizardStateMachine stateMachine) throws DisplayManagerException
Constructs a WizardManager for the specified wizard, using the specified container. This constructor allows the application to supply its own container, rather than relying on this object to create a container of the appropriate type.

Parameters:
baseName - the resource name of the PDML document/resource bundle combination which defines the wizard specification
locale - the desired locale to be used to load the panel definition
panelName - the name of the panel, as specified on the WIZARD tag in the PDML
dataBeans - a list of DataBeans which supply data to the wizard (may be null)
container - the application's container
wizardStateMachine - the object that track's the user's path through the wizard panels (may be null)
Throws: DisplayManagerException
if an error was encountered accessing the panel definition
See Also:
DisplayManagerException
 o WizardManager
 public WizardManager(String baseName,
                      Locale locale,
                      String wizardName,
                      DataBean dataBeans[],
                      Container container,
                      WizardStateMachine stateMachine,
                      boolean resize) throws DisplayManagerException
Constructs a WizardManager for the specified wizard, using the specified container. This constructor allows the application to supply its own container, rather than relying on this object to create a container of the appropriate type.

Parameters:
baseName - the resource name of the PDML document/resource bundle combination which defines the wizard specification
locale - the desired locale to be used to load the panel definition
panelName - the name of the panel, as specified on the WIZARD tag in the PDML
dataBeans - a list of DataBeans which supply data to the wizard (may be null)
container - the application's container
wizardStateMachine - the object that track's the user's path through the wizard panels (may be null)
resize - specifies whether the wizard should be dynamically resizable
Throws: DisplayManagerException
if an error was encountered accessing the panel definition
See Also:
DisplayManagerException
 o WizardManager
 public WizardManager(String baseName,
                      Locale locale,
                      String wizardName) throws DisplayManagerException
Constructs a WizardManager object for the specified wizard, and then serializes the wizard definition. This constructor cannot be used to display the wizard.

If a null locale is specified, the default locale will be used to load the wizard definition. If resources for the default locale cannot be found, an attempt will be made to use the base resources for the wizard.

Parameters:
baseName - the resource name of the PDML document/resource bundle combination which define the wizard specification
locale - the desired locale to be used to load the wizard definition (may be null)
wizardName - the name of the wizard, as specified on the WIZARD tag in the PDML
Throws: DisplayManagerException
if an error was encountered accessing or serializing the panel definition
See Also:
serialize

Methods

 o main
 public static void main(String args[])
Provides a command line interface to WizardManager. See the class description.

 o serialize
 public void serialize() throws IOException
Serializes the wizard definition. The filename of the serialized file will be of the form
 <wizard name>_<locale string>.pdml.ser
 
where <wizard name> is the name of the wizard as specified on the WIZARD tag in the PDML, and <locale string> consists of the ISO Language Code, ISO Country Code, and optional variant codes, each delimited by an underscore ("_") character.

Throws: IOException
if serialized file cannot be written
 o getBackButton
 public JButton getBackButton()
Returns the wizard's Back button.

Returns:
an instance of JButton which represents this wizard's Back button
 o getNextButton
 public JButton getNextButton()
Returns the wizard's Next button.

Returns:
an instance of JButton which represents this wizard's Next button
 o getCancelButton
 public JButton getCancelButton()
Returns the wizard's Cancel button.

Returns:
an instance of JButton which represents this wizard's Cancel button
 o getFinishButton
 public JButton getFinishButton()
Returns the wizard's Finish button.

Returns:
an instance of JButton which represents this wizard's Finish button
 o setExitOnClose
 public void setExitOnClose(boolean exit)
Controls whether the application exits when the wizard is closed, based on the value of parameter exit. The default value is false.

This method should be called before the wizard is made visible.

Parameters:
exit - If true, exit the application; otherwise, just hide the panel.
See Also:
getExitOnClose
 o getExitOnClose
 public boolean getExitOnClose()
Determines whether the application exits when this wizard is closed.

Returns:
true if the application will be exited; false otherwise.
See Also:
setExitOnClose
 o setVisible
 public void setVisible(boolean show)
Shows or hides the wizard, depending on the value of parameter show. If an owner frame was specified on the constructor indicating that the wizard is modal, the application will block on the call to setVisible until the wizard has closed.

Parameters:
show - If true, shows the wizard; otherwise, hides the wizard.
See Also:
isVisible
 o isVisible
 public boolean isVisible()
Determines whether this wizard is visible. The wizard is initially invisible.

Returns:
true if the wizard is visible; false otherwise.
See Also:
setVisible
 o getPreferredSize
 public Dimension getPreferredSize()
Gets the preferred size of this wizard.

Returns:
A dimension object indicating this wizard's preferred size.
 o setFormatter
 public void setFormatter(String componentName,
                          DataFormatter formatter,
                          boolean required)
Sets the data formatter associated with the specified user interface component. The name of the component must be of the form
<panel_name>.<component_name>
where panel_name is the name of the panel containing the desired component, and component_name is the name of the component, as defined in the PDML for the panel definition.

Parameters:
componentName - the fully-qualified name of the user interface component
formatter - a reference to the data formatter to be associated with the component
required - whether a value is required to be entered
See Also:
DataFormatter
 o getFormatter
 public DataFormatter getFormatter(String componentName)
Returns the data formatter associated with the specified user interface component. The name of the component must be of the form
<panel_name>.<component_name>
where panel_name is the name of the panel containing the desired component, and component_name is the name of the component, as defined in the PDML for the panel definition.

Parameters:
componentName - the fully-qualified name of the user interface component
Returns:
the associated DataFormatter, or null if the component cannot be found
See Also:
DataFormatter
 o getTitle
 public String getTitle()
Returns the wizard's title. This method has no implementation, since the wizard's title is dependent on which page is currently displayed.

See Also:
PaneManager
 o loadData
 public void loadData()
Called during initialization to load data into the panel. This method has no implementation, since WizardManager doesn't participate in aggregates.

See Also:
PaneManager
 o activatePanel
 public void activatePanel()
Runs the activation handlers for the currently selected pane. This method has no implementation, since WizardManager isn't managed as a subpanel.

See Also:
PaneManager
 o showPane
 public void showPane(String paneName)
Displays the specified pane. This method has no implementation, since WizardManager isn't managed as a subpanel.

See Also:
PaneManager
 o getComponent
 public Component getComponent(String componentName)
Returns the requested user interface component. The name of the component must be of the form
<panel_name>.<component_name>
where panel_name is the name of the panel containing the desired component, and component_name is the name of the component, as defined in the PDML for the panel definition.

Parameters:
componentName - the fully-qualified name of the user interface component
Returns:
the desired Component, or null if the component cannot be found
See Also:
PaneManager
 o getComponentDescriptor
 public JavaComponentDescriptor getComponentDescriptor(String componentName)
Returns the JavaComponentDescriptor for the specified user interface component. The name of the component must be of the form
<panel_name>.<component_name>
where panel_name is the name of the panel containing the desired component, and component_name is the name of the component, as defined in the PDML for the panel definition.

Parameters:
componentName - the fully-qualified name of the user interface component
Returns:
the desired JavaComponentDescriptor, or null if the descriptor cannot be found
See Also:
PaneManager
 o getDelegateManager
 public PaneManager getDelegateManager(String paneName)
Returns the PaneManager to which the receiver is delegating management of the specified subpane.

Parameters:
paneName - the name of the pane as specified in the PDML definition
Returns:
the desired PaneManager, or null if the object cannot be found
See Also:
PaneManager
 o setAggregateManager
 public void setAggregateManager(PaneManager mgr)
Sets the owning PaneManager for the receiver. This method has no implementation, since WizardManager doesn't participate in aggregates.

See Also:
PaneManager
 o getAggregateManager
 public PaneManager getAggregateManager()
Returns the owning PaneManager for the receiver.

Returns:
the PaneManager with which the receiver is associated when this object is participating in an aggregate user interface, or null if this PaneManager is not part of an aggregate.
See Also:
PaneManager
 o getRootManager
 public PaneManager getRootManager()
Returns the root PaneManager for the receiver.

Returns:
the PaneManager for the main panel that is managing the aggregate user interface, or null if this PaneManager is not part of an aggregate.
See Also:
PaneManager
 o applyChanges
 public void applyChanges()
Transmits changes to user data to the DataBeans which manage the data. This method has no implementation, since WizardManager doesn't participate in aggregates.

See Also:
PaneManager
 o prepareToCommit
 public void prepareToCommit(Vector preparedDataBeans)
Request the DataBeans which manage data for the panel to verify that their data is in a consistent state. This method has no implementation, since WizardManager doesn't participate in aggregates.

See Also:
PaneManager
 o commit
 public void commit(Vector committedDataBeans)
Commits the changes to data displayed on the panel. This method has no implementation, since WizardManager doesn't participate in aggregates.

See Also:
PaneManager
 o getWindow
 public Window getWindow()
Returns the main wizard window. The window may be either an instance of JDialog or JFrame, depending on whether the wizard is modal or modeless.

Returns:
the main window for this wizard
 o setModalRelativeTo
 public void setModalRelativeTo(WindowManager mgr)
Sets the location of the panel being managed relative to a panel managed by the specified WindowManager. If the panel is not currently showing, the panel for this WizardManager is centered on the screen.

This method has no effect if it is called after this wizard is made visible.

Parameters:
mgr - the WindowManager managing the panel in relation to which this object's panel location is determined
 o getOwnerManager
 public WindowManager getOwnerManager()
Returns the WindowManager in relation to which the receiver has been set modal, or null if the receiver is not modal relative to another window.

Returns:
the WindowManager managing the window in relation to which this object's window location is determined
See Also:
WindowManager
 o addCommitListener
 public void addCommitListener(ActionListener listener)
Adds an ActionListener which is notified when commit processing is complete.

This facility is provided for modeless windows, so that the application may learn when the window has closed. The listener's actionPerformed method will be called following successful completion of commit processing on the wizard. The ActionEvent passed to the listener object will have its action command string set to "COMMIT".

This method is not recommended for modal windows, since the application will be blocked on the setVisible call until the window is closed.

Parameters:
listener - the ActionListener to be notified
See Also:
WindowManager
 o addCancelListener
 public void addCancelListener(ActionListener listener)
Adds an ActionListener which is notified when the user cancels out of a window.

This facility is provided for modeless windows, so that the application may learn when the window has closed. The listener's actionPerformed method will be called when the user cancels out of the wizard without committing any changes. The ActionEvent passed to the listener object will have its action command string set to "CANCEL".

This method is not recommended for modal windows, since the application will be blocked on the setVisible call until the window is closed.

Parameters:
listener - the ActionListener to be notified
See Also:
WindowManager
 o setHelpPath
 public void setHelpPath(String path)
 o addPanel
 public void addPanel(PanelManager pm,
                      int index,
                      int stepIndex)
Adds a panel to the wizard managed by the receiver. This method has no effect if it is called after the wizard is made visible.

Parameters:
pm - the PanelManager for the new panel
index - the position at which the new page will be inserted
stepIndex - maps the wizard panel to one of the steps defined in the PDML for the wizard
Throws: ArrayIndexOutOfBoundsException
if the value of the specified index exceeds the current page count
 o getPage
 public PanelManager getPage(int index)
Returns the PanelManager for the specified wizard page.

Parameters:
index - the index of the wizard page
Returns:
the PanelManager instance for the page
Throws: ArrayIndexOutOfBoundsException
if the value of the specified index is not less than the page count
 o getPage
 public PanelManager getPage(String name)
Returns the PanelManager for the specified wizard page.

Parameters:
name - the name of the wizard page as specified in the PDML
Returns:
the PanelManager instance for the page, or null if the specified page is not found
 o removePanel
 public void removePanel(int index)
Removes a panel from the wizard managed by the receiver. This method has no effect if it is called after the wizard is made visible.

Parameters:
index - the index of the page to be removed
Throws: ArrayIndexOutOfBoundsException
if the value of the specified index exceeds the current page count minus 1
 o addButtons
 public void addButtons(int flags)
Adds the Back, Next, Finish, Cancel or Help buttons to the wizard panel if they have been previously removed.

Parameters:
flags - button constants indicating which buttons should be added
 o removeButtons
 public void removeButtons(int flags)
Removes the Back, Next, Finish, Cancel or Help buttons from the wizard panel.

Parameters:
flags - button constants indicating which buttons should be removed
 o enableButtons
 public void enableButtons(int flags)
Enables the Back, Next, Finish, Cancel or Help buttons on the wizard panel if they have been previously disabled.

Parameters:
flags - button constants indicating which buttons should be enabled
 o disableButtons
 public void disableButtons(int flags)
Disables the Back, Next, Finish, Cancel or Help buttons on the wizard panel.

Parameters:
flags - button constants indicating which buttons should be disabled

All Packages  Class Hierarchy  This Package  Previous  Next  Index