|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object net.sf.fmj.ui.wizard.WizardPanelDescriptor
public class WizardPanelDescriptor
Adapted Robert Eckstein's sample at http://java.sun.com/developer/technicalArticles/GUI/swing/wizard/ 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 net.sf.fmj.ui.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(java.lang.Object id,
java.awt.Component panel)
Constructor which accepts both the Object-based identifier and a reference to the Component class which makes up the panel. |
Method Summary | |
---|---|
boolean |
aboutToDisplayPanel(java.lang.Object prevId)
Override this method to provide functionality that will be performed just before the panel is to be displayed. |
boolean |
aboutToHidePanel(java.lang.Object idOfNext)
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. |
java.lang.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. |
java.lang.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. |
java.awt.Component |
getPanelComponent()
Returns to java.awt.Component that serves as the actual panel. |
java.lang.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(java.awt.Component panel)
Sets the panel's component as a class that extends java.awt.Component |
void |
setPanelDescriptorIdentifier(java.lang.Object id)
Sets the Object-based identifier for this panel. |
void |
showError(java.lang.String e)
|
void |
showError(java.lang.Throwable e)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final net.sf.fmj.ui.wizard.WizardPanelDescriptor.FinishIdentifier FINISH
Constructor Detail |
---|
public WizardPanelDescriptor()
public WizardPanelDescriptor(java.lang.Object id, java.awt.Component panel)
id
- Object-based identifierpanel
- A class which extends java.awt.Component that will be inserted as a
panel into the wizard dialog.Method Detail |
---|
public final java.awt.Component getPanelComponent()
public final void setPanelComponent(java.awt.Component panel)
panel
- java.awt.Component which serves as the wizard panelpublic final java.lang.Object getPanelDescriptorIdentifier()
public final void setPanelDescriptorIdentifier(java.lang.Object id)
id
- Object-based identifier for this panel.public final Wizard getWizard()
public WizardModel getWizardModel()
public java.lang.Object getNextPanelDescriptor()
public java.lang.Object getBackPanelDescriptor()
public boolean aboutToDisplayPanel(java.lang.Object prevId)
public void displayingPanel()
public boolean aboutToHidePanel(java.lang.Object idOfNext)
public void showError(java.lang.Throwable e)
public void showError(java.lang.String e)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |