All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.sun.wizards.nodes.SkipNode 

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.SkipNode
public class SkipNode
extends WizardComposite
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 SkipNode is used to skip traversal of part of the wizard client tree based on a data value set in the server. If the data value is true, the SkipNode will request to be skipped. As a result, all panels that are children of the SkipNode will be skipped also.

Variable Index

o skipKey
The key to reference in the WizardState. Deprecated.

Constructor Index

o SkipNode()
Creates a SkipNode with no name and no key to reference.
o SkipNode(String, Route, WizardTreeManager)
Creates a SkipNode with the specified name, the specified route and wizard manager.
o SkipNode(WizardState, String, String)
Creates a SkipNode with the specified name and the specified key to reference in the WizardState.
o SkipNode(WizardState, String, String, boolean)
Creates a SkipNode with the specified name and the specified key to reference in the WizardState.

Method Index

o addRuntimeResources(Vector)
Get the runtime classes required by this panel.
o deserialize(DataInput)
Deserialize this panel from the specified input stream.
o getInvert()
Returns the key this object observes when determining whether to display its children.
o getSkipKey()
Returns the key this object observes when determining whether to display its children.
o serialize(DataOutput)
Serialize this panel to the specified output stream.
o skip()
This method returns true if this SkipNode wants to be skipped during traversal of this tree.

Variables

o skipKey 
 protected String skipKey
Note: skipKey is deprecated.

The key to reference in the WizardState.

Constructors

o SkipNode 
 public SkipNode()
Creates a SkipNode with no name and no key to reference.

o SkipNode 
 public SkipNode(WizardState wizardState,
                 String name,
                 String skipKey)
Creates a SkipNode with the specified name and the specified key to reference in the WizardState.

Parameters:
wizardState - The buildtime WizardState.
name - The name of this SkipNode.
skipKey - The key to reference when deciding whether this SkipNode should be skipped in the tree traversal.
o SkipNode 
 public SkipNode(WizardState wizardState,
                 String name,
                 String skipKey,
                 boolean invert)
Creates a SkipNode with the specified name and the specified key to reference in the WizardState.

Parameters:
wizardState - The buildtime WizardState.
name - The name of this SkipNode.
skipKey - The key to reference when deciding whether this SkipNode should be skipped in the tree traversal.
invert - Inverts the node. I.e., if the skip criteria is met, the node is NOT skipped.
o SkipNode 
 public SkipNode(String name,
                 Route route,
                 WizardTreeManager wizardManager)
Creates a SkipNode with the specified name, the specified route and wizard manager.

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

Methods

o getSkipKey 
 protected String getSkipKey()
Returns the key this object observes when determining whether to display its children.

o getInvert 
 protected boolean getInvert()
Returns the key this object observes when determining whether to display its children.

o skip 
 public boolean skip()
This method returns true if this SkipNode wants to be skipped during traversal of this tree.

Returns:
true if this object wants to be skipped in the traversal of the tree. false otherwise.
Overrides:
skip in class WizardComponent
o serialize 
 protected void serialize(DataOutput out)
Serialize this panel to the specified output stream.

Parameters:
out - The output stream to which this panel will be serialized.
Overrides:
serialize in class WizardComposite
o deserialize 
 protected void deserialize(DataInput in)
Deserialize this panel from the specified input stream.

Parameters:
in - The input stream from which this panel will be deserialized.
Overrides:
deserialize in class WizardComposite
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 WizardComposite 
All Packages  Class Hierarchy  This Package  Previous  Next  Index