All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.sun.install.panels.SummaryPanel

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.SummaryPanel

public class SummaryPanel
extends WizardLeaf
implements AdjustmentListener, ActionListener
The SummaryPanel displays an install summary. The products that did not successfully install will be listed. If all products install successfully, an appropriate message will be displayed. Here is an example SummaryPanel: Graphic of a SummaryPanel

The code to create this panel is:

SummaryPanel samplePanel = new SummaryPanel(wizardState, "SampleName");
Note that all of the information within the panel comes from the products that either did or did not install successfully. No information is supplied to the constructor.

Each wizard state maintains an "install.status" data value indicating its status, which is defined with the static variables NOT_INSTALLED, INSTALLED, FAILED, and STOPPED in this class.


Variable Index

 o FAILED
Per-product flag that indicates a product that failed during install and any partially installed product was cleaned up with an uninstalled.
 o FULLY_UNINSTALLED
Per-product flag that indicates a product that was not installed
 o INSTALLED
Per-product flag that indicates a product that was installed
 o NOT_INSTALLED
Per-product flag that indicates a product that was not installed
 o PARTIALLY_UNINSTALLED
Per-product flag that indicates a product that was not installed
 o STATUS_VALUE_COUNT
 o STOPPED
Per-product flag that indicates a product that was stopped during install
 o STOPPED_ON_ERROR
Per-product flag that indicates a product was stopped as a result of and install error.

Constructor Index

 o SummaryPanel()
Creates a SummaryPanel with no name.
 o SummaryPanel(String, Route, WizardTreeManager)
Creates a SummaryPanel with the specified name, the specified route and wizard manager.
 o SummaryPanel(WizardState, String)
Creates a SummaryPanel with the specified name.

Method Index

 o actionPerformed(ActionEvent)
A button on the SummaryPanel was pressed.
 o addRuntimeResources(Vector)
Get the runtime classes required by this panel.
 o adjustmentValueChanged(AdjustmentEvent)
Invoked when the scroll bar is used.
 o beginDisplay()
This method is called when the SummaryPanel is displayed.
 o consoleInteraction()
Shows summary panel in a textual representation for CLI mode
 o createUI()
Create the user interface for the SummaryPanel.
 o getBottomPanel()
Returns the bottomPanel
 o getButtonMask()
Returns information suggesting which buttons should be displayed for this panel.
 o getFirstDisplayAfterTraversal()
Returns the firstDisplayAfterTraversal flag
 o getRemoveLabel()
Returns the removeLabel
 o isDisplayComplete()
Returns true if this WizardComponent is finished displaying.
 o paint(Graphics)
The paint method is called when the panel is displayed.

Variables

 o NOT_INSTALLED
 public static final int NOT_INSTALLED
Per-product flag that indicates a product that was not installed

 o PARTIALLY_UNINSTALLED
 public static final int PARTIALLY_UNINSTALLED
Per-product flag that indicates a product that was not installed

 o FULLY_UNINSTALLED
 public static final int FULLY_UNINSTALLED
Per-product flag that indicates a product that was not installed

 o INSTALLED
 public static final int INSTALLED
Per-product flag that indicates a product that was installed

 o FAILED
 public static final int FAILED
Per-product flag that indicates a product that failed during install and any partially installed product was cleaned up with an uninstalled.

 o STOPPED
 public static final int STOPPED
Per-product flag that indicates a product that was stopped during install

 o STOPPED_ON_ERROR
 public static final int STOPPED_ON_ERROR
Per-product flag that indicates a product was stopped as a result of and install error.

 o STATUS_VALUE_COUNT
 public static final int STATUS_VALUE_COUNT

Constructors

 o SummaryPanel
 public SummaryPanel()
Creates a SummaryPanel with no name.

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

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

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

Methods

 o createUI
 public void createUI()
Create the user interface for the SummaryPanel.

Overrides:
createUI in class WizardLeaf
 o adjustmentValueChanged
 public void adjustmentValueChanged(AdjustmentEvent e)
Invoked when the scroll bar is used.

Parameters:
e - The Event that has occured.
 o paint
 public void paint(Graphics g)
The paint method is called when the panel is displayed.

Parameters:
g - The Graphics object for this panel
Overrides:
paint in class Container
 o beginDisplay
 public void beginDisplay()
This method is called when the SummaryPanel is displayed.

Overrides:
beginDisplay in class WizardComponent
 o getButtonMask
 public int getButtonMask()
Returns information suggesting which buttons should be displayed for this panel. The summary panel should not have a back navigation button.

Returns:
A button mask identifying valid navigation buttons.
Overrides:
getButtonMask in class WizardLeaf
 o actionPerformed
 public void actionPerformed(ActionEvent e)
A button on the SummaryPanel was pressed.

Parameters:
e - The source object which fired the event.
 o isDisplayComplete
 public boolean isDisplayComplete()
Returns true if this WizardComponent is finished displaying. This method can be used to verify user input.

Returns:
true if the display of this WizardComponent is complete; false otherwise.
Overrides:
isDisplayComplete in class WizardComponent
 o getBottomPanel
 protected Panel getBottomPanel()
Returns the bottomPanel

Returns:
The bottomPanel
 o getRemoveLabel
 protected FlowLabel getRemoveLabel()
Returns the removeLabel

Returns:
The removeLabel
 o getFirstDisplayAfterTraversal
 protected boolean getFirstDisplayAfterTraversal()
Returns the firstDisplayAfterTraversal flag

Returns:
The boolean firstDisplayAfterTraversal
 o consoleInteraction
 public void consoleInteraction()
Shows summary panel in a textual representation for CLI mode

Overrides:
consoleInteraction in class WizardComponent
 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 WizardLeaf

All Packages  Class Hierarchy  This Package  Previous  Next  Index