All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.sun.wizards.nodes.LoopNode 

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.LoopNode
public class LoopNode
extends PanelNode
The LoopNode allows a group of panels to be displayed repeatedly. The LoopNode is instantiated with a data key, which will be used to determine when to exit the loop. The iteration count (starting from 1) will be set by the LoopNode into another data key, which is also specified in the constructor.

Constructor Index

o LoopNode()
This default constructor is used for deserialization.
o LoopNode(String, Route, WizardTreeManager)
Creates a LoopNode with the specified name, the specified route and wizard manager.
o LoopNode(String, Route, WizardTreeManager, String, String)
Creates a LoopNode with the specified name, the specified route and wizard manager.
o LoopNode(WizardState, String, String, String)
Creates a LoopNode with the specified exit data key and the specified iteration data key.

Method Index

o addRuntimeResources(Vector)
Get the runtime classes required by this Node.
o beginDisplay()
This method is called when the first child panel of this node is entered.
o breakLoop()
Break out of the loop node immediately.
o continueLoop()
Continue with the next loop iteration.
o deserialize(DataInput)
Deserialize this node from the specified input stream.
o getNextChild(WizardComponent)
Get the child that follows the specified child in the WizardComponent tree.
o isDisplayComplete()
This method is called when the last child panel of this node is exited successfully.
o serialize(DataOutput)
Serialize this node to the specified output stream.

Constructors

o LoopNode 
 public LoopNode()
This default constructor is used for deserialization.

o LoopNode 
 public LoopNode(WizardState wizardState,
                 String name,
                 String exitKey,
                 String iterationKey)
Creates a LoopNode with the specified exit data key and the specified iteration data key.

Parameters:
wizardState - The buildtime WizardState.
name - The name of this LoopNode.
exitKey - The data key for exit status.
iterationKey - The data key used to reference the iteration count.
o LoopNode 
 public LoopNode(String name,
                 Route route,
                 WizardTreeManager wizardManager)
Creates a LoopNode with the specified name, the specified route and wizard manager.

Parameters:
name - The name for this LoopNode.
route - The route to the appropriate server side object.
wizardManager - The wizard manager responsible for this component.
o LoopNode 
 public LoopNode(String name,
                 Route route,
                 WizardTreeManager wizardManager,
                 String exitKey,
                 String iterationKey)
Creates a LoopNode with the specified name, the specified route and wizard manager. Can be used at runtime to dynamically create a LoopNode.

Parameters:
name - The name for this LoopNode.
route - The route to the appropriate server side object.
wizardManager - The wizard manager responsible for this component.
exitKey - The data key for exit status.
iterationKey - The data key used to reference the iteration count.

Methods

o beginDisplay 
 public void beginDisplay()
This method is called when the first child panel of this node is entered.

Overrides:
beginDisplay in class PanelNode
o isDisplayComplete 
 public boolean isDisplayComplete()
This method is called when the last child panel of this node is exited successfully.

Overrides:
isDisplayComplete in class WizardComponent
o serialize 
 protected void serialize(DataOutput out)
Serialize this node to the specified output stream.

Parameters:
out - The output stream to which this panel will be serialized.
Overrides:
serialize in class WizardComposite
o getNextChild 
 protected WizardComponent getNextChild(WizardComponent currentChild)
Get the child that follows the specified child in the WizardComponent tree. The LoopNode overrides this method to accomplish repeating a set of panels.

Parameters:
currentChild - The child that comes before the desired child in the wizard tree.
Returns:
The next child in the wizard tree or null if no children follow the specified child in the tree.
Overrides:
getNextChild in class WizardComposite
o breakLoop 
 public void breakLoop()
Break out of the loop node immediately. Invocation of this method causes the panel after the LoopNode to be visited.

o continueLoop 
 public void continueLoop()
Continue with the next loop iteration.

o deserialize 
 protected void deserialize(DataInput in)
Deserialize this node from the specified input stream.

Parameters:
in - The input stream from which this node will be deserialized.
Overrides:
deserialize in class WizardComposite
o addRuntimeResources 
 public void addRuntimeResources(Vector resourceVector)
Get the runtime classes required by this Node.

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