All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.sun.install.panels.InstallTypePanel

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

public class InstallTypePanel
extends WizardLeaf
The InstallTypePanel presents the user with a choice between performing a default installation or a custom installation. Generally the custom installation will present the user with options including but not limited to the following: Installation directory. Product component selection. As an example, here is an InstallTypePanel:

Graphic of a InstallTypePanel

The code to create this panel is:

WizardState wizardState = getWizardState(); samplePanel InstallTypePanel = new InstallTypePanel(wizardState, "myName");
Note in the code above that the text that appears in the Panel is not specified to the constructor. The text is placed into the class at buildtime using the "setDefaultDescription" and "setCustomDescription" methods within the class and extracted at runtime. This panel should set the "standardInstall" data object in the wizardState to new Boolean.FALSE if the user selects a custom installation. Otherwise, it should be set to Boolean.TRUE.


Variable Index

 o cbg
The group of checkboxes that includes the buttons representing default and custom. Deprecated.
 o customButton
The button associated with a custom installation. Deprecated.
 o customDescription
A string that describes the custom option. Deprecated.
 o defaultDescription
A string that describes the default option. Deprecated.
 o standardButton
The button associated with a default installation. Deprecated.

Constructor Index

 o InstallTypePanel()
Creates an InstallTypePanel with no name.
 o InstallTypePanel(String, Route, WizardTreeManager)
Creates an InstallTypePanel with the specified name, the specified route and wizard manager.
 o InstallTypePanel(WizardState, String)
Creates an InstallTypePanel with the specified name for the specified application.

Method Index

 o addRuntimeResources(Vector)
Get the runtime classes required by this panel.
 o beginDisplay()
This method is called when the WizardComponent is displayed.
 o consoleInteraction()
CLI version of this panel.
 o createUI()
This method creates the user interface for the InstallTypePanel.
 o customByDefault()
If this is an install, this flag tells whether the default should be "default" or "custom".
 o deserialize(DataInput)
Deserialize this panel from the specified input stream.
 o getCustom()
 o isDisplayComplete()
Returns true if this InstallTypePanel is finished displaying.
 o serialize(DataOutput)
Serialize this panel to the specified output stream.
 o setCustom(boolean)
 o setCustomDescription(Msg)
Sets the description text for the custom button.
 o setCustomEnabled(boolean)
Sets the custom button and label's visibility
 o setDefaultDescription(Msg)
Sets the description text for the default button.
 o setDefaultEnabled(boolean)
Sets the default button and label's visibility
 o setInstalledDescription(Msg)
Sets the description text for the default button.

Variables

 o standardButton
 protected Checkbox standardButton
Note: standardButton is deprecated.

The button associated with a default installation.

 o customButton
 protected Checkbox customButton
Note: customButton is deprecated.

The button associated with a custom installation.

 o cbg
 protected CheckboxGroup cbg
Note: cbg is deprecated.

The group of checkboxes that includes the buttons representing default and custom.

 o defaultDescription
 protected Msg defaultDescription
Note: defaultDescription is deprecated.

A string that describes the default option.

 o customDescription
 protected Msg customDescription
Note: customDescription is deprecated.

A string that describes the custom option.

Constructors

 o InstallTypePanel
 public InstallTypePanel()
Creates an InstallTypePanel with no name.

 o InstallTypePanel
 public InstallTypePanel(WizardState wizardState,
                         String name)
Creates an InstallTypePanel with the specified name for the specified application.

Parameters:
wizardState - The buildtime WizardState.
name - The name for this panel.
 o InstallTypePanel
 public InstallTypePanel(String name,
                         Route route,
                         WizardTreeManager wizardManager)
Creates an InstallTypePanel 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 setDefaultEnabled
 public void setDefaultEnabled(boolean enable)
Sets the default button and label's visibility

Parameters:
enable - boolean to setEnable() the default label and checkbox
 o setCustomEnabled
 public void setCustomEnabled(boolean enable)
Sets the custom button and label's visibility

Parameters:
enable - boolean to setEnable() the custom label and checkbox
 o setInstalledDescription
 public void setInstalledDescription(Msg installedDescription)
Sets the description text for the default button. The text should describe the consequences of selecting a default installation.

Parameters:
installedtDescription - Msg informing that the product is already installed.
 o setDefaultDescription
 public void setDefaultDescription(Msg defaultDescription)
Sets the description text for the default button. The text should describe the consequences of selecting a default installation.

Parameters:
defaultDescription - The description of the default behavior.
 o setCustomDescription
 public void setCustomDescription(Msg customDescription)
Sets the description text for the custom button. The text should describe the consequences of selecting a custom installation.

Parameters:
customDescription - The description of the custom behavior.
 o isDisplayComplete
 public boolean isDisplayComplete()
Returns true if this InstallTypePanel is finished displaying. This method is used to set the user's selection into the WizardState before moving to the next panel.

Returns:
true if the display of this panel is complete, false otherwise
Overrides:
isDisplayComplete in class WizardComponent
 o createUI
 public void createUI()
This method creates the user interface for the InstallTypePanel.

Overrides:
createUI in class WizardLeaf
 o beginDisplay
 public void beginDisplay()
This method is called when the WizardComponent is displayed.

Overrides:
beginDisplay in class WizardComponent
 o customByDefault
 protected boolean customByDefault()
If this is an install, this flag tells whether the default should be "default" or "custom". If this is an uninstall, it will always be "Full Uninstall". If it has been previously installed, means "custom". Set in the LookupTask for a product installer, if the product is already installed.

Returns:
true if this should be a custom install by default, false if it should be default or if this an uninstall.
 o consoleInteraction
 public void consoleInteraction()
CLI version of this panel. Only shown in text-wizard mode.

Overrides:
consoleInteraction 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 WizardComponent
 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 WizardComponent
 o setCustom
 protected void setCustom(boolean custom)
 o getCustom
 protected boolean getCustom()
 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