Class GUISlider<T>

java.lang.Object

com.blackrook.gui.GUIObject

com.blackrook.gui.object.GUIPanel

com.blackrook.gui.object.GUIGlassPanel

com.blackrook.gui.object.GUISlider<T>

Type Parameters:

T - the value type.

All Implemented Interfaces:

GUIValueField<T>

public class GUISlider<T>
extends GUIGlassPanel
implements GUIValueField<T>

A slider class that alters an internal value depending on where the slider sits on the slider bar.

This object already contains its own layout and a child object, its movement constrained to that of its parent, that acts as the slider thumb.

This object fires an EVENT_VALUE_CHANGE event when the slider changes.

This object and its descendants return specific theme keys depending on the current state of the slider.

Thumb:

Slider Themes

Enabled	THEME_KEY_SLIDER_THUMB
Focused	THEME_KEY_SLIDER_THUMB_FOCUSED
Disabled	THEME_KEY_SLIDER_THUMB_DISABLED

Track:

Slider Themes

Horizontal, Enabled	THEME_KEY_SLIDER_HORIZONTAL_TRACK
Horizontal, Focused	THEME_KEY_SLIDER_HORIZONTAL_TRACK_FOCUSED
Horizontal, Disabled	THEME_KEY_SLIDER_HORIZONTAL_TRACK_DISABLED
Vertical, Enabled	THEME_KEY_SLIDER_VERTICAL_TRACK
Vertical, Focused	THEME_KEY_SLIDER_VERTICAL_TRACK_FOCUSED
Vertical, Disabled	THEME_KEY_SLIDER_VERTICAL_TRACK_DISABLED

Track Start:

Slider Themes

Horizontal, Enabled	THEME_KEY_SLIDER_HORIZONTAL_TRACK_START
Horizontal, Focused	THEME_KEY_SLIDER_HORIZONTAL_TRACK_START_FOCUSED
Horizontal, Disabled	THEME_KEY_SLIDER_HORIZONTAL_TRACK_START_DISABLED
Vertical, Enabled	THEME_KEY_SLIDER_VERTICAL_TRACK_START
Vertical, Focused	THEME_KEY_SLIDER_VERTICAL_TRACK_START_FOCUSED
Vertical, Disabled	THEME_KEY_SLIDER_VERTICAL_TRACK_START_DISABLED

Track End:

Slider Themes

Horizontal, Enabled	THEME_KEY_SLIDER_HORIZONTAL_TRACK_END
Horizontal, Focused	THEME_KEY_SLIDER_HORIZONTAL_TRACK_END_FOCUSED
Horizontal, Disabled	THEME_KEY_SLIDER_HORIZONTAL_TRACK_END_DISABLED
Vertical, Enabled	THEME_KEY_SLIDER_VERTICAL_TRACK_END
Vertical, Focused	THEME_KEY_SLIDER_VERTICAL_TRACK_END_FOCUSED
Vertical, Disabled	THEME_KEY_SLIDER_VERTICAL_TRACK_END_DISABLED

Author:

Matthew Tropiano

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	GUISlider.Style	Slider style enumeration.

Nested classes/interfaces inherited from class GUIObject

GUIObject.ScaleType

Field Summary

Fields

