All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.sun.wizards.panels.InitializePanel

java.lang.Object
   |
   +----java.awt.Component
           |
           +----java.awt.Container
                   |
                   +----java.awt.Panel
                           |
                           +----com.sun.wizards.core.WizardComponent
                                   |
                                   +----com.sun.wizards.core.WizardLeaf
                                           |
                                           +----com.sun.wizards.panels.InitializePanel

public class InitializePanel
extends WizardLeaf
InitializePanel is a panel that is displayed as the wizard initializes. All wizards created will display this panel during the initialization of the wizard, if there is sufficient delay. In addition, you can also use this panel on its own as you would other panels, although you would normally have no reason to.

Here is a sample wizard using this panel.


Graphic of an InitializePanel
Here is the code for this wizard, which consists of a single panel:


 import com.sun.wizards.core.*;
 import com.sun.wizards.builder.ArchiveWriter;
 import com.sun.wizards.panels.*;
 public class SimpleWizardBuilder extends ArchiveWriter
 {
   public SimpleWizardBuilder()
     {
       super();
       this.archiveName = "simpleWizard_InitializePanel";
     }
   protected void createClientTree()
     {
        super.createClientTree();
        WizardState wizardState = getWizardState();
        // Create the client panels.
        InitializePanel samplePanel = new InitializePanel(wizardState, "Sample Panel");
        root.addChild(samplePanel);
     }
   protected void setResources()
     {
        super.setResources();
     }
   public static void main(String[] args)
     {
     SimpleWizardBuilder simpleWizardBuilder = new SimpleWizardBuilder();
     simpleWizardBuilder.writeArchive();
     }
   }
 


Constructor Index

 o InitializePanel()
Creates a InitializePanel with no name.
 o InitializePanel(String, Route, WizardTreeManager)
Creates a InitializePanel with the specified name, the specified route and wizard manager.
 o InitializePanel(WizardState, String)
Creates a InitializePanel with the specified name.

Method Index

 o abortDisplay()
This method is called when the initialization is done.
 o addRuntimeResources(Vector)
Get the runtime classes required by this panel.
 o createUI()
This method creates the user interface and performs the initialization sequence.
 o getButtonMask()
Returns information suggesting which buttons should be displayed for this panel.

Constructors

 o InitializePanel
 public InitializePanel()
Creates a InitializePanel with no name.

 o InitializePanel
 public InitializePanel(WizardState wizardState,
                        String name)
Creates a InitializePanel with the specified name.

Parameters:
wizardState - The buildtime WizardState.
name - The name for this InitializePanel.
 o InitializePanel
 public InitializePanel(String name,
                        Route route,
                        WizardTreeManager wizardManager)
Creates a InitializePanel with the specified name, the specified route and wizard manager.

Parameters:
name - The name for this InitializePanel.
route - The route to the appropriate server side object.
wizardManager - The wizardManager responsible for this component.

Methods

 o createUI
 public void createUI()
This method creates the user interface and performs the initialization sequence.

Overrides:
createUI in class WizardLeaf
 o abortDisplay
 public void abortDisplay()
This method is called when the initialization is done. This method provides an opportunity for this WizardComponent to do cleanup before exiting. The EventPanel overrides this method to call its parent's abortDisplay method.

Overrides:
abortDisplay in class WizardComponent
 o getButtonMask
 public int getButtonMask()
Returns information suggesting which buttons should be displayed for this panel.

Returns:
A button mask identifying valid navigation buttons.
Overrides:
getButtonMask in class WizardLeaf
 o addRuntimeResources
 public void addRuntimeResources(Vector resourceVector)
Get the runtime classes required by this panel.

Parameters:
resourceVector - The vector containing all runtime resources for this wizard.
Overrides:
addRuntimeResources in class WizardLeaf

All Packages  Class Hierarchy  This Package  Previous  Next  Index