org.xith3d.ui.hud.base
Class Border.Description

java.lang.Object
  extended by org.xith3d.ui.hud.base.Widget.DescriptionBase
      extended by org.xith3d.ui.hud.base.Border.Description
Enclosing interface:
Border

public static class Border.Description
extends Widget.DescriptionBase

This class is used to describe a Border Widget. You can pass it to the Border constructor. Modifications on the used instance after creating the Border Widget won't have any effect.


Constructor Summary
Border.Description(Border.Description bd)
          Clone-Contructor
Border.Description(float width, org.openmali.vecmath2.Colorf color)
           
Border.Description(float bottom, float right, float top, float left)
           
Border.Description(float bottom, float right, float top, float left, org.openmali.vecmath2.Colorf color)
           
Border.Description(float bottom, float right, float top, float left, float heightLLupper, float widthLLright, float widthLRleft, float heightLRupper, float heightURlower, float widthURleft, float widthULright, float heightULlower, java.lang.String texture)
           
Border.Description(float bottom, float right, float top, float left, float heightLLupper, float widthLLright, float widthLRleft, float heightLRupper, float heightURlower, float widthURleft, float widthULright, float heightULlower, Texture texture)
           
Border.Description(float bottom, float right, float top, float left, java.lang.String texture)
           
Border.Description(float bottom, float right, float top, float left, Texture texture)
           
 
Method Summary
 Border.Description clone()
           
 float getBottomHeight()
           
 org.openmali.vecmath2.Colorf getColor()
           
 float getLeftWidth()
           
 float getLLrightWidth()
           
 float getLLupperHeight()
           
 float getLRleftWidth()
           
 float getLRupperHeight()
           
 HUDUnitsMeasurement getMeasurement()
           
 float getRightWidth()
           
 Texture getTexture()
           
 float getTopHeight()
           
 float getULlowerHeight()
           
 float getULrightWidth()
           
 float getURleftWidth()
           
 float getURlowerHeight()
           
 boolean hasNonZeroSize()
           
 void set(Border.Description bd)
          Clone-Constructor
 void setBottomHeight(float bh)
           
 void setColor(org.openmali.vecmath2.Colorf color)
           
 void setLeftWidth(float lw)
           
 void setLLrightWidth(float value)
           
 void setLLupperHeight(float value)
           
 void setLRleftWidth(float value)
           
 void setLRupperHeight(float value)
           
 void setMeasurement(HUDUnitsMeasurement measurement)
           
 void setRightWidth(float rw)
           
 void setSizes(float bottom, float right, float top, float left)
           
 void setSizes(float bottom, float right, float top, float left, float heightLLupper, float widthLLright, float widthLRleft, float heightLRupper, float heightURlower, float widthURleft, float widthULright, float heightULlower)
           
 Texture setTexture(java.lang.String texture)
           
 void setTexture(Texture texture)
           
 void setTopHeight(float th)
           
 void setULlowerHeight(float value)
           
 void setULrightWidth(float value)
           
 void setURleftWidth(float value)
           
 void setURlowerHeight(float value)
           
 
Methods inherited from class org.xith3d.ui.hud.base.Widget.DescriptionBase
toString
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Border.Description

public Border.Description(Border.Description bd)
Clone-Contructor

Parameters:
bd - the original to be duplicated

Border.Description

public Border.Description(float bottom,
                          float right,
                          float top,
                          float left,
                          float heightLLupper,
                          float widthLLright,
                          float widthLRleft,
                          float heightLRupper,
                          float heightURlower,
                          float widthURleft,
                          float widthULright,
                          float heightULlower,
                          Texture texture)

Border.Description

public Border.Description(float bottom,
                          float right,
                          float top,
                          float left,
                          Texture texture)

Border.Description

public Border.Description(float bottom,
                          float right,
                          float top,
                          float left,
                          float heightLLupper,
                          float widthLLright,
                          float widthLRleft,
                          float heightLRupper,
                          float heightURlower,
                          float widthURleft,
                          float widthULright,
                          float heightULlower,
                          java.lang.String texture)

Border.Description

public Border.Description(float bottom,
                          float right,
                          float top,
                          float left,
                          java.lang.String texture)

Border.Description

public Border.Description(float bottom,
                          float right,
                          float top,
                          float left)

Border.Description

public Border.Description(float bottom,
                          float right,
                          float top,
                          float left,
                          org.openmali.vecmath2.Colorf color)

Border.Description

public Border.Description(float width,
                          org.openmali.vecmath2.Colorf color)
Method Detail

setMeasurement

public void setMeasurement(HUDUnitsMeasurement measurement)

getMeasurement

public HUDUnitsMeasurement getMeasurement()

hasNonZeroSize

public boolean hasNonZeroSize()

setBottomHeight

public void setBottomHeight(float bh)

getBottomHeight

public float getBottomHeight()

setRightWidth

public void setRightWidth(float rw)

getRightWidth

public float getRightWidth()

setTopHeight

public void setTopHeight(float th)

getTopHeight

public float getTopHeight()

setLeftWidth

public void setLeftWidth(float lw)

getLeftWidth

public float getLeftWidth()

setLLupperHeight

public void setLLupperHeight(float value)

getLLupperHeight

public float getLLupperHeight()

setLLrightWidth

public void setLLrightWidth(float value)

getLLrightWidth

public float getLLrightWidth()

setLRleftWidth

public void setLRleftWidth(float value)

getLRleftWidth

public float getLRleftWidth()

setLRupperHeight

public void setLRupperHeight(float value)

getLRupperHeight

public float getLRupperHeight()

setURlowerHeight

public void setURlowerHeight(float value)

getURlowerHeight

public float getURlowerHeight()

setURleftWidth

public void setURleftWidth(float value)

getURleftWidth

public float getURleftWidth()

setULrightWidth

public void setULrightWidth(float value)

getULrightWidth

public float getULrightWidth()

setULlowerHeight

public void setULlowerHeight(float value)

getULlowerHeight

public float getULlowerHeight()

setSizes

public void setSizes(float bottom,
                     float right,
                     float top,
                     float left)

setSizes

public void setSizes(float bottom,
                     float right,
                     float top,
                     float left,
                     float heightLLupper,
                     float widthLLright,
                     float widthLRleft,
                     float heightLRupper,
                     float heightURlower,
                     float widthURleft,
                     float widthULright,
                     float heightULlower)

setColor

public void setColor(org.openmali.vecmath2.Colorf color)

getColor

public org.openmali.vecmath2.Colorf getColor()

setTexture

public void setTexture(Texture texture)

setTexture

public Texture setTexture(java.lang.String texture)

getTexture

public Texture getTexture()

set

public void set(Border.Description bd)
Clone-Constructor

Parameters:
bd - the original to be duplicated

clone

public Border.Description clone()
Overrides:
clone in class java.lang.Object
Returns:
a clone of this instance.