All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface com.sun.wizards.core.AppConsole

public interface AppConsole
AppConsole is the interface between wizard panels and the client-side running environment. This interface facilitates exiting the applet or application, as well as displaying user queries.


Method Index

 o displayQuery(Object, String, String, String[], String[])
Display a query to the user.
 o displayQuery(Object, String, String[], String[])
Display a query to the user.
 o exit()
Exit the applet/application. Deprecated.
 o exit(int)
Exit the applet/application with the specified exit status.
 o getWizardSize()
Returns the size of the wizard frame.
 o getWizardState()
Returns the state of the wizard frame.
 o hasGUI()
Returns true if this AppConsole object has a gui that can display images.
 o setFrameTitle(String)
Sets the title of the containing Frame to the specified value.
 o setIconImage(Image)
Set the icon image of the wizard frame.
 o setWizardSize(Dimension)
Sets the size of the wizard frame.
 o setWizardState(WizardState)
Sets the state of the wizard frame.

Methods

 o exit
 public abstract void exit()
Note: exit() is deprecated. Programs should now use exit(int).

Exit the applet/application.

 o exit
 public abstract 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.
 o displayQuery
 public abstract 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.
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.
 o displayQuery
 public abstract 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 dialog that appears
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.
 o hasGUI
 public abstract boolean hasGUI()
Returns true if this AppConsole object has a gui that can display images.

 o setFrameTitle
 public abstract void setFrameTitle(String title)
Sets the title of the containing Frame to the specified value.

Parameters:
title - The desired text to be displayed in the title.
 o setIconImage
 public abstract void setIconImage(Image icon)
Set the icon image of the wizard frame.

Parameters:
icon - The icon image to be displayed.
 o setWizardSize
 public abstract void setWizardSize(Dimension size)
Sets the size of the wizard frame.

Parameters:
size - The new size for the wizard frame.
 o getWizardSize
 public abstract Dimension getWizardSize()
Returns the size of the wizard frame.

 o setWizardState
 public abstract void setWizardState(WizardState state)
Sets the state of the wizard frame.

Parameters:
state - The new state for the wizard console.
 o getWizardState
 public abstract WizardState getWizardState()
Returns the state of the wizard frame.

Returns:
The current WizardState set in this console

All Packages  Class Hierarchy  This Package  Previous  Next  Index