net.malisis.core.client.gui.component.interaction

Class UISlider<T>

java.lang.Object

net.malisis.core.client.gui.component.UIComponent<UISlider<T>>

net.malisis.core.client.gui.component.interaction.UISlider<T>

All Implemented Interfaces:

IGuiText<UISlider<T>>, IKeyListener, ITransformable, ITransformable.Alpha, ITransformable.Position<UISlider<T>>, ITransformable.Size<UISlider<T>>

public class UISlider<T>
extends UIComponent<UISlider<T>>
implements IGuiText<UISlider<T>>

Nested Class Summary

Nested classes/interfaces inherited from interface net.malisis.core.renderer.animation.transformation.ITransformable

ITransformable.Alpha, ITransformable.Brightness, ITransformable.Color, ITransformable.Position<T>, ITransformable.Rotate, ITransformable.Scale, ITransformable.Size<T>, ITransformable.Translate

Field Summary

Fields

Modifier and Type	Field and Description
protected com.google.common.base.Converter<java.lang.Float,T>	converter Converter from float (0-1 offset) to the value.
protected MalisisFont	font The MalisisFont to use for this UISlider.
protected FontOptions	fontOptions The FontOptions to use for this UISlider.
protected FontOptions	hoveredFontOptions The FontOptions to use for this UISlider when hovered.
protected float	offset Position offset of the slider.
protected float	scrollStep Amount of offset scrolled by when using the scroll wheel.
static int	SLIDER_WIDTH
protected GuiIconProvider	sliderIcon
protected GuiShape	sliderShape
protected java.lang.String	text Text to display over the slider.
protected T	value Current value.

Fields inherited from class net.malisis.core.client.gui.component.UIComponent

alpha, anchor, disabled, focused, height, hovered, iconProvider, INHERITED, name, parent, rp, shape, tooltip, visible, width, x, y, zIndex

Constructor Summary

Constructors

Constructor and Description
UISlider(MalisisGui gui, int width, com.google.common.base.Converter<java.lang.Float,T> converter, java.lang.String text)

Method Summary

Modifier and Type	Method and Description
void	drawBackground(GuiRenderer renderer, int mouseX, int mouseY, float partialTick) Called first when drawing this UIComponent.
void	drawForeground(GuiRenderer renderer, int mouseX, int mouseY, float partialTick) Called last when drawing this UIComponent.
MalisisFont	getFont() Gets the MalisisFont.
FontOptions	getFontOptions() Gets the FontOptions.
T	getValue() Gets the value for this UISlider.
boolean	onClick(int x, int y) On click.
boolean	onDrag(int lastX, int lastY, int x, int y, MouseButton button) On drag.
boolean	onScrollWheel(int x, int y, int delta) On scroll wheel.
UISlider<T>	setFont(MalisisFont font) Sets the MalisisFont.
UISlider<T>	setFontOptions(FontOptions fro) Sets the FontOptions.
UISlider<T>	setScrollStep(float scrollStep) Sets the amount of offset to scroll with the wheel.
UISlider<T>	setValue(T value) Sets the value for this UISlider.
void	slideTo(float offset) Slides the slider to the specified offset between 0 and 1.
void	slideTo(int x) Slides the slider to the specified pixel position.

Methods inherited from class net.malisis.core.client.gui.component.UIComponent

addControlComponent, attachData, componentX, componentY, draw, fireEvent, getAlpha, getAnchor, getComponentAt, getData, getGui, getHeight, getIconProvider, getName, getParent, getPropertyString, getRawHeight, getRawWidth, getRenderer, getTooltip, getWidth, getX, getY, getZIndex, isDisabled, isFocused, isHovered, isInsideBounds, isRelativeHeight, isRelativeWidth, isVisible, onAddedToScreen, onButtonPress, onButtonRelease, onDoubleClick, onKeyTyped, onMouseMove, onRightClick, parentX, parentY, register, relativeX, relativeY, removeAllControlComponents, removeControlComponent, screenX, screenY, self, setAlpha, setAnchor, setDisabled, setFocused, setHovered, setName, setParent, setPosition, setPosition, setSize, setTooltip, setTooltip, setVisible, setZIndex, toString, unregister

Methods inherited from class java.lang.Object

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

Field Detail

SLIDER_WIDTH

