Class VerticalSlider

java.lang.Object

de.gurkenlabs.litiengine.gui.GuiComponent

de.gurkenlabs.litiengine.gui.Slider

de.gurkenlabs.litiengine.gui.VerticalSlider

All Implemented Interfaces:

IRenderable, Tweenable, MouseListener, MouseMotionListener, MouseWheelListener, EventListener

public class VerticalSlider
extends Slider

A Slider whose minimum value is at the top and maximum value is at the bottom.

Up/down arrow buttons and keyboard keys move between values using the configured step size.

Field Summary

Fields

Modifier and Type	Field	Description
static final FontIcon	ARROW_DOWN	Icon used by the increment button below the slider.
static final FontIcon	ARROW_UP	Icon used by the decrement button above the slider.

Fields inherited from class GuiComponent

ICON_FONT

Constructor Summary

Constructors

Constructor	Description
VerticalSlider(double x, double y, double width, double height, float minValue, float maxValue, float stepSize)	Creates a vertical slider.

Method Summary

Modifier and Type	Method	Description
protected float	getRelativeMouseValue()	Computes a normalized value (typically in [0, 1]) corresponding to the current mouse location relative to the slider.
Point2D	getRelativeSliderLocation()	Computes the relative location of the slider thumb within the slider for the current value.
protected void	initializeComponents()	Initialize child components.
protected void	renderBar(Graphics2D g)	Renders the slider bar (track).
protected void	renderTicks(Graphics2D g)	Renders the slider tick marks.
protected boolean	shouldDecreaseOnKey(int keyCode)	Determines whether the slider value should be decreased when the given key is typed.
protected boolean	shouldIncreaseOnKey(int keyCode)	Determines whether the slider value should be increased when the given key is typed.
protected void	updateSliderDimensions()	Updates the geometry of the slider in response to a change in min/max value or step size.

Methods inherited from class Slider

getButton1, getButton2, getButtonSpritesheet, getChangeConsumer, getCurrentValue, getMaxValue, getMinValue, getSliderComponent, getSliderSpritesheet, getSteps, getStepSize, getTickSize, inferValueFromMouseLocation, isDragging, isShowingTicks, onChange, prepare, render, setButton1, setButton2, setButtonSpritesheet, setCurrentValue, setMaxValue, setMinValue, setShowTicks, setSliderComponent, setSliderSpritesheet, setStepSize, setTickSize

Methods inherited from class GuiComponent

addRenderedListener, addRenderListener, getAppearance, getAppearanceDisabled, getAppearanceHovered, getBoundingBox, getCenterX, getCenterY, getClickConsumer, getComponentId, getComponents, getCurrentAppearance, getFocusedComponent, getFont, getHeight, getHoverConsumer, getHoverSound, getLocation, getMouseDraggedConsumer, getMouseEnterConsumer, getMouseLeaveConsumer, getMouseMovedConsumer, getMousePressedConsumer, getMouseReleasedConsumer, getMouseWheelConsumer, getName, getShape, getTag, getText, getTextAlign, getTextAngle, getTextShadowColor, getTextShadowRadius, getTextToRender, getTextValign, getTextX, getTextY, getTweenValues, getWidth, getX, getY, hasAutomaticLineBreaks, hasInputFocus, hasTextAntialiasing, hasTextShadow, isAutoScaling, isEnabled, isFocusable, isForwardMouseEvents, isHovered, isPressed, isSelected, isSuspended, isVisible, mouseClicked, mouseDragged, mouseEntered, mouseEventShouldBeForwarded, mouseExited, mouseMoved, mousePressed, mouseReleased, mouseWheelMoved, onClicked, onHovered, onMouseDragged, onMouseEnter, onMouseLeave, onMouseMoved, onMousePressed, onMouseReleased, onMouseWheelScrolled, onResolutionChanged, onTextChanged, removeListener, removeListener, setAutomaticLineBreaks, setAutoScaling, setDimension, setEnabled, setFocusable, setFont, setFontSize, setForwardMouseEvents, setHeight, setHovered, setHoverSound, setLocation, setLocation, setName, setSelected, setTag, setText, setTextAlign, setTextAngle, setTextAntialiasing, setTextShadow, setTextShadowColor, setTextShadowRadius, setTextValign, setTextX, setTextY, setTweenValues, setVisible, setWidth, setX, setY, suspend, toggleSelection, toggleSuspension

Methods inherited from class Object

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

Field Details

ARROW_DOWN

public static final FontIcon ARROW_DOWN

Icon used by the increment button below the slider.

ARROW_UP

public static final FontIcon ARROW_UP

Icon used by the decrement button above the slider.

Constructor Details

VerticalSlider

public VerticalSlider(double x,
 double y,
 double width,
 double height,
 float minValue,
 float maxValue,
 float stepSize)

Creates a vertical slider.

Parameters:

x - The horizontal screen coordinate.

y - The vertical screen coordinate.

width - The component width.

height - The component height.

minValue - The value at the top.

maxValue - The value at the bottom.

stepSize - The amount changed by one step.

Method Details

getRelativeSliderLocation

public Point2D getRelativeSliderLocation()

Description copied from class: Slider

Computes the relative location of the slider thumb within the slider for the current value.

Specified by:

getRelativeSliderLocation in class Slider

Returns:

the relative location of the slider thumb

updateSliderDimensions

protected void updateSliderDimensions()

Description copied from class: Slider

Updates the geometry of the slider in response to a change in min/max value or step size.

Specified by:

updateSliderDimensions in class Slider

renderBar

protected void renderBar(Graphics2D g)

Description copied from class: Slider

Renders the slider bar (track).

Specified by:

renderBar in class Slider

Parameters:

g - the graphics context to draw to

renderTicks

protected void renderTicks(Graphics2D g)

Description copied from class: Slider

Renders the slider tick marks.

Specified by:

renderTicks in class Slider

Parameters:

g - the graphics context to draw to

getRelativeMouseValue

protected float getRelativeMouseValue()

Description copied from class: Slider

Computes a normalized value (typically in [0, 1]) corresponding to the current mouse location relative to the slider.

Specified by:

getRelativeMouseValue in class Slider

Returns:

the relative mouse value

initializeComponents

protected void initializeComponents()

Description copied from class: GuiComponent

Initialize child components.

Overrides:

initializeComponents in class GuiComponent

shouldIncreaseOnKey

protected boolean shouldIncreaseOnKey(int keyCode)

Description copied from class: Slider

Determines whether the slider value should be increased when the given key is typed.

Overrides:

shouldIncreaseOnKey in class Slider

Parameters:

keyCode - the typed key code

Returns:

true if the value should be increased

shouldDecreaseOnKey

protected boolean shouldDecreaseOnKey(int keyCode)

Description copied from class: Slider

Determines whether the slider value should be decreased when the given key is typed.

Overrides:

shouldDecreaseOnKey in class Slider

Parameters:

keyCode - the typed key code

Returns:

true if the value should be decreased

classguiapijava