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

java.lang.Object
  org.xith3d.ui.hud.base.Widget.DescriptionBase
      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)
Creates a new Scrollbar.Description.

Scrollbar.Description(Scrollbar.Direction direction, float size, java.lang.String backgroundTexture, java.lang.String handleTexture, float handleSize, int lower, int upper, boolean smoothScrolling)
Creates a new Scrollbar.Description.

Scrollbar.Description(Scrollbar.Direction direction, float size, java.lang.String backgroundTexture, java.lang.String handleTexture, float handleSize, java.lang.String decTexture, float decButtonSize, java.lang.String incTexture, float incButtonSize, int lower, int upper, boolean smoothScrolling)
Creates a new Scrollbar.Description.

Scrollbar.Description(Scrollbar.Direction direction, float size, Texture backgroundTexture, Texture handleTexture, float handleSize, int lower, int upper, boolean smoothScrolling)
Creates a new Scrollbar.Description.

Scrollbar.Description(Scrollbar.Direction direction, float size, Texture backgroundTexture, Texture handleTexture, float handleSize, Texture decTexture, float decButtonSize, Texture incTexture, float incButtonSize, int lower, int upper, boolean smoothScrolling)
Creates a new Scrollbar.Description.

Scrollbar.Description(Scrollbar.Direction direction, HUDUnitsMeasurement sizeMeasurement, float size, java.lang.String backgroundTexture, java.lang.String handleTexture, float handleSize, int lower, int upper, boolean smoothScrolling)
Creates a new Scrollbar.Description.

Scrollbar.Description(Scrollbar.Direction direction, HUDUnitsMeasurement sizeMeasurement, float size, java.lang.String backgroundTexture, java.lang.String handleTexture, float handleSize, java.lang.String decTexture, float decButtonSize, java.lang.String incTexture, float incButtonSize, int lower, int upper, boolean smoothScrolling)
Creates a new Scrollbar.Description.

Scrollbar.Description(Scrollbar.Direction direction, HUDUnitsMeasurement sizeMeasurement, float size, Texture backgroundTexture, Texture handleTexture, float handleSize, int lower, int upper, boolean smoothScrolling)
Creates a new Scrollbar.Description.

Scrollbar.Description(Scrollbar.Direction direction, HUDUnitsMeasurement sizeMeasurement, float size, Texture backgroundTexture, Texture handleTexture, float handleSize, Texture decTexture, float decButtonSize, Texture incTexture, float incButtonSize, int lower, int upper, boolean smoothScrolling)
Creates a new Scrollbar.Description.

Method Summary

Scrollbar.Description	clone()
Texture	getBackgroundTexture()
float	getDecrementButtonSize()
Texture	getDecrementTexture()
Scrollbar.Direction	getDirection()
float	getHandleButtonSize()
Texture	getHandleTexture()
float	getIncrementButtonSize()
Texture	getIncrementTexture()
int	getLower()
HUDUnitsMeasurement	getMeasurement()
float	getSize()
int	getSmallIncrement()
int	getUpper()
boolean	isSmoothScrolling()
void	set(Scrollbar.Description desc) Clone-Constructor.
void	setBackgroundTexture(java.lang.String texture) Sets the background texture to use.
void	setBackgroundTexture(Texture texture) Sets the background texture to use.
void	setDecrementButtonSize(float size) Sets the decrement button size (width or height).
void	setDecrementTexture(java.lang.String texture) Sets the texture to use for the decrement button.
void	setDecrementTexture(Texture texture) Sets the texture to use for the decrement button.
void	setDirection(Scrollbar.Direction direc) Sets the direction in which the Scrollbar scrolls.
void	setHandleButtonSize(float size) Sets the handle button size (width or height).
void	setHandleTexture(java.lang.String texture) Sets the texture to use for the handle.
void	setHandleTexture(Texture texture) Sets the texture to use for the handle.
void	setIncrementButtonSize(float size) Sets the increment button size (width or height).
void	setIncrementTexture(java.lang.String texture) Sets the texture to use for the increment button.
void	setIncrementTexture(Texture texture) Sets the texture to use for the increment button.
void	setLower(int lower) Sets the lower bound of scroll values.
void	setMeasurement(HUDUnitsMeasurement measure) Sets the measurement for increment-, decrement- and handle buttons.
void	setSize(float size) Sets the size (width or height).
void	setSmallIncrement(int value) Sets the step to increment the Scrollbar's value by when the increment button is clicked.
void	setSmoothScrolling(boolean b) If true, the handle doesn't snap to discrete positiones depending on the available scroll values.
void	setUpper(int upper) Sets the upper bound of 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,
                             HUDUnitsMeasurement sizeMeasurement,
                             float size,
                             Texture backgroundTexture,
                             Texture handleTexture,
                             float handleSize,
                             Texture decTexture,
                             float decButtonSize,
                             Texture incTexture,
                             float incButtonSize,
                             int lower,
                             int upper,
                             boolean smoothScrolling)