Modifier and Type	Field	Description
protected T	currentValue	Current value.
protected RangeModel<T>	model	Slider model.
protected GUISlider.Style	style	Slider style.
static final String	THEME_KEY_SLIDER_HORIZONTAL_TRACK	Theme key for horizontal slider track.
static final String	THEME_KEY_SLIDER_HORIZONTAL_TRACK_DISABLED	Theme key for horizontal slider track, disabled.
static final String	THEME_KEY_SLIDER_HORIZONTAL_TRACK_END	Theme key for horizontal slider track end.
static final String	THEME_KEY_SLIDER_HORIZONTAL_TRACK_END_DISABLED	Theme key for horizontal slider track end, disabled.
static final String	THEME_KEY_SLIDER_HORIZONTAL_TRACK_END_FOCUSED	Theme key for horizontal slider track end, focused.
static final String	THEME_KEY_SLIDER_HORIZONTAL_TRACK_FOCUSED	Theme key for horizontal slider track, focused.
static final String	THEME_KEY_SLIDER_HORIZONTAL_TRACK_START	Theme key for horizontal slider track start.
static final String	THEME_KEY_SLIDER_HORIZONTAL_TRACK_START_DISABLED	Theme key for horizontal slider track start, disabled.
static final String	THEME_KEY_SLIDER_HORIZONTAL_TRACK_START_FOCUSED	Theme key for horizontal slider track start, focused.
static final String	THEME_KEY_SLIDER_THUMB	Theme key for slider thumb.
static final String	THEME_KEY_SLIDER_THUMB_DISABLED	Theme key for slider thumb, disabled.
static final String	THEME_KEY_SLIDER_THUMB_FOCUSED	Theme key for slider thumb, focused.
static final String	THEME_KEY_SLIDER_VERTICAL_TRACK	Theme key for vertical slider track.
static final String	THEME_KEY_SLIDER_VERTICAL_TRACK_DISABLED	Theme key for vertical slider track, disabled.
static final String	THEME_KEY_SLIDER_VERTICAL_TRACK_END	Theme key for vertical slider track end.
static final String	THEME_KEY_SLIDER_VERTICAL_TRACK_END_DISABLED	Theme key for vertical slider track end, disabled.
static final String	THEME_KEY_SLIDER_VERTICAL_TRACK_END_FOCUSED	Theme key for vertical slider track end, focused.
static final String	THEME_KEY_SLIDER_VERTICAL_TRACK_FOCUSED	Theme key for vertical slider track, focused.
static final String	THEME_KEY_SLIDER_VERTICAL_TRACK_START	Theme key for vertical slider track start.
static final String	THEME_KEY_SLIDER_VERTICAL_TRACK_START_DISABLED	Theme key for vertical slider track start, disabled.
static final String	THEME_KEY_SLIDER_VERTICAL_TRACK_START_FOCUSED	Theme key for vertical slider track start, focused.
protected static final GUIAction	THUMB_MOUSE_DRAG	Mouse drag event on the thumb.
protected static final GUIAction	THUMB_MOUSE_PRESS	Mouse press event on the thumb.
static final String	THUMB_NAME	The name given to the thumb object.
protected static final GUIAction	THUMB_PRESS	Key press event on the thumb.
protected GUIObject	thumbObject	Internal object for the thumb.
protected float	thumbScalar	Thumb scalar.
static final String	TRACK_END_NAME	The name given to the track end object.
static final String	TRACK_NAME	The name given to the track object.
static final String	TRACK_START_NAME	The name given to the track start object.
protected GUIObject	trackEndObject	Internal object for the track end.
protected GUIObject	trackObject	Internal object for the track.
protected GUIObject	trackStartObject	Internal object for the track start.

Fields inherited from class GUIObject

absoluteBounds, EVENT_BLUR, EVENT_CHANGE_ENABLE_STATE, EVENT_CHANGE_VISIBLE_STATE, EVENT_FOCUS, EVENT_GAMEPAD_AXIS, EVENT_GAMEPAD_PRESS, EVENT_GAMEPAD_RELEASE, EVENT_GAMEPAD_TAP_PRESS, EVENT_GAMEPAD_TAP_RELEASE, EVENT_GENERIC_INPUT, EVENT_KEY_PRESS, EVENT_KEY_RELEASE, EVENT_KEY_TYPE, EVENT_MOUSE_CLICK, EVENT_MOUSE_DRAG, EVENT_MOUSE_LEAVE, EVENT_MOUSE_MOVE, EVENT_MOUSE_OVER, EVENT_MOUSE_PRESS, EVENT_MOUSE_RELEASE, EVENT_MOUSE_WHEEL, EVENT_NAMED, EVENT_UNKNOWN

Fields inherited from interface GUIValueField

