Package de.lessvoid.nifty.controls

Interface Scrollbar

All Superinterfaces:

NiftyControl

All Known Implementing Classes:

ScrollbarControl

public interface Scrollbar
extends NiftyControl

Scrollbar.

Author:

void

Method Summary

Modifier and Type	Method	Description
float	getButtonStepSize()	Get the current button step size.
float	getPageStepSize()	Get the current page size.
float	getValue()	Get the current value of the scrollbar.
float	getWorldMax()	Get the current maximum of the scrollbar.
float	getWorldPageSize()	Get the current page size
void	setButtonStepSize(float stepSize)	Set the button step size to a new value.
void	setPageStepSize(float stepSize)	Set a new page size for page up/down and clicks on the background.
void	setup(float value, float worldMax, float worldPageSize, float buttonStepSize, float pageStepSize)	Setup all parameters of this Scrollbar.
void	setValue(float value)	Change the value of the scrollbar.
void	setWorldMax(float worldMax)	Set the new maximum of the scrollbar.
void	setWorldPageSize(float worldPageSize)	Set the new page size

Methods inherited from interface de.lessvoid.nifty.controls.NiftyControl

disable, enable, getElement, getHeight, getId, getStyle, getWidth, hasFocus, isBound, isEnabled, layoutCallback, setEnabled, setFocus, setFocusable, setHeight, setId, setStyle, setWidth

Method Detail

setup

void setup(float value,
           float worldMax,
           float worldPageSize,
           float buttonStepSize,
           float pageStepSize)

Setup all parameters of this Scrollbar.

Parameters:

value - the initial value

worldMax - the maximum value

worldPageSize - the page size

buttonStepSize - the step size for button clicks

pageStepSize - the step size for page up/down or clicks on the scrollbar background

setValue

void setValue(float value)

Change the value of the scrollbar.

Parameters:

value - the new value

getValue

float getValue()

Get the current value of the scrollbar.

setWorldMax

void setWorldMax(float worldMax)

Set the new maximum of the scrollbar.

Parameters:

worldMax - new maximum

getWorldMax

float getWorldMax()

Get the current maximum of the scrollbar.

Returns:

current world max

setWorldPageSize

void setWorldPageSize(float worldPageSize)

Set the new page size

Parameters:

worldPageSize - new page size

getWorldPageSize

float getWorldPageSize()

Get the current page size

Returns:

current page size

setButtonStepSize

void setButtonStepSize(float stepSize)

Set the button step size to a new value.

Parameters:

stepSize - step size

getButtonStepSize

float getButtonStepSize()

Get the current button step size.

Returns:

step size

setPageStepSize

void setPageStepSize(float stepSize)

Set a new page size for page up/down and clicks on the background.

Parameters:

stepSize - new step size

getPageStepSize

float getPageStepSize()

Get the current page size.

Returns:

page size