org.xith3d.ui.hud.widgets
Class List.Description

java.lang.Object
  extended by org.xith3d.ui.hud.base.Widget.DescriptionBase
      extended by org.xith3d.ui.hud.widgets.List.Description
Enclosing class:
List<Item extends Widget>

public static class List.Description
extends Widget.DescriptionBase

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


Constructor Summary
List.Description()
          Creates a new Image.Description
List.Description(org.openmali.vecmath2.Colorf color)
          Creates a new Image.Description
List.Description(List.Description template)
          Clone-Constructor.
List.Description(java.lang.String texture)
          Creates a new Image.Description
List.Description(Texture texture)
          Creates a new Image.Description
List.Description(Texture texture, org.openmali.vecmath2.Colorf color)
          Creates a new Image.Description
 
Method Summary
 List.Description clone()
          Clones this instance and returns the clone.
 org.openmali.vecmath2.Colorf getBackgroundColor()
           
 Texture getBackgroundTexture()
           
 Border.Description getBorderDescription()
           
 org.openmali.vecmath2.Colorf getHoverBackground()
           
 org.openmali.vecmath2.Colorf getHoverForeground()
           
 HUDUnitsMeasurement getMeasurement()
           
 float getPaddingBottom()
           
 float getPaddingLeft()
           
 float getPaddingRight()
           
 float getPaddingTop()
           
 org.openmali.vecmath2.Colorf getSelectionBackground()
           
 org.openmali.vecmath2.Colorf getSelectionForeground()
           
 void set(List.Description template)
           
 void setBackgroundColor(org.openmali.vecmath2.Colorf color)
           
 void setBackgroundTexture(java.lang.String texture)
           
 void setBackgroundTexture(Texture texture)
           
 void setBorderDescription(Border.Description borderDesc)
           
 void setHoverBackground(org.openmali.vecmath2.Colorf color)
           
 void setHoverForeground(org.openmali.vecmath2.Colorf color)
           
 void setMeasurement(HUDUnitsMeasurement measurement)
           
 void setPadding(float padding)
           
 void setPadding(float bottom, float right, float top, float left)
           
 void setSelectionBackground(org.openmali.vecmath2.Colorf color)
           
 void setSelectionForeground(org.openmali.vecmath2.Colorf color)
           
 
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

List.Description

public List.Description(List.Description template)
Clone-Constructor.

Parameters:
template - the template Description to copy the values from

List.Description

public List.Description(Texture texture,
                        org.openmali.vecmath2.Colorf color)
Creates a new Image.Description

Parameters:
texture - the texture resource to use as background image for this FPSCounter
Make suse this texture supports alpha channel (e.g. PNG).
color - the color to fill the image with

List.Description

public List.Description(Texture texture)
Creates a new Image.Description

Parameters:
texture - the texture resource to use as background image for this FPSCounter
Make suse this texture supports alpha channel (e.g. PNG).

List.Description

public List.Description(java.lang.String texture)
Creates a new Image.Description

Parameters:
texture - the texture resource to use as background image for this FPSCounter
Make suse this texture supports alpha channel (e.g. PNG).

List.Description

public List.Description(org.openmali.vecmath2.Colorf color)
Creates a new Image.Description

Parameters:
color - the color to fill the image with

List.Description

public List.Description()
Creates a new Image.Description

Method Detail

setMeasurement

public void setMeasurement(HUDUnitsMeasurement measurement)

getMeasurement

public HUDUnitsMeasurement getMeasurement()

setBorderDescription

public void setBorderDescription(Border.Description borderDesc)

getBorderDescription

public Border.Description getBorderDescription()

setPadding

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

setPadding

public void setPadding(float padding)

getPaddingBottom

public float getPaddingBottom()

getPaddingRight

public float getPaddingRight()

getPaddingTop

public float getPaddingTop()

getPaddingLeft

public float getPaddingLeft()

setBackgroundTexture

public void setBackgroundTexture(Texture texture)

setBackgroundTexture

public void setBackgroundTexture(java.lang.String texture)

getBackgroundTexture

public Texture getBackgroundTexture()

setBackgroundColor

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

getBackgroundColor

public org.openmali.vecmath2.Colorf getBackgroundColor()

setHoverBackground

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

getHoverBackground

public org.openmali.vecmath2.Colorf getHoverBackground()

setHoverForeground

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

getHoverForeground

public org.openmali.vecmath2.Colorf getHoverForeground()

setSelectionBackground

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

getSelectionBackground

public org.openmali.vecmath2.Colorf getSelectionBackground()

setSelectionForeground

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

getSelectionForeground

public org.openmali.vecmath2.Colorf getSelectionForeground()

set

public void set(List.Description template)

clone

public List.Description clone()
Clones this instance and returns the clone.

Overrides:
clone in class java.lang.Object