Creates a new Scrollbar.Description.

Parameters:

direction - the direction in which the Scrollbar scrolls

sizeMeasurement - the measurement for increment-, decrement- and handle buttons

size - the width or height of the Scrollbar

backgroundTexture - the background texture to use

handleTexture - the handle texture to use

handleSize - the size (width of height) of the handle

decTexture - the decrement button texture to use

decButtonSize - the size (width of height) of the decrement button

incTexture - the decrement button texture to use

incButtonSize - the size (width of height) of the increment button

lower - the lower value limit

upper - the upper value limit

smoothScrolling - use smooth scrolling?

Scrollbar.Description

public Scrollbar.Description(Scrollbar.Direction direction,
                             HUDUnitsMeasurement sizeMeasurement,
                             float size,
                             java.lang.String backgroundTexture,
                             java.lang.String handleTexture,
                             float handleSize,
                             java.lang.String decTexture,
                             float decButtonSize,
                             java.lang.String incTexture,
                             float incButtonSize,
                             int lower,
                             int upper,
                             boolean smoothScrolling)

Creates a new Scrollbar.Description.

Parameters:

direction - the direction in which the Scrollbar scrolls

sizeMeasurement - the measurement for increment-, decrement- and handle buttons

size - the width or height of the Scrollbar

backgroundTexture - the background texture to use

handleTexture - the handle texture to use

handleSize - the size (width of height) of the handle

decTexture - the decrement button texture to use

decButtonSize - the size (width of height) of the decrement button

incTexture - the decrement button texture to use

incButtonSize - the size (width of height) of the increment button

lower - the lower value limit

upper - the upper value limit

smoothScrolling - use smooth scrolling?

Scrollbar.Description

public Scrollbar.Description(Scrollbar.Direction direction,
                             float size,
                             Texture backgroundTexture,
                             Texture handleTexture,
                             float handleSize,
                             Texture decTexture,
                             float decButtonSize,
                             Texture incTexture,
                             float incButtonSize,
                             int lower,
                             int upper,
                             boolean smoothScrolling)

Creates a new Scrollbar.Description.

Parameters:

direction - the direction in which the Scrollbar scrolls

size - the width or height of the Scrollbar

backgroundTexture - the background texture to use

handleTexture - the handle texture to use

handleSize - the size (width of height) of the handle

decTexture - the decrement button texture to use

decButtonSize - the size (width of height) of the decrement button

incTexture - the decrement button texture to use

incButtonSize - the size (width of height) of the increment button

lower - the lower value limit

upper - the upper value limit

smoothScrolling - use smooth scrolling?

Scrollbar.Description

public Scrollbar.Description(Scrollbar.Direction direction,
                             float size,
                             java.lang.String backgroundTexture,
                             java.lang.String handleTexture,
                             float handleSize,
                             java.lang.String decTexture,
                             float decButtonSize,
                             java.lang.String incTexture,
                             float incButtonSize,
                             int lower,
                             int upper,
                             boolean smoothScrolling)

Creates a new Scrollbar.Description.

Parameters:

direction - the direction in which the Scrollbar scrolls

size - the width or height of the Scrollbar

backgroundTexture - the background texture to use

handleTexture - the handle texture to use

handleSize - the size (width of height) of the handle

decTexture - the decrement button texture to use

decButtonSize - the size (width of height) of the decrement button

incTexture - the decrement button texture to use

incButtonSize - the size (width of height) of the increment button

lower - the lower value limit

upper - the upper value limit

smoothScrolling - use smooth scrolling?

Scrollbar.Description

public Scrollbar.Description(Scrollbar.Direction direction,
                             HUDUnitsMeasurement sizeMeasurement,
                             float size,
                             Texture backgroundTexture,
                             Texture handleTexture,
                             float handleSize,
                             int lower,
                             int upper,
                             boolean smoothScrolling)

Creates a new Scrollbar.Description.

Parameters:

direction - the direction in which the Scrollbar scrolls

sizeMeasurement - the measurement for increment-, decrement- and handle buttons

size - the width or height of the Scrollbar

backgroundTexture - the background texture to use

handleTexture - the handle texture to use

handleSize - the size (width of height) of the handle

lower - the lower value limit

upper - the upper value limit

smoothScrolling - use smooth scrolling?

Scrollbar.Description

public Scrollbar.Description(Scrollbar.Direction direction,
                             HUDUnitsMeasurement sizeMeasurement,
                             float size,
                             java.lang.String backgroundTexture,
                             java.lang.String handleTexture,
                             float handleSize,
                             int lower,
                             int upper,
                             boolean smoothScrolling)

Creates a new Scrollbar.Description.

Parameters:

direction - the direction in which the Scrollbar scrolls

sizeMeasurement - the measurement for increment-, decrement- and handle buttons

size - the width or height of the Scrollbar

backgroundTexture - the background texture to use

handleTexture - the handle texture to use

handleSize - the size (width of height) of the handle

lower - the lower value limit

upper - the upper value limit

