All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.sun.wizards.core.WizardConsole

java.lang.Object
   |
   +----java.awt.Component
           |
           +----java.awt.Container
                   |
                   +----java.awt.Panel
                           |
                           +----com.sun.wizards.core.WizardConsole

public class WizardConsole

extends Panel

implements WindowListener, AppConsole, Runnable

In the above illustration, the WizardConsole is the panel that contains all of the components of the wizard. The WizardConsole uses the WizardConsoleLayout layout manager to place the image panel, the wizard panel, and the navigation panel.

The WizardConsole is used if the wizard is executed in graphics mode. The CommandLineConsole is used if the wizard is executed in command line mode. The WizardConsole object is the interface between the user and the client environment.

WizardConsole(Frame, WizardState)

Creates a WizardConsole with the specified frame and the specified WizardState.

displayQuery(Object, String, String, String[], String[])

Display a query to the user.

displayQuery(Object, String, String[], String[])

Display a query to the user.

exit()

Exit the applet/application. Deprecated.

exit(int)

Exit the applet/application with the specified exit status.

getWizardSize()

Gets the size of the wizard frame.

getWizardState()

Returns the state of the wizard frame.

hasGUI()

The WizardConsole has a gui.

main(String[])

This main method is only provided for testing outside of the wizard archive.

removeImagePanel()

run()

Initialize the wizard console in a separate thread.

setFrameTitle(String)

Sets the title of the containing Frame

setIconImage(Image)

Sets the icon for the wizard.

setWizardSize(Dimension)

Sets the size of the wizard frame.

setWizardState(WizardState)

Sets the WizardState reference of the wizard console

windowActivated(WindowEvent)

Invoked when a window is activated.

windowClosed(WindowEvent)

Invoked when a window has been closed.

windowClosing(WindowEvent)

Invoked when a window is in the process of being closed.

windowDeactivated(WindowEvent)

Invoked when a window is de-activated.

windowDeiconified(WindowEvent)

Invoked when a window is de-iconified.

windowIconified(WindowEvent)

Invoked when a window is iconified.

windowOpened(WindowEvent)

Invoked when a window has been opened.

 public WizardConsole(Frame wizardFrame,
                      WizardState wizardState)

Creates a WizardConsole with the specified frame and the specified WizardState.

Parameters:

wizardFrame - The Frame object that this WizardConsole will be displayed within.

wizardState - The connection to the server.

 public void run()

Initialize the wizard console in a separate thread. This frees the WizardState constructor.

 public void setFrameTitle(String title)

Sets the title of the containing Frame

 public void setIconImage(Image icon)

Sets the icon for the wizard.

Parameters:

icon - The icon image to be displayed.

 public void setWizardSize(Dimension size)

Sets the size of the wizard frame.

Parameters:

size - The new size for the wizard frame.

 public Dimension getWizardSize()

Gets the size of the wizard frame.

 public void windowOpened(WindowEvent e)

Invoked when a window has been opened.

 public void removeImagePanel()

 public void windowClosing(WindowEvent e)

Invoked when a window is in the process of being closed. The close operation can be overridden at this point.

 public void windowClosed(WindowEvent e)

Invoked when a window has been closed.

 public void windowIconified(WindowEvent e)

Invoked when a window is iconified.

 public void windowDeiconified(WindowEvent e)

Invoked when a window is de-iconified.

 public void windowActivated(WindowEvent e)

Invoked when a window is activated.

 public void windowDeactivated(WindowEvent e)

Invoked when a window is de-activated.

 public void exit()

Note: exit() is deprecated. Programs should now use exit(int).

Exit the applet/application.

 public void exit(int status)

Exit the applet/application with the specified exit status. By convention, a non-zero status indicates abnormal termination. This method never returns.

Parameters:

status - The exit status.

 public void displayQuery(Object target,
                          String title,
                          String message,
                          String buttons[],
                          String methods[])

Display a query to the user. When a selection is made, the corresponding method will be called on the target.

Parameters:

target - The object to call when a selection from the dialog is made.

title - The title of the displayed query.

message - The message to be displayed to the user.

buttons - The buttons (button labels) offered to the user to select from.

methods - A list of methods (in the same order as the list of buttons) that will be called when a dialog selection is made.

 public void displayQuery(Object target,
                          String message,
                          String buttons[],
                          String methods[])

Display a query to the user. When a selection is made, the corresponding method will be called on the target.

Parameters:

target - The object to call when a selection from the dialog is made.

title - The title of the displayed query.

message - The message to be displayed to the user.

buttons - The buttons (button labels) offered to the user to select from.

methods - A list of methods (in the same order as the list of buttons) that will be called when a dialog selection is made.

 public void setWizardState(WizardState state)

Sets the WizardState reference of the wizard console

Parameters:

state - The new state for the wizard console.

 public WizardState getWizardState()

Returns the state of the wizard frame.

 public boolean hasGUI()

The WizardConsole has a gui. Indicate that images should be created.

 public static void main(String args[])

This main method is only provided for testing outside of the wizard archive. This should be removed before FCS.

All Packages  Class Hierarchy  This Package  Previous  Next  Index