csli.util.swing.wizard
Class WizardPanelDescriptor

java.lang.Object
  csli.util.swing.wizard.WizardPanelDescriptor

Direct Known Subclasses:

MutableWizardPanelDescriptor

public class WizardPanelDescriptor
extends Object

A base descriptor class used to reference a Component panel for the Wizard, as well as provide general rules as to how the panel should behave.

Field Summary

static csli.util.swing.wizard.WizardPanelDescriptor.FinishIdentifier

FINISH Identifier returned by getNextPanelDescriptor() to indicate that this is the last panel and the text of the 'Next' button should change to 'Finish'.

Constructor Summary

WizardPanelDescriptor()
Default constructor.

WizardPanelDescriptor(Object id, Component panel)
Constructor which accepts both the Object-based identifier and a reference to the Component class which makes up the panel.

Method Summary

void	aboutToDisplayPanel() Override this method to provide functionality that will be performed just before the panel is to be displayed.
void	aboutToHidePanel() Override this method to perform functionality just before the panel is to be hidden.
void	displayingPanel() Override this method to perform functionality when the panel itself is displayed.
Object	getBackPanelDescriptor() Override this class to provide the Object-based identifier of the panel that the user should traverse to when the Back button is pressed.
Object	getNextPanelDescriptor() Override this class to provide the Object-based identifier of the panel that the user should traverse to when the Next button is pressed.
Component	getPanelComponent() Returns to java.awt.Component that serves as the actual panel.
Object	getPanelDescriptorIdentifier() Returns the unique Object-based identifier for this panel descriptor.
Wizard	getWizard() Returns a reference to the Wizard component.
WizardModel	getWizardModel() Returns a reference to the current WizardModel for this Wizard component.
void	setPanelComponent(Component panel) Sets the panel's component as a class that extends java.awt.Component
void	setPanelDescriptorIdentifier(Object id) Sets the Object-based identifier for this panel.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

FINISH

public static final csli.util.swing.wizard.WizardPanelDescriptor.FinishIdentifier FINISH

Identifier returned by getNextPanelDescriptor() to indicate that this is the last panel and the text of the 'Next' button should change to 'Finish'.

Constructor Detail

WizardPanelDescriptor

public WizardPanelDescriptor()

Default constructor. The id and the Component panel must be set separately.

WizardPanelDescriptor

public WizardPanelDescriptor(Object id,
                             Component panel)

Constructor which accepts both the Object-based identifier and a reference to the Component class which makes up the panel.

Parameters:

id - Object-based identifier

panel - A class which extends java.awt.Component that will be inserted as a panel into the wizard dialog.

Method Detail

aboutToDisplayPanel

public void aboutToDisplayPanel()

Override this method to provide functionality that will be performed just before the panel is to be displayed.

aboutToHidePanel

public void aboutToHidePanel()

Override this method to perform functionality just before the panel is to be hidden.

displayingPanel

public void displayingPanel()

Override this method to perform functionality when the panel itself is displayed.

getBackPanelDescriptor

public Object getBackPanelDescriptor()

Override this class to provide the Object-based identifier of the panel that the user should traverse to when the Back button is pressed. Note that this method is only called when the button is actually pressed, so that the panel can change the previous panel's identifier dynamically at runtime if necessary. Return null if the button should be disabled.

Returns:

Object-based identifier

getNextPanelDescriptor

public Object getNextPanelDescriptor()

Override this class to provide the Object-based identifier of the panel that the user should traverse to when the Next button is pressed. Note that this method is only called when the button is actually pressed, so that the panel can change the next panel's identifier dynamically at runtime if necessary. Return null if the button should be disabled. Return FinishIdentfier if the button text should change to 'Finish' and the dialog should end.

Returns:

Object-based identifier.

getPanelComponent

public final Component getPanelComponent()

Returns to java.awt.Component that serves as the actual panel.

Returns:

A reference to the java.awt.Component that serves as the panel

getPanelDescriptorIdentifier

public final Object getPanelDescriptorIdentifier()

Returns the unique Object-based identifier for this panel descriptor.

Returns:

The Object-based identifier

getWizard

public final Wizard getWizard()

Returns a reference to the Wizard component.

Returns:

The Wizard class hosting this descriptor.

getWizardModel

public WizardModel getWizardModel()

Returns a reference to the current WizardModel for this Wizard component.

Returns:

The current WizardModel for this Wizard component.

setPanelComponent

public final void setPanelComponent(Component panel)

Sets the panel's component as a class that extends java.awt.Component

Parameters:

panel - java.awt.Component which serves as the wizard panel

setPanelDescriptorIdentifier

public final void setPanelDescriptorIdentifier(Object id)

Sets the Object-based identifier for this panel. The identifier must be unique from all the other identifiers in the panel.

Parameters:

id - Object-based identifier for this panel.