org.xith3d.ui.hud.layout
Class BorderLayout

java.lang.Object
  extended by org.xith3d.ui.hud.layout.LayoutManagerBase
      extended by org.xith3d.ui.hud.layout.BorderSettableLayoutManagerBase
          extended by org.xith3d.ui.hud.layout.BorderLayout
All Implemented Interfaces:
BorderSettableLayoutManager, LayoutManager

public class BorderLayout
extends BorderSettableLayoutManagerBase

The BorderLayout potentially has five areas to place Widgets to. the NORTH, EAST, WEST and SOUTH earas and the CENTER. the CENTER always takes the whole remaining space. **************************** * NORTH * **************************** * * * * * WEST * CENTER * EAST * * * * * **************************** * SOUTH * ****************************


Nested Class Summary
static class BorderLayout.Area
           
 
Field Summary
 
Fields inherited from interface org.xith3d.ui.hud.layout.LayoutManager
IGNORED_BY_LAYOUT
 
Constructor Summary
BorderLayout()
           
BorderLayout(float hgap, float vgap)
           
BorderLayout(float borderBottom, float borderRight, float borderTop, float borderLeft)
           
BorderLayout(float hgap, float vgap, float borderBottom, float borderRight, float borderTop, float borderLeft)
           
 
Method Summary
 void addWidget(Widget widget, java.lang.Object constraints)
          Adds a new Widget to this LayoutManager with the given constraints.
 void clear()
          Clears the Widget List.
protected  void doLayout(float left0, float top0, float containerResX, float containerResY)
          
 float getHGap()
           
 float getVGap()
           
 void removeWidget(Widget widget)
          Removed a Widget from this LayoutManager
 void setHGap(float hgap)
           
 void setVGap(float vgap)
           
 
Methods inherited from class org.xith3d.ui.hud.layout.BorderSettableLayoutManagerBase
getBorderBottom, getBorderLeft, getBorderRight, getBorderTop, setBorderBottom, setBorderLeft, setBorderRight, setBorderTop
 
Methods inherited from class org.xith3d.ui.hud.layout.LayoutManagerBase
doLayout, getInvisibleWidgetsHidden, getWidgets, setInvisibleWidgetsHidden
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BorderLayout

public BorderLayout(float hgap,
                    float vgap,
                    float borderBottom,
                    float borderRight,
                    float borderTop,
                    float borderLeft)

BorderLayout

public BorderLayout(float hgap,
                    float vgap)

BorderLayout

public BorderLayout(float borderBottom,
                    float borderRight,
                    float borderTop,
                    float borderLeft)

BorderLayout

public BorderLayout()
Method Detail

setHGap

public void setHGap(float hgap)

getHGap

public final float getHGap()

setVGap

public void setVGap(float vgap)

getVGap

public final float getVGap()

addWidget

public void addWidget(Widget widget,
                      java.lang.Object constraints)
Adds a new Widget to this LayoutManager with the given constraints.

Specified by:
addWidget in interface LayoutManager
Overrides:
addWidget in class LayoutManagerBase
Parameters:
widget - the Widget to add
constraints - the constraints to use for this Widget in this LayoutManager

removeWidget

public void removeWidget(Widget widget)
Removed a Widget from this LayoutManager

Specified by:
removeWidget in interface LayoutManager
Overrides:
removeWidget in class LayoutManagerBase
Parameters:
widget - the Widget to be removed

clear

public void clear()
Clears the Widget List.

Specified by:
clear in interface LayoutManager
Overrides:
clear in class LayoutManagerBase

doLayout

protected void doLayout(float left0,
                        float top0,
                        float containerResX,
                        float containerResY)

Specified by:
doLayout in class LayoutManagerBase