All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.sun.wizards.core.WizardLeaf 

java.lang.Object
   |
   +----java.awt.Component
           |
           +----java.awt.Container
                   |
                   +----java.awt.Panel
                           |
                           +----com.sun.wizards.core.WizardComponent
                                   |
                                   +----com.sun.wizards.core.WizardLeaf
public class WizardLeaf
extends WizardComponent
WizardLeaf implements the default behavior common to all WizardComponents that have no children.

The wizard client panel tree consists of an arrangement of panels (subclassed from WizardLeaf) and nodes (subclassed from WizardComposite). The arrangement of the tree determines the order in which the panels will be visited by the wizard. Nodes can affect the traversal of the panels, which allows advanced panels to be skipped for users that do not wish to use them.

"Leaf" was chosen as a name for this class from the book "Design Patterns".

Variable Index

o BACK_BUTTON
A value identifying the back button.
o CANCEL_BUTTON
A value identifying the cancel button.
o EXIT_BUTTON
A value identifying the exit button.
o NEXT_BUTTON
A value identifying the next button.

Constructor Index

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

Method Index

o addRuntimeResources(Vector)
Get the runtime classes required by this WizardComponent.
o createUI()
This method creates the user interface.
o getButtonMask()
Returns information suggesting which buttons should be displayed for this panel.
o getHeaderPanel()
Returns the header panel object that appears at the top of the wizard panel.
o getNextChild(WizardComponent)
Get the child that follows the specified child in the WizardComponent tree.
o getPreviousChild(WizardComponent)
Get the child that precedes the specified child in the WizardComponent tree.
o next()
Get the next WizardComponent in the tree.
o previous()
Get the previous WizardComponent in the tree.

Variables

o BACK_BUTTON 
 public static final int BACK_BUTTON
A value identifying the back button.

o NEXT_BUTTON 
 public static final int NEXT_BUTTON
A value identifying the next button.

o CANCEL_BUTTON 
 public static final int CANCEL_BUTTON
A value identifying the cancel button.

o EXIT_BUTTON 
 public static final int EXIT_BUTTON
A value identifying the exit button.

Constructors

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

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

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

Parameters:
name - The name for this WizardComponent.
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.

Overrides:
createUI in class WizardComponent
o getNextChild 
 protected WizardComponent getNextChild(WizardComponent currentChild)
Get the child that follows the specified child in the WizardComponent tree. Applications should use next.

Parameters:
currentChild - The child in the tree that comes before the desired sibling.
Returns:
The next child in the tree.
Overrides:
getNextChild in class WizardComponent
o next 
 public WizardComponent next()
Get the next WizardComponent in the tree.

Returns:
The next child in the tree.
Overrides:
next in class WizardComponent
o getPreviousChild 
 public WizardComponent getPreviousChild(WizardComponent currentChild)
Get the child that precedes the specified child in the WizardComponent tree. Applications should use previous.

Parameters:
currentChild - The child in the tree that comes after the desired sibling.
Returns:
The previous child in the tree.
Overrides:
getPreviousChild in class WizardComponent
o previous 
 public WizardComponent previous()
Get the previous WizardComponent in the tree.

Returns:
The previous child in the tree.
Overrides:
previous 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.
o getHeaderPanel 
 protected HeaderPanel getHeaderPanel()
Returns the header panel object that appears at the top of the wizard panel.

o addRuntimeResources 
 public void addRuntimeResources(Vector resourceVector)
Get the runtime classes required by this WizardComponent.

Parameters:
resourceVector - The vector containing resources that this method will add to.
Overrides:
addRuntimeResources in class WizardComponent 
All Packages  Class Hierarchy  This Package  Previous  Next  Index