All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.sun.wizards.nodes.HierarchyNode

java.lang.Object
   |
   +----java.awt.Component
           |
           +----java.awt.Container
                   |
                   +----java.awt.Panel
                           |
                           +----com.sun.wizards.core.WizardComponent
                                   |
                                   +----com.sun.wizards.core.WizardComposite
                                           |
                                           +----com.sun.wizards.nodes.PanelNode
                                                   |
                                                   +----com.sun.wizards.nodes.HierarchyNode

public class HierarchyNode
extends PanelNode
Nodes within the wizard panel tree are used to group sets of wizard panels together. In this way, groups of panels can be visited or skipped as the user traverses through the wizard panels.

The HierarchyNode is a node that adds subtrees to itself upon traversal and display of the tree.

The subtrees will be read from selected child wizard archives. This node must have the same name as the subtrees that are to be read.

The HierarchyNode makes it easy to connect wizards together into a single wizard user experience.


Constructor Index

 o HierarchyNode()
Creates an HierarchyNode with a route to the root of the server object tree.
 o HierarchyNode(String, Route, WizardTreeManager)
Creates an HierarchyNode with the specified name, the specified route and wizard manager.
 o HierarchyNode(WizardState, String)
Creates an HierarchyNode with the specified name and WizardState.

Method Index

 o abortDisplay()
This method is called when this WizardComponent is being displayed, and the user presses the "back" button.
 o addRuntimeResources(Vector)
Get the runtime classes required by this panel.
 o beginDisplay()
This method is called when the HierarchyNode is displayed.

Constructors

 o HierarchyNode
 public HierarchyNode()
Creates an HierarchyNode with a route to the root of the server object tree.

 o HierarchyNode
 public HierarchyNode(WizardState wizardState,
                      String name)
Creates an HierarchyNode with the specified name and WizardState.

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

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

Methods

 o beginDisplay
 public void beginDisplay()
This method is called when the HierarchyNode is displayed. HierarchyNode overrides this method to add subtrees from other wizard archives to this node.

Overrides:
beginDisplay in class PanelNode
 o abortDisplay
 public void abortDisplay()
This method is called when this WizardComponent is being displayed, and the user presses the "back" button. This method provides an opportunity for this WizardComponent to do cleanup before exiting. This method is used when the user presses the "back" button, and the isDisplayComplete method is used when the user presses the "next" button.

Overrides:
abortDisplay in class PanelNode
 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 PanelNode

All Packages  Class Hierarchy  This Package  Previous  Next  Index