org.jdesktop.wonderland.client.hud
Interface HUDDialog

All Superinterfaces:
HUDComponent, HUDEventSource, HUDObject

public interface HUDDialog
extends HUDComponent

A generic dialog type.

Author:
nsimpson

Nested Class Summary
static class HUDDialog.BUTTONS
           
static class HUDDialog.DIALOG_MODE
           
static class HUDDialog.MESSAGE_TYPE
           
 
Nested classes/interfaces inherited from interface org.jdesktop.wonderland.client.hud.HUDObject
HUDObject.DisplayMode
 
Method Summary
 void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
          Adds a bound property listener to the dialog
 HUDDialog.BUTTONS getButtons()
          Gets which buttons are displayed
 java.lang.String getMessage()
          Gets the string displayed on the text field label
 HUDDialog.DIALOG_MODE getMode()
          Gets the mode of the dialog
 HUDDialog.MESSAGE_TYPE getType()
          Gets the type of the dialog
 java.lang.String getValue()
          Gets the string entered by the user in the text field
 void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
          Removes a bound property listener from the dialog
 void setButtons(HUDDialog.BUTTONS buttons)
          Sets which buttons to display: none, OK only, or OK and Cancel
 void setMessage(java.lang.String text)
          Sets the string to be displayed on the text field label
 void setMode(HUDDialog.DIALOG_MODE mode)
          Sets the mode of the dialog HUD dialogs can have two modes: MESSAGE to display an informational message, or INPUT to prompt the user for (text) input
 void setType(HUDDialog.MESSAGE_TYPE type)
          Sets the type of the dialog HUD dialogs can have 4 types: INFO, WARNING, ERROR or QUERY.
 void setValue(java.lang.String text)
          Sets the string displayed in the text field
 
Methods inherited from interface org.jdesktop.wonderland.client.hud.HUDObject
changeTransparency, changeTransparency, getBounds, getDecoratable, getDisplayMode, getHeight, getIcon, getLocation, getName, getPreferredLocation, getPreferredTransparency, getSize, getTransparency, getWidth, getWorldLocation, getX, getY, hasControl, isEnabled, isMinimized, isVisible, isWorldVisible, setBounds, setBounds, setClosed, setDecoratable, setDisplayMode, setEnabled, setHeight, setIcon, setLocation, setLocation, setLocation, setMaximized, setMinimized, setName, setPreferredLocation, setPreferredTransparency, setSize, setSize, setTransparency, setVisible, setVisible, setWidth, setWorldLocation, setWorldVisible, setWorldVisible, setX, setY
 
Methods inherited from interface org.jdesktop.wonderland.client.hud.HUDEventSource
addEventListener, getEventListeners, notifyEventListeners, notifyEventListeners, removeEventListener
 

Method Detail

setMode

void setMode(HUDDialog.DIALOG_MODE mode)
Sets the mode of the dialog HUD dialogs can have two modes: MESSAGE to display an informational message, or INPUT to prompt the user for (text) input

Parameters:
mode - the desired mode: MESSAGE or INPUT

getMode

HUDDialog.DIALOG_MODE getMode()
Gets the mode of the dialog

Returns:
the dialog mode: MESSAGE or INPUT

setType

void setType(HUDDialog.MESSAGE_TYPE type)
Sets the type of the dialog HUD dialogs can have 4 types: INFO, WARNING, ERROR or QUERY. The mode specifies the icon to be displayed on the dialog.

Parameters:
type -

getType

HUDDialog.MESSAGE_TYPE getType()
Gets the type of the dialog

Returns:
the dialog type: INFO, WARNING, ERROR or QUERY

setButtons

void setButtons(HUDDialog.BUTTONS buttons)
Sets which buttons to display: none, OK only, or OK and Cancel

Parameters:
buttons - the buttons to display

getButtons

HUDDialog.BUTTONS getButtons()
Gets which buttons are displayed

Returns:
the displayed buttons: NONE, OK, or OK_CANCEL

setMessage

void setMessage(java.lang.String text)
Sets the string to be displayed on the text field label

Parameters:
text - the string to display

getMessage

java.lang.String getMessage()
Gets the string displayed on the text field label

Returns:
the text field label

setValue

void setValue(java.lang.String text)
Sets the string displayed in the text field

Parameters:
text - the string to display

getValue

java.lang.String getValue()
Gets the string entered by the user in the text field

Returns:
the text field string

addPropertyChangeListener

void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
Adds a bound property listener to the dialog

Parameters:
listener - a listener for dialog events

removePropertyChangeListener

void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
Removes a bound property listener from the dialog

Parameters:
listener - the listener to remove


Open Wonderland - http://openwonderland.org