org.jdesktop.wonderland.client.hud
Interface HUDManagerSPI


public interface HUDManagerSPI

The HUDManager manages visual display of a collection of HUD intances for a Wonderland client. For a HUD to be displayed, it must be managed by a HUDManager. The HUDManager is analogous to a Window Manager of a 2D desktop.

Author:
nsimpson

Method Summary
 void addHUD(HUD hud)
          Adds a HUD to the set of managed HUDs
 HUD getHUD(java.lang.String name)
          Gets a HUD by name
 java.util.Iterator<HUD> getHUDs()
          Gets an iterator that will iterate over the current set of HUDs managed by the HUDManager
 HUDLayoutManager getLayoutManager()
          Gets the layout manager
 void hideHUD(HUD hud)
          Hide a HUD
 boolean isHUDShowing(HUD hud)
          Gets whether the HUD manager is showing a specified HUD
 void lowerHUD(HUD hud)
          Lower a HUD in the stacking order
 void maximizeHUD(HUD hud)
          Maximize a HUD
 void minimizeHUD(HUD hud)
          Minimize a HUD
 void raiseHUD(HUD hud)
          Raise a HUD in the stacking order
 void removeHUD(HUD hud)
          Removes a HUD from the set of managed HUDs
 void setLayoutManager(HUDLayoutManager layout)
          Assigns a layout manager which determines how HUDs are laid out by the HUDManager
 void showHUD(HUD hud)
          Show a HUD
 

Method Detail

addHUD

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

Parameters:
hud - the HUD to add

removeHUD

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

Parameters:
hud - the HUD to remove

getHUD

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

Parameters:
name - the name of the HUD to get
Returns:
the HUD with the specified name

getHUDs

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

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

Parameters:
layout -

getLayoutManager

HUDLayoutManager getLayoutManager()
Gets the layout manager

Returns:
the HUDLayoutManager, if set

showHUD

void showHUD(HUD hud)
Show a HUD

Parameters:
hud - the HUD to show

hideHUD

void hideHUD(HUD hud)
Hide a HUD

Parameters:
hud - the HUD to hide

isHUDShowing

boolean isHUDShowing(HUD hud)
Gets whether the HUD manager is showing a specified HUD

Parameters:
hud - the HUD to check for visibility
Returns:
true if the HUD is showing, false if the HUD is hidden

minimizeHUD

void minimizeHUD(HUD hud)
Minimize a HUD

Parameters:
hud - the HUD to minimize

maximizeHUD

void maximizeHUD(HUD hud)
Maximize a HUD

Parameters:
hud - the HUD to maximize

raiseHUD

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

Parameters:
hud - the HUD to raise

lowerHUD

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

Parameters:
hud - the HUD to lower


Open Wonderland - http://openwonderland.org