org.netbeans.api.wizard.displayer
Class WizardDisplayerImpl

java.lang.Object
  extended by org.netbeans.api.wizard.WizardDisplayer
      extended by org.netbeans.api.wizard.displayer.WizardDisplayerImpl

public class WizardDisplayerImpl
extends WizardDisplayer

Default implementation of WizardDisplayer. This class is NOT AN API CLASS. There is no commitment that it will remain backward compatible or even exist in the future. The API of this library is in the packages org.netbeans.api.wizard and org.netbeans.spi.wizard.

Use WizardDisplayer.showWizard() or its other static methods to display wizards in a way which will continue to work over time.


Constructor Summary
WizardDisplayerImpl()
          Default constructor used by WizardDisplayer static methods.
 
Method Summary
protected  void buildStepTitle()
           
protected  javax.swing.JDialog createDialog()
           
 NavButtonManager getButtonManager()
           
 java.lang.String getCurrentStep()
           
 WizardPanel getCurrentWizardPanel()
          Return the current wizard panel, or null if the currently displayed page is not a WizardPanel.
 DeferredWizardResult getDeferredResult()
           
 InstructionsPanel getInstructions()
           
 javax.swing.JPanel getOuterPanel()
           
 MergeMap getSettings()
           
 javax.swing.JLabel getTtlLabel()
           
 javax.swing.JPanel getTtlPanel()
           
 Wizard getWizard()
           
 javax.swing.JComponent getWizardPanel()
           
 java.lang.Object getWizardResult()
           
 void install(java.awt.Container c, java.lang.Object layoutConstraint, Wizard awizard, javax.swing.Action helpAction, java.util.Map initialProperties, WizardResultReceiver receiver)
          Instance implementation of installInContainer().
 boolean isInSummary()
           
 void navigateTo(java.lang.String id)
           
 void setCurrentWizardPanel(javax.swing.JComponent comp)
          Set the currently displayed panel.
 void setDeferredResult(DeferredWizardResult deferredResult)
           
 void setInSummary(boolean state)
           
 void setWizardResult(java.lang.Object wizardResult)
           
 java.lang.Object show(Wizard awizard, java.awt.Rectangle bounds, javax.swing.Action helpAction, java.util.Map initialProperties)
          Show a wizard.
protected  java.lang.Object showInDialog(java.awt.Rectangle bounds)
           
 
Methods inherited from class org.netbeans.api.wizard.WizardDisplayer
installInContainer, showWizard, showWizard, showWizard, showWizard
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WizardDisplayerImpl

public WizardDisplayerImpl()
Default constructor used by WizardDisplayer static methods.

Method Detail

buildStepTitle

protected void buildStepTitle()

install

public void install(java.awt.Container c,
                    java.lang.Object layoutConstraint,
                    Wizard awizard,
                    javax.swing.Action helpAction,
                    java.util.Map initialProperties,
                    WizardResultReceiver receiver)
Description copied from class: WizardDisplayer
Instance implementation of installInContainer().

Specified by:
install in class WizardDisplayer

show

public java.lang.Object show(Wizard awizard,
                             java.awt.Rectangle bounds,
                             javax.swing.Action helpAction,
                             java.util.Map initialProperties)
Description copied from class: WizardDisplayer
Show a wizard.

Specified by:
show in class WizardDisplayer
Parameters:
awizard - the Wizard to show
bounds - the bounding rectangle for the wizard dialog on screen, null means "computed from first panel size"
helpAction - An action to be called if the Help button is pressed
initialProperties - are used to set initial values for screens within the wizard. This may be null.
Returns:
Whatever object the wizard returns from its finish() method, if the Wizard was completed by the user.

createDialog

protected javax.swing.JDialog createDialog()

showInDialog

protected java.lang.Object showInDialog(java.awt.Rectangle bounds)

getCurrentWizardPanel

public WizardPanel getCurrentWizardPanel()
Return the current wizard panel, or null if the currently displayed page is not a WizardPanel.

Returns:

getCurrentStep

public java.lang.String getCurrentStep()

setCurrentWizardPanel

public void setCurrentWizardPanel(javax.swing.JComponent comp)
Set the currently displayed panel.


navigateTo

public void navigateTo(java.lang.String id)

getButtonManager

public NavButtonManager getButtonManager()

getDeferredResult

public DeferredWizardResult getDeferredResult()

getInstructions

public InstructionsPanel getInstructions()

isInSummary

public boolean isInSummary()

setInSummary

public void setInSummary(boolean state)

getOuterPanel

public javax.swing.JPanel getOuterPanel()

getSettings

public MergeMap getSettings()

getTtlLabel

public javax.swing.JLabel getTtlLabel()

getTtlPanel

public javax.swing.JPanel getTtlPanel()

getWizard

public Wizard getWizard()

getWizardPanel

public javax.swing.JComponent getWizardPanel()

getWizardResult

public java.lang.Object getWizardResult()

setWizardResult

public void setWizardResult(java.lang.Object wizardResult)

setDeferredResult

public void setDeferredResult(DeferredWizardResult deferredResult)