public static int SLIDER_WIDTH

sliderIcon

protected GuiIconProvider sliderIcon

font

protected MalisisFont font

The MalisisFont to use for this UISlider.

fontOptions

protected FontOptions fontOptions

The FontOptions to use for this UISlider.

hoveredFontOptions

protected FontOptions hoveredFontOptions

The FontOptions to use for this UISlider when hovered.

text

protected java.lang.String text

Text to display over the slider.

value

protected T value

Current value.

offset

protected float offset

Position offset of the slider.

scrollStep

protected float scrollStep

Amount of offset scrolled by when using the scroll wheel.

converter

protected com.google.common.base.Converter<java.lang.Float,T> converter

Converter from float (0-1 offset) to the value.

sliderShape

protected GuiShape sliderShape

Constructor Detail

UISlider

public UISlider(MalisisGui gui,
                int width,
                com.google.common.base.Converter<java.lang.Float,T> converter,
                java.lang.String text)

Method Detail

getFont

public MalisisFont getFont()

Description copied from interface: IGuiText

Gets the MalisisFont.

Specified by:

getFont in interface IGuiText<UISlider<T>>

Returns:

the font

setFont

public UISlider<T> setFont(MalisisFont font)

Description copied from interface: IGuiText

Sets the MalisisFont.

Specified by:

setFont in interface IGuiText<UISlider<T>>

Parameters:

font - the new font

Returns:

the t

getFontOptions

public FontOptions getFontOptions()

Description copied from interface: IGuiText

Gets the FontOptions.

Specified by:

getFontOptions in interface IGuiText<UISlider<T>>

Returns:

the font options

setFontOptions

public UISlider<T> setFontOptions(FontOptions fro)

Description copied from interface: IGuiText

Sets the FontOptions.

Specified by:

setFontOptions in interface IGuiText<UISlider<T>>

Parameters:

fro - the font options

Returns:

the t

setValue

public UISlider<T> setValue(T value)

Sets the value for this UISlider.

Parameters:

value - the value

Returns:

this UI slider

getValue

public T getValue()

Gets the value for this UISlider.

Returns:

the value

setScrollStep

public UISlider<T> setScrollStep(float scrollStep)

Sets the amount of offset to scroll with the wheel.

Parameters:

scrollStep - the scroll step

Returns:

the UI slider

onClick

public boolean onClick(int x,
                       int y)

Description copied from class: UIComponent

On click.

Overrides:

onClick in class UIComponent<UISlider<T>>

Parameters:

x - the x

y - the y

Returns:

true, if successful

onScrollWheel

public boolean onScrollWheel(int x,
                             int y,
                             int delta)

Description copied from class: UIComponent

On scroll wheel.

Overrides:

onScrollWheel in class UIComponent<UISlider<T>>

Parameters:

x - the x

y - the y

delta - the delta

Returns:

true, if successful

onDrag

public boolean onDrag(int lastX,
                      int lastY,
                      int x,
                      int y,
                      MouseButton button)

Description copied from class: UIComponent

On drag.

Overrides:

onDrag in class UIComponent<UISlider<T>>

Parameters:

lastX - the last x

lastY - the last y

x - the x

y - the y

button - the button

Returns:

true, if successful

slideTo

public void slideTo(int x)

Slides the slider to the specified pixel position.

Parameters:

x - the x

slideTo

public void slideTo(float offset)

Slides the slider to the specified offset between 0 and 1.
Sets the value relative to the offset.

Parameters:

offset - the offset

drawBackground

public void drawBackground(GuiRenderer renderer,
                           int mouseX,
                           int mouseY,
                           float partialTick)

Description copied from class: UIComponent

Called first when drawing this UIComponent.

Specified by:

drawBackground in class UIComponent<UISlider<T>>

Parameters:

renderer - the renderer

mouseX - the mouse x

mouseY - the mouse y

partialTick - the partial tick

drawForeground

public void drawForeground(GuiRenderer renderer,
                           int mouseX,
                           int mouseY,
                           float partialTick)

Description copied from class: UIComponent

Called last when drawing this UIComponent.

Specified by:

drawForeground in class UIComponent<UISlider<T>>

Parameters:

renderer - the renderer

mouseX - the mouse x

mouseY - the mouse y

partialTick - the partial tick