EVENT_VALUE_CHANGE

Constructor Summary

Constructors

Constructor	Description
GUISlider(RangeModel<T> model)	Creates a new GUI Slider object in horizontal style.
GUISlider(RangeModel<T> model, GUISlider.Style style)	Creates a new GUI Slider object.
GUISlider(RangeModel<T> model, GUISlider.Style style, float thumbScalar)	Creates a new GUI Slider object.

Method Summary

Modifier and Type	Method	Description
protected float	getPositionScalar()
GUISlider.Style	getStyle()
GUIObject	getThumb()
float	getThumbScalar()	Gets the current thumb scalar.
GUIObject	getTrack()
GUIObject	getTrackEnd()
GUIObject	getTrackStart()
T	getValue()
GUIObject	setLayout(GUILayout layout)	This uses a special layout; to preserve it, this throws UnsupportedOperationException.
void	setThumbScalar(float thumbScalar)	Sets the current thumb scalar.
GUIValueField<T>	setValue(Object value)	Sets this field's value.
protected void	setValuesByThumbBounds()	Sets the internal values by the thumb position.

Methods inherited from class GUIGlassPanel

getRendered

Methods inherited from class GUIPanel

getThemeKey, setThemeKey

Methods inherited from class GUIObject

addChild, addChild, addName, addToRenderSet, animate, animate, animate, animateAbort, animateDelay, animateFinish, bindAction, callAction, correctPosition, fireEvent, getAbsoluteBounds, getAsQuery, getBounds, getChildrenAsQuery, getColor, getColorNotInherited, getDescendantsAsQuery, getFinalOpacity, getGeneration, getGUI, getLayout, getLayoutAttrib, getNativeBounds, getOpacity, getParent, getParentAsQuery, getRenderAlpha, getRenderBlue, getRenderGreen, getRenderHeight, getRenderPositionX, getRenderPositionY, getRenderRadius, getRenderRed, getRenderRotationZ, getRenderTextureScaleS, getRenderTextureScaleT, getRenderWidth, getScaleType, getSiblingsAsQuery, getTexture, getTheme, getVisible, hasAction, hasName, hasNamePattern, isAnimating, isConstrainedToParent, isEnabled, isFocused, isInert, isVisible, moveDown, moveToBack, moveToFront, moveUp, onGUIChange, releaseFocus, remove, removeChild, removeName, requestFocus, resizeChildren, rotate, setBounds, setBounds, setBoundsByChildren, setColor, setColor, setColorNotInherited, setConstrainToParent, setDimensions, setEnabled, setInert, setLayoutAttrib, setOpacity, setPosition, setRendered, setRotationZ, setScaleType, setTexture, setTheme, setVisible, stretch, toString, translate, unbindAction, unbindAllActions, updateDirty, updateScenePosition, useRenderRadius

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

THEME_KEY_SLIDER_THUMB

public static final String THEME_KEY_SLIDER_THUMB

Theme key for slider thumb.

See Also:

• Constant Field Values

THEME_KEY_SLIDER_THUMB_DISABLED

public static final String THEME_KEY_SLIDER_THUMB_DISABLED

Theme key for slider thumb, disabled.

See Also:

• Constant Field Values

THEME_KEY_SLIDER_THUMB_FOCUSED

public static final String THEME_KEY_SLIDER_THUMB_FOCUSED

Theme key for slider thumb, focused.

See Also:

• Constant Field Values

THEME_KEY_SLIDER_HORIZONTAL_TRACK

public static final String THEME_KEY_SLIDER_HORIZONTAL_TRACK

Theme key for horizontal slider track.

See Also:

• Constant Field Values

THEME_KEY_SLIDER_HORIZONTAL_TRACK_START

public static final String THEME_KEY_SLIDER_HORIZONTAL_TRACK_START

Theme key for horizontal slider track start.

See Also:

• Constant Field Values

THEME_KEY_SLIDER_HORIZONTAL_TRACK_END

