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

java.lang.Object
  extended by org.xith3d.ui.hud.base.Widget.DescriptionBase
      extended by org.xith3d.ui.hud.widgets.Scrollbar.Description
Enclosing class:
Scrollbar

public static class Scrollbar.Description
extends Widget.DescriptionBase

This class is used to describe a (set of) Scrollbar Widget(s). You can pass it to the Scrollbar constructor. Modifications on the used instance after creating the Scrollbar Widget won't have any effect.


Constructor Summary
Scrollbar.Description(Scrollbar.Description desc)
          Clone-Constructor.
Scrollbar.Description(Scrollbar.Direction direction, java.lang.String backgroundTexture, java.lang.String handleLTTexture, java.lang.String handleRBTexture, java.lang.String handleBodyTexture, java.lang.String handleDecoTexture, java.lang.String decTexture, java.lang.String incTexture, boolean smoothScrolling)
          Creates a new Scrollbar.Description.
Scrollbar.Description(Scrollbar.Direction direction, Texture2D backgroundTexture, Texture2D handleLTTexture, Texture2D handleRBTexture, Texture2D handleBodyTexture, Texture2D handleDecoTexture, Texture2D decTexture, Texture2D incTexture, boolean smoothScrolling)
          Creates a new Scrollbar.Description.
 
Method Summary
 Scrollbar.Description clone()
           
 Texture2D getBackgroundTexture()
           
 Texture2D getDecrementTexture()
           
 Scrollbar.Direction getDirection()
           
 Texture2D getHandleBodyTexture()
           
 Texture2D getHandleDecoTexture()
           
 Texture2D getHandleLeftTopTexture()
           
 Texture2D getHandleRightBottomTexture()
           
 Texture2D getIncrementTexture()
           
 boolean getSmoothScrolling()
           
 void set(Scrollbar.Description desc)
          Clone-Constructor.
 void setBackgroundTexture(java.lang.String texture)
          Sets the background texture to use.
 void setBackgroundTexture(Texture2D texture)
          Sets the background texture to use.
 void setDecrementTexture(java.lang.String texture)
          Sets the texture to use for the decrement button.
 void setDecrementTexture(Texture2D texture)
          Sets the texture to use for the decrement button.
 void setDirection(Scrollbar.Direction direc)
          Sets the direction in which the Scrollbar scrolls.
 void setHandleTextures(java.lang.String handleLTTexture, java.lang.String handleRBTexture, java.lang.String handleBodyTexture, java.lang.String handleDecoTexture)
          Sets the textures to use for the handle.
 void setHandleTextures(Texture2D handleLTTexture, Texture2D handleRBTexture, Texture2D handleBodyTexture, Texture2D handleDecoTexture)
          Sets the textures to use for the handle.
 void setIncrementTexture(java.lang.String texture)
          Sets the texture to use for the increment button.
 void setIncrementTexture(Texture2D texture)
          Sets the texture to use for the increment button.
 void setSmoothScrolling(boolean b)
          If true, the handle doesn't snap to discrete positiones depending on the available scroll values.
 
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

Scrollbar.Description

public Scrollbar.Description(Scrollbar.Description desc)
Clone-Constructor.

Parameters:
desc - the original to be duplicated

Scrollbar.Description

public Scrollbar.Description(Scrollbar.Direction direction,
                             Texture2D backgroundTexture,
                             Texture2D handleLTTexture,
                             Texture2D handleRBTexture,
                             Texture2D handleBodyTexture,
                             Texture2D handleDecoTexture,
                             Texture2D decTexture,
                             Texture2D incTexture,
                             boolean smoothScrolling)
Creates a new Scrollbar.Description.

Parameters:
direction - the direction in which the Scrollbar scrolls
backgroundTexture - the background texture to use
handleLTTexture - the handle texture to use
handleRBTexture - the handle texture to use
handleBodyTexture - the handle texture to use
handleDecoTexture - the handle texture to use
decTexture - the decrement button texture to use
incTexture - the decrement button texture to use
smoothScrolling - use smooth scrolling?

