org.jdesktop.wonderland.client.hud
Interface HUDComponentManager

All Superinterfaces:
HUDEventListener

public interface HUDComponentManager
extends HUDEventListener

A manager for a set of HUDComponents.

Author:
nsimpson

Method Summary
 void addComponent(HUDComponent component)
          Adds a HUDComponent to the set of components to be managed
 java.util.Iterator<HUDComponent> getComponents()
          Gets an interator for the set of managed components
 int getComponentZOrder(HUDComponent component)
          Get's the stacking order of the specified HUDComponent
 HUDLayoutManager getLayoutManager()
          Gets the current layout manager
 boolean isVisible(HUDComponent component)
          Gets whether a HUDComponent is visible
 void lowerComponent(HUDComponent component)
          Lower a HUDComponent one level in the stacking order
 void maximizeComponent(HUDComponent component)
          Maximize a HUDComponent
 void minimizeComponent(HUDComponent component)
          Minimize a HUDComponent
 void raiseComponent(HUDComponent component)
          Raise a HUDComponent one level in the stacking order
 void relayout()
          Force the layout manager to re-layout all the HUDComponents on the HUD
 void relayout(HUDComponent component)
          Force the layout manager to re-layout the specified HUDComponent
 void removeComponent(HUDComponent component)
          Removes a HUDComponent from the set of managed components
 void setLayoutManager(HUDLayoutManager layout)
          Sets the layout manager responsible for positioning HUDComponents in a HUD
 void setVisible(HUDComponent component, boolean visible)
          Change the visibility of a HUDComponent
 
Methods inherited from interface org.jdesktop.wonderland.client.hud.HUDEventListener
HUDObjectChanged
 

Method Detail

addComponent

void addComponent(HUDComponent component)
Adds a HUDComponent to the set of components to be managed

Parameters:
component - a HUDComponent to manage

removeComponent

void removeComponent(HUDComponent component)
Removes a HUDComponent from the set of managed components

Parameters:
component - the HUDComponent to remove

getComponents

java.util.Iterator<HUDComponent> getComponents()
Gets an interator for the set of managed components

Returns:
an iterator for managed HUDComponents

setLayoutManager

void setLayoutManager(HUDLayoutManager layout)
Sets the layout manager responsible for positioning HUDComponents in a HUD

Parameters:
layout - a HUD layout manager

getLayoutManager

HUDLayoutManager getLayoutManager()
Gets the current layout manager

Returns:
the current layout manager

relayout

void relayout()
Force the layout manager to re-layout all the HUDComponents on the HUD


relayout

void relayout(HUDComponent component)
Force the layout manager to re-layout the specified HUDComponent

Parameters:
component - the component to re-layout

setVisible

void setVisible(HUDComponent component,
                boolean visible)
Change the visibility of a HUDComponent

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

isVisible

boolean isVisible(HUDComponent component)
Gets whether a HUDComponent is visible

Parameters:
component - the component to check for visibility
Returns:
the visibility of the component

minimizeComponent

void minimizeComponent(HUDComponent component)
Minimize a HUDComponent

Parameters:
component - the component to minimize

maximizeComponent

void maximizeComponent(HUDComponent component)
Maximize a HUDComponent

Parameters:
component - the component to maximize

raiseComponent

void raiseComponent(HUDComponent component)
Raise a HUDComponent one level in the stacking order

Parameters:
component - the component to raise

lowerComponent

void lowerComponent(HUDComponent component)
Lower a HUDComponent one level in the stacking order

Parameters:
component - the component to lower

getComponentZOrder

int getComponentZOrder(HUDComponent component)
Get's the stacking order of the specified HUDComponent

Parameters:
component - the component to query for its z-order
Returns:
the stacking order of the component


Open Wonderland - http://openwonderland.org