public static final String THEME_KEY_SLIDER_HORIZONTAL_TRACK_END

Theme key for horizontal slider track end.

See Also:

• Constant Field Values

THEME_KEY_SLIDER_HORIZONTAL_TRACK_DISABLED

public static final String THEME_KEY_SLIDER_HORIZONTAL_TRACK_DISABLED

Theme key for horizontal slider track, disabled.

See Also:

• Constant Field Values

THEME_KEY_SLIDER_HORIZONTAL_TRACK_START_DISABLED

public static final String THEME_KEY_SLIDER_HORIZONTAL_TRACK_START_DISABLED

Theme key for horizontal slider track start, disabled.

See Also:

• Constant Field Values

THEME_KEY_SLIDER_HORIZONTAL_TRACK_END_DISABLED

public static final String THEME_KEY_SLIDER_HORIZONTAL_TRACK_END_DISABLED

Theme key for horizontal slider track end, disabled.

See Also:

• Constant Field Values

THEME_KEY_SLIDER_HORIZONTAL_TRACK_FOCUSED

public static final String THEME_KEY_SLIDER_HORIZONTAL_TRACK_FOCUSED

Theme key for horizontal slider track, focused.

See Also:

• Constant Field Values

THEME_KEY_SLIDER_HORIZONTAL_TRACK_START_FOCUSED

public static final String THEME_KEY_SLIDER_HORIZONTAL_TRACK_START_FOCUSED

Theme key for horizontal slider track start, focused.

See Also:

• Constant Field Values

THEME_KEY_SLIDER_HORIZONTAL_TRACK_END_FOCUSED

public static final String THEME_KEY_SLIDER_HORIZONTAL_TRACK_END_FOCUSED

Theme key for horizontal slider track end, focused.

See Also:

• Constant Field Values

THEME_KEY_SLIDER_VERTICAL_TRACK

public static final String THEME_KEY_SLIDER_VERTICAL_TRACK

Theme key for vertical slider track.

See Also:

• Constant Field Values

THEME_KEY_SLIDER_VERTICAL_TRACK_START

public static final String THEME_KEY_SLIDER_VERTICAL_TRACK_START

Theme key for vertical slider track start.

See Also:

• Constant Field Values

THEME_KEY_SLIDER_VERTICAL_TRACK_END

public static final String THEME_KEY_SLIDER_VERTICAL_TRACK_END

Theme key for vertical slider track end.

See Also:

• Constant Field Values

THEME_KEY_SLIDER_VERTICAL_TRACK_DISABLED

public static final String THEME_KEY_SLIDER_VERTICAL_TRACK_DISABLED

Theme key for vertical slider track, disabled.

See Also:

• Constant Field Values

THEME_KEY_SLIDER_VERTICAL_TRACK_START_DISABLED

public static final String THEME_KEY_SLIDER_VERTICAL_TRACK_START_DISABLED

Theme key for vertical slider track start, disabled.

See Also:

• Constant Field Values

THEME_KEY_SLIDER_VERTICAL_TRACK_END_DISABLED

public static final String THEME_KEY_SLIDER_VERTICAL_TRACK_END_DISABLED

Theme key for vertical slider track end, disabled.

See Also:

• Constant Field Values

THEME_KEY_SLIDER_VERTICAL_TRACK_FOCUSED

public static final String THEME_KEY_SLIDER_VERTICAL_TRACK_FOCUSED

Theme key for vertical slider track, focused.

See Also:

• Constant Field Values

THEME_KEY_SLIDER_VERTICAL_TRACK_START_FOCUSED

public static final String THEME_KEY_SLIDER_VERTICAL_TRACK_START_FOCUSED

Theme key for vertical slider track start, focused.

See Also:

• Constant Field Values

THEME_KEY_SLIDER_VERTICAL_TRACK_END_FOCUSED

public static final String THEME_KEY_SLIDER_VERTICAL_TRACK_END_FOCUSED

Theme key for vertical slider track end, focused.

See Also:

• Constant Field Values

THUMB_NAME

