All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.sun.install.panels.ProgressPanel

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

public class ProgressPanel

extends WizardLeaf

Here is a sample ProgressPanel installing 1 product:

The code to create this panel is:

 wizardState.setPurpose("install");
 Vector msgs = new Vector();
 msgs.addElement(new Msg("Installing Webstart Wizards SDK"));
 wizardState.setData("progressLabels", msgs);
 wizardState.setProgressLabel("install", new Msg("Installing Webstart Wizards SDK"));
 ProgressPanel samplePanel = new ProgressPanel(wizardState, "SampleName", "progressLabels");
 

Each product wizard state on the client side should set its progress label using setProgressLabel(String, Msg).

multiplier

Scales the progress bar in CLI mode

progressKey

The progress key is used to request labels from the server for each of the progress bars that are to appear on this panel. Deprecated.

progressManager

The ProgressManager object manages the progress bar(s). Deprecated.

progressVisual

The ProgressVisual object that is to be displayed on the progress panel. Deprecated.

sequenceIsComplete

local status for when sequence is complete Deprecated.

shouldPerform

This flag indicates whether the sequence should be performed or reversed. Deprecated.

STOPPED

Flag indicating the progress panels have stopped

ttyNum

Which progress result to use for display TTY progress.

ProgressPanel()

Creates a ProgressPanel with a route to the root of the server object tree.

ProgressPanel(String, Route, WizardTreeManager)

Creates a ProgressPanel with the specified name, the specified route and wizard manager.

ProgressPanel(WizardState, String, String)

Creates a ProgressPanel with the specified name.

abortDisplay()

This method is called when this ProgressPanel is being displayed, and the user presses the "cancel" button.

addRuntimeResources(Vector)

Get the runtime classes required by this panel.

beginDisplay()

This method is called when the ProgressPanel is displayed.

cancel()

Cancel has occured.

consoleInteraction()

Shows the progress bar in CLI mode

createUI()

This method creates the user interface.

deserialize(DataInput)

Deserialize this WizardComponent from the specified input stream.

getButtonMask()

Returns information suggesting which buttons should be displayed for this panel.

getProgressVisual()

Get the ProgressVisual object for this ProgressPanel.

isDisplayComplete()

Returns true if this WizardComponent is finished displaying.

sequenceComplete()

This is the callback method passed in to the performSequence call.

serialize(DataOutput)

Serialize this WizardComponent to the specified output stream.

setLabel(String)

setProgress(int[])

Set the progress to the specified values.

setReverse()

Set this panel to reverse the sequence rather than perform it.

setVisual(ProgressVisual)

Set the ProgressVisual object for the progress panel.

 public static final int STOPPED

Flag indicating the progress panels have stopped

 protected int ttyNum

Which progress result to use for display TTY progress.

 protected double multiplier

Scales the progress bar in CLI mode

 protected String progressKey

Note: progressKey is deprecated.

The progress key is used to request labels from the server for each of the progress bars that are to appear on this panel.

 protected boolean shouldPerform

Note: shouldPerform is deprecated.

This flag indicates whether the sequence should be performed or reversed.

 protected ProgressManager progressManager

Note: progressManager is deprecated.

The ProgressManager object manages the progress bar(s).

 protected ProgressVisual progressVisual

Note: progressVisual is deprecated.

The ProgressVisual object that is to be displayed on the progress panel.

 protected boolean sequenceIsComplete

Note: sequenceIsComplete is deprecated.

local status for when sequence is complete

 public ProgressPanel()

Creates a ProgressPanel with a route to the root of the server object tree.

 public ProgressPanel(WizardState wizardState,
                      String name,
                      String progressKey)

Creates a ProgressPanel with the specified name.

Parameters:

wizardState - The buildtime WizardState.

name - The name for this ProgressPanel.

progressKey - The key used to request the progress labels from the WizardState.

 public ProgressPanel(String name,
                      Route route,
                      WizardTreeManager wizardManager)

Creates a ProgressPanel with the specified name, the specified route and wizard manager.

Parameters:

name - The name for this ProgressPanel.

route - The route to the appropriate server side object.

wizardManager - The wizardManager responsible for this component.

 public void setReverse()

Set this panel to reverse the sequence rather than perform it.

 public void setVisual(ProgressVisual progressVisual)

Set the ProgressVisual object for the progress panel.

Parameters:

progressVisual - The ProgressVisual to use for this panel

 public ProgressVisual getProgressVisual()

Get the ProgressVisual object for this ProgressPanel.

Returns:

The ProgressVisual object associated with this panel.

 public void consoleInteraction()

Shows the progress bar in CLI mode

Overrides:

consoleInteraction in class WizardComponent

 public boolean isDisplayComplete()

Returns true if this WizardComponent is finished displaying.

Overrides:

isDisplayComplete in class WizardComponent

 public void beginDisplay()

This method is called when the ProgressPanel is displayed. ProgressPanel overrides this method to perform the sequence named "InstallSequence".

Overrides:

beginDisplay in class WizardComponent

 public void abortDisplay()

This method is called when this ProgressPanel is being displayed, and the user presses the "cancel" button. This method provides an opportunity for this WizardComponent to do any required cleanup.

Overrides:

abortDisplay in class WizardComponent

 public WizardComponent cancel()

Cancel has occured. Stay on this panel (by returning its own id). The progress panel's sequence will complete after its reversed any partially done operations.

Overrides:

cancel in class WizardComponent

 public void createUI()

This method creates the user interface.

Overrides:

createUI in class WizardLeaf

 public void setProgress(int progress[])

Set the progress to the specified values.

Parameters:

progress - An array specifying progress.

 public void setLabel(String label)

 public void sequenceComplete()

This is the callback method passed in to the performSequence call. This callback will be called when the sequence has completed.

 public int getButtonMask()

Returns information suggesting which buttons should be displayed for this panel. The progress panel should not have navigation buttons.

Returns:

A button mask identifying valid navigation buttons.

Overrides:

getButtonMask in class WizardLeaf

 protected void serialize(DataOutput out)

Serialize this WizardComponent to the specified output stream. This method does not save its children.

Parameters:

out - The output stream to which this WizardComponent will be serialized.

Overrides:

serialize in class WizardComponent

See Also:

serializeChildren

 protected void deserialize(DataInput in)

Deserialize this WizardComponent from the specified input stream. This method does not deserialize its children.

Parameters:

in - The input stream from which this WizardComponent will be deserialized.

Overrides:

deserialize in class WizardComponent

See Also:

deserializeChildren

 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