smoothScrolling - use smooth scrolling?

Scrollbar.Description

public Scrollbar.Description(Scrollbar.Direction direction,
                             float size,
                             Texture backgroundTexture,
                             Texture handleTexture,
                             float handleSize,
                             int lower,
                             int upper,
                             boolean smoothScrolling)

Creates a new Scrollbar.Description.

Parameters:

direction - the direction in which the Scrollbar scrolls

size - the width or height of the Scrollbar

backgroundTexture - the background texture to use

handleTexture - the handle texture to use

handleSize - the size (width of height) of the handle

lower - the lower value limit

upper - the upper value limit

smoothScrolling - use smooth scrolling?

Scrollbar.Description

public Scrollbar.Description(Scrollbar.Direction direction,
                             float size,
                             java.lang.String backgroundTexture,
                             java.lang.String handleTexture,
                             float handleSize,
                             int lower,
                             int upper,
                             boolean smoothScrolling)

Creates a new Scrollbar.Description.

Parameters:

direction - the direction in which the Scrollbar scrolls

backgroundTexture - the background texture to use

handleTexture - the handle texture to use

handleSize - the size (width of height) of the handle

lower - the lower value limit

upper - the upper value limit

smoothScrolling - use smooth scrolling?

Scrollbar.Description

public Scrollbar.Description(Scrollbar.Direction direction)

Creates a new Scrollbar.Description.

Parameters:

direction - the direction in which the Scrollbar scrolls

Method Detail

getDirection

public Scrollbar.Direction getDirection()

Returns:

the direction in which the Scrollbar scrolls.

setDirection

public void setDirection(Scrollbar.Direction direc)

Sets the direction in which the Scrollbar scrolls.

setMeasurement

public void setMeasurement(HUDUnitsMeasurement measure)

Sets the measurement for increment-, decrement- and handle buttons.

Parameters:

measure - the new measurement

getMeasurement

public HUDUnitsMeasurement getMeasurement()

Returns:

the measurement for increment-, decrement- and handle buttons

setBackgroundTexture

public void setBackgroundTexture(Texture texture)

Sets the background texture to use.

Parameters:

texture - the texture

setBackgroundTexture

public void setBackgroundTexture(java.lang.String texture)

Sets the background texture to use.

Parameters:

texture - the texture

getBackgroundTexture

public Texture getBackgroundTexture()

Returns:

the background texture to use

setSize

public void setSize(float size)

Sets the size (width or height).

Parameters:

size - the new size

getSize

public float getSize()

Returns:

the size (width or height)

setIncrementTexture

public void setIncrementTexture(Texture texture)

Sets the texture to use for the increment button.

Parameters:

texture - the texture

setIncrementTexture

public void setIncrementTexture(java.lang.String texture)

Sets the texture to use for the increment button.

Parameters:

texture - the texture

getIncrementTexture

public Texture getIncrementTexture()

Returns:

the texture to use for the increment button

setIncrementButtonSize

public void setIncrementButtonSize(float size)

Sets the increment button size (width or height).

Parameters:

size - the new size

getIncrementButtonSize

public float getIncrementButtonSize()

Returns:

the increment button size (width or height)

setDecrementTexture

public void setDecrementTexture(Texture texture)

Sets the texture to use for the decrement button.

Parameters:

texture - the texture

setDecrementTexture

public void setDecrementTexture(java.lang.String texture)

Sets the texture to use for the decrement button.

Parameters:

texture - the texture

getDecrementTexture

public Texture getDecrementTexture()

Returns:

the texture to use for the decrement button

setDecrementButtonSize

public void setDecrementButtonSize(float size)

Sets the decrement button size (width or height).

Parameters:

size - the new size

getDecrementButtonSize

public float getDecrementButtonSize()

Returns:

the decrement button size (width or height)

setHandleTexture

public void setHandleTexture(Texture texture)

Sets the texture to use for the handle.

Parameters:

texture - the texture

setHandleTexture

public void setHandleTexture(java.lang.String texture)

Sets the texture to use for the handle.

Parameters:

texture - the texture

getHandleTexture

public Texture getHandleTexture()

Returns:

the texture to use for the handle

setHandleButtonSize

public void setHandleButtonSize(float size)

Sets the handle button size (width or height).

Parameters:

size - the new size

getHandleButtonSize

public float getHandleButtonSize()

Returns:

the handle button size (width or height)

getLower

public int getLower()

Returns:

the lower bound of scroll values

setLower

public void setLower(int lower)

Sets the lower bound of scroll values.

getUpper

public int getUpper()

Returns:

the upper bound of scroll values

setUpper

public void setUpper(int upper)

Sets the upper bound of scroll values.

getSmallIncrement

public int getSmallIncrement()

Returns:

the step to increment the Scrollbar's value by when the increment button is clicked

setSmallIncrement

public void setSmallIncrement(int value)

Sets the step to increment the Scrollbar's value by when the increment button is clicked.

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

isSmoothScrolling

public boolean isSmoothScrolling()

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.