org.jdesktop.wonderland.client.hud
Class HUDManager

java.lang.Object
  extended by org.jdesktop.wonderland.client.hud.HUDManager

public abstract class HUDManager
extends java.lang.Object

A manager for a set of HUDs.

Author:
nsimpson

Constructor Summary
HUDManager()
           
 
Method Summary
abstract  void addHUD(HUD hud)
          Adds a HUD to the set of managed HUDs
abstract  HUD getHUD(java.lang.String name)
          Gets a HUD by name
abstract  java.util.Iterator<HUD> getHUDs()
          Gets an iterator that will iterate over the current set of HUDs managed by the HUDManager
abstract  HUDLayoutManager getLayoutManager()
          Gets the layout manager
abstract  boolean isVisible(HUD hud)
          Gets whether a HUD is visible
abstract  void lowerHUD(HUD hud)
          Lower a HUD in the stacking order
abstract  void maximizeHUD(HUD hud)
          Maximize a HUD
abstract  void minimizeHUD(HUD hud)
          Minimize a HUD
abstract  void raiseHUD(HUD hud)
          Raise a HUD in the stacking order
abstract  void relayout()
          Force the layout manager to re-layout all the HUDs
abstract  void relayout(HUD hud)
          Force the layout manager to re-layout the specified HUD
abstract  void removeHUD(HUD hud)
          Removes a HUD from the set of managed HUDs
abstract  void setLayoutManager(HUDLayoutManager layout)
          Assigns a layout manager which determines how HUDs are laid out by the HUDManager
abstract  void setVisible(HUD hud, boolean visible)
          Change the visibility of a HUD
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

HUDManager

public HUDManager()
Method Detail

addHUD

public abstract void addHUD(HUD hud)
Adds a HUD to the set of managed HUDs

Parameters:
hud - the HUD to add

removeHUD

public abstract void removeHUD(HUD hud)
Removes a HUD from the set of managed HUDs

Parameters:
hud - the HUD to remove

getHUD

public abstract HUD getHUD(java.lang.String name)
Gets a HUD by name

Parameters:
name - the name of the HUD to get
Returns:
a HUD if there's a HUD with the specified name

getHUDs

public abstract java.util.Iterator<HUD> getHUDs()
Gets an iterator that will iterate over the current set of HUDs managed by the HUDManager

Returns:
an iterator for HUDs

setLayoutManager

public abstract void setLayoutManager(HUDLayoutManager layout)
Assigns a layout manager which determines how HUDs are laid out by the HUDManager

Parameters:
layout -

getLayoutManager

public abstract HUDLayoutManager getLayoutManager()
Gets the layout manager

Returns:
the HUDLayoutManager, if set

relayout

public abstract void relayout()
Force the layout manager to re-layout all the HUDs


relayout

public abstract void relayout(HUD hud)
Force the layout manager to re-layout the specified HUD

Parameters:
hud - the HUD to re-layout

setVisible

public abstract void setVisible(HUD hud,
                                boolean visible)
Change the visibility of a HUD

Parameters:
hud - the HUD to change
visible - true to make the HUD visible, false to make invisible

isVisible

public abstract boolean isVisible(HUD hud)
Gets whether a HUD is visible

Parameters:
hud - the hud to check for visibility
Returns:
the visibility of the specified HUD

minimizeHUD

public abstract void minimizeHUD(HUD hud)
Minimize a HUD

Parameters:
hud - the HUD to minimize

maximizeHUD

public abstract void maximizeHUD(HUD hud)
Maximize a HUD

Parameters:
hud - the HUD to maximize

raiseHUD

public abstract void raiseHUD(HUD hud)
Raise a HUD in the stacking order

Parameters:
hud - the HUD to raise

lowerHUD

public abstract void lowerHUD(HUD hud)
Lower a HUD in the stacking order

Parameters:
hud - the HUD to lower


Open Wonderland - http://openwonderland.org