Scrollbar.Description

public Scrollbar.Description(Scrollbar.Direction direction,
                             java.lang.String backgroundTexture,
                             java.lang.String handleLTTexture,
                             java.lang.String handleRBTexture,
                             java.lang.String handleBodyTexture,
                             java.lang.String handleDecoTexture,
                             java.lang.String decTexture,
                             java.lang.String incTexture,
                             boolean smoothScrolling)
Creates a new Scrollbar.Description.

Parameters:
direction - the direction in which the Scrollbar scrolls
backgroundTexture - the background texture to use
handleLTTexture - the handle texture to use
handleRBTexture - the handle texture to use
handleBodyTexture - the handle texture to use
handleDecoTexture - the handle texture to use
decTexture - the decrement button texture to use
incTexture - the decrement button texture to use
smoothScrolling - use smooth scrolling?
Method Detail

setDirection

public void setDirection(Scrollbar.Direction direc)
Sets the direction in which the Scrollbar scrolls.


getDirection

public final Scrollbar.Direction getDirection()
Returns:
the direction in which the Scrollbar scrolls.

setBackgroundTexture

public void setBackgroundTexture(Texture2D texture)
Sets the background texture to use.

Parameters:
texture - the texture

setBackgroundTexture

public final void setBackgroundTexture(java.lang.String texture)
Sets the background texture to use.

Parameters:
texture - the texture

getBackgroundTexture

public final Texture2D getBackgroundTexture()
Returns:
the background texture to use

setIncrementTexture

public void setIncrementTexture(Texture2D texture)
Sets the texture to use for the increment button.

Parameters:
texture - the texture

setIncrementTexture

public final void setIncrementTexture(java.lang.String texture)
Sets the texture to use for the increment button.

Parameters:
texture - the texture

getIncrementTexture

public final Texture2D getIncrementTexture()
Returns:
the texture to use for the increment button

setDecrementTexture

public void setDecrementTexture(Texture2D texture)
Sets the texture to use for the decrement button.

Parameters:
texture - the texture

setDecrementTexture

public final void setDecrementTexture(java.lang.String texture)
Sets the texture to use for the decrement button.

Parameters:
texture - the texture

getDecrementTexture

public final Texture2D getDecrementTexture()
Returns:
the texture to use for the decrement button

setHandleTextures

public void setHandleTextures(Texture2D handleLTTexture,
                              Texture2D handleRBTexture,
                              Texture2D handleBodyTexture,
                              Texture2D handleDecoTexture)
Sets the textures to use for the handle.

Parameters:
handleLTTexture; -
handleRBTexture; -
handleBodyTexture; -
handleDecoTexture; -

setHandleTextures

public final void setHandleTextures(java.lang.String handleLTTexture,
                                    java.lang.String handleRBTexture,
                                    java.lang.String handleBodyTexture,
                                    java.lang.String handleDecoTexture)
Sets the textures to use for the handle.

Parameters:
handleLTTexture; -
handleRBTexture; -
handleBodyTexture; -
handleDecoTexture; -

getHandleLeftTopTexture

public final Texture2D getHandleLeftTopTexture()
Returns:
the texture to use for the left or top part of the handle.

getHandleRightBottomTexture

public final Texture2D getHandleRightBottomTexture()
Returns:
the texture to use for the right or bottom part of the handle.

getHandleBodyTexture

public final Texture2D getHandleBodyTexture()
Returns:
the texture to use for the body part of the handle.

getHandleDecoTexture

public final Texture2D getHandleDecoTexture()
Returns:
the texture to use for the handle decoration.

setSmoothScrolling

public void setSmoothScrolling(boolean b)
If true, the handle doesn't snap to discrete positiones depending on the available scroll values.

Parameters:
b - enable/disable

getSmoothScrolling

public final boolean getSmoothScrolling()
Returns:
true, if the handle doesn't snap to discrete positiones depending on the available scroll values.

set

public void set(Scrollbar.Description desc)
Clone-Constructor.

Parameters:
desc - the original to be duplicated

clone

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