All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.sun.wizards.panels.QueryPanel

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

public class QueryPanel
extends WizardLeaf
The QueryPanel presents the user with a question and a place to type in an answer.


Constructor Index

 o QueryPanel()
Creates a QueryPanel with no name.
 o QueryPanel(String, Route, WizardTreeManager)
Creates a QueryPanel with the specified name, the specified route and wizard manager.
 o QueryPanel(WizardState, String)
Creates a QueryPanel with the specified name for the specified application.
 o QueryPanel(WizardState, String, Msg, Msg, char)
Creates a QueryPanel with the specified name for the specified application.

Method Index

 o addRuntimeResources(Vector)
Get the runtime classes required by this panel.
 o createUI()
This method creates the user interface for the QueryPanel.
 o deserialize(DataInput)
Deserialize this panel from the specified input stream.
 o getAnswer()
Gets the answer from the text that the user entered
 o getEchoChar()
Gets the echo char of this query panel.
 o getQuestion()
Gets the question of this query panel, in the form of a localizable message.
 o getTitle()
Gets the title of this query panel, in the form of a localizable message.
 o isDisplayComplete()
Returns true if this QueryPanel is finished displaying.
 o serialize(DataOutput)
Serialize this panel to the specified output stream.
 o setEchoChar(char)
Sets the echo character of this query panel.
 o setQuestion(Msg)
Sets the question of this query panel, in the form of a localizable message.
 o setTitle(Msg)
Sets the title of this query panel, in the form of a localizable message.

Constructors

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

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

Parameters:
wizardState - The buildtime WizardState.
name - The name for this panel.
 o QueryPanel
 public QueryPanel(WizardState wizardState,
                   String name,
                   Msg title,
                   Msg question,
                   char echoChar)
Creates a QueryPanel with the specified name for the specified application.

Parameters:
wizardState - The buildtime WizardState.
name - The name for this panel.
title - The title to be shown to the user
question - The question to be posed to the user.
echoChar - For each character typed in the answer field, this character will by displayed.
 o QueryPanel
 public QueryPanel(String name,
                   Route route,
                   WizardTreeManager wizardManager)
Creates a QueryPanel with the specified name, the specified route and wizard manager.

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

Methods

 o getTitle
 public Msg getTitle()
Gets the title of this query panel, in the form of a localizable message.

Returns:
The title of this query panel
 o setTitle
 public void setTitle(Msg title)
Sets the title of this query panel, in the form of a localizable message.

Parameters:
title - The title of this query panel
 o getEchoChar
 public char getEchoChar()
Gets the echo char of this query panel. This character is displayed in place of any typed characters.

Returns:
The echo character of this query panel
 o setEchoChar
 public void setEchoChar(char echoChar)
Sets the echo character of this query panel. This character is displayed in place of any typed characters.

Parameters:
echoChar - The echo character of this query panel
 o getQuestion
 public Msg getQuestion()
Gets the question of this query panel, in the form of a localizable message.

Returns:
The question of this query panel
 o setQuestion
 public void setQuestion(Msg question)
Sets the question of this query panel, in the form of a localizable message.

Parameters:
question - The question of this query panel
 o isDisplayComplete
 public boolean isDisplayComplete()
Returns true if this QueryPanel 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 getAnswer
 public String getAnswer()
Gets the answer from the text that the user entered

 o createUI
 public void createUI()
This method creates the user interface for the QueryPanel.

Overrides:
createUI in class WizardLeaf
 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 addRuntimeResources
 public void addRuntimeResources(Vector resourceVector)
Get the runtime classes required by this panel.

Overrides:
addRuntimeResources in class WizardLeaf

All Packages  Class Hierarchy  This Package  Previous  Next  Index