public static final String THUMB_NAME

The name given to the thumb object.

See Also:

• Constant Field Values

TRACK_NAME

public static final String TRACK_NAME

The name given to the track object.

See Also:

• Constant Field Values

TRACK_START_NAME

public static final String TRACK_START_NAME

The name given to the track start object.

See Also:

• Constant Field Values

TRACK_END_NAME

public static final String TRACK_END_NAME

The name given to the track end object.

See Also:

• Constant Field Values

THUMB_PRESS

protected static final GUIAction THUMB_PRESS

Key press event on the thumb.

THUMB_MOUSE_PRESS

protected static final GUIAction THUMB_MOUSE_PRESS

Mouse press event on the thumb.

THUMB_MOUSE_DRAG

protected static final GUIAction THUMB_MOUSE_DRAG

Mouse drag event on the thumb.

style

protected GUISlider.Style style

Slider style.

model

protected RangeModel<T> model

Slider model.

thumbObject

protected GUIObject thumbObject

Internal object for the thumb.

trackObject

protected GUIObject trackObject

Internal object for the track.

trackStartObject

protected GUIObject trackStartObject

Internal object for the track start.

trackEndObject

protected GUIObject trackEndObject

Internal object for the track end.

thumbScalar

protected float thumbScalar

Thumb scalar.

currentValue

protected T currentValue

Current value.

Constructor Details

GUISlider

public GUISlider(RangeModel<T> model)

Creates a new GUI Slider object in horizontal style.

Parameters:

model - the range model to use for defining values.

GUISlider

public GUISlider(RangeModel<T> model,
 GUISlider.Style style)

Creates a new GUI Slider object.

Parameters:

model - the range model to use for defining values.

style - the slider's style.

GUISlider

public GUISlider(RangeModel<T> model,
 GUISlider.Style style,
 float thumbScalar)

Creates a new GUI Slider object.

Parameters:

model - the range model to use for defining values.

style - the slider's style.

thumbScalar - the thumb scalar (from 0 to 1).

Method Details

setLayout

public GUIObject setLayout(GUILayout layout)

This uses a special layout; to preserve it, this throws UnsupportedOperationException.

Overrides:

setLayout in class GUIObject

Parameters:

layout - the layout to use.

Returns:

itself, to chain calls.

Throws:

UnsupportedOperationException - if called.

getStyle

public GUISlider.Style getStyle()

Returns:

the current slider style.

setValue

public GUIValueField<T> setValue(Object value)

Description copied from interface: GUIValueField

Sets this field's value. This must accept any object, and attempt to set the correct value based on it. This object must fire an GUIValueField.EVENT_VALUE_CHANGE event if it changes from its current value.

Specified by:

setValue in interface GUIValueField<T>

Parameters:

value - the value to set.

Returns:

itself, to chain calls.

getValue

public T getValue()

Specified by:

getValue in interface GUIValueField<T>

Returns:

this field's current value.

getThumb

public GUIObject getThumb()

Returns:

the reference to the thumb object.

getTrackStart

public GUIObject getTrackStart()

Returns:

the reference to the track start object.

getTrackEnd

public GUIObject getTrackEnd()

Returns:

the reference to the track end object.

getTrack

public GUIObject getTrack()

Returns:

the reference to the track object.

getThumbScalar

public float getThumbScalar()

Gets the current thumb scalar. It's a value from 0 to 1 that describes the width of the thumb relative to the width/height of the entire slider. Affected by slider style.

Returns:

the current scalar.

setThumbScalar

public void setThumbScalar(float thumbScalar)

Sets the current thumb scalar. It's a value from 0 to 1 that describes the width of the thumb relative to the width/height of the entire slider. Affected by slider style.

Parameters:

thumbScalar - the new scalar.

getPositionScalar

protected float getPositionScalar()

Returns:

the interpolation value between 0 and 1 using the position of the slider.

setValuesByThumbBounds

protected void setValuesByThumbBounds()

Sets the internal values by the thumb position.