net.malisis.core.client.gui.component.control

Class UIScrollBar

java.lang.Object

net.malisis.core.client.gui.component.UIComponent<UIScrollBar>

net.malisis.core.client.gui.component.control.UIScrollBar

All Implemented Interfaces:

IControlComponent, IKeyListener, ITransformable, ITransformable.Alpha, ITransformable.Position<UIScrollBar>, ITransformable.Size<UIScrollBar>

Direct Known Subclasses:

UISlimScrollbar

public class UIScrollBar
extends UIComponent<UIScrollBar>
implements IControlComponent

UIScrollBar

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UIScrollBar.Type

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
boolean	autoHide
protected int	offsetX The X offset for the scrollbar rendering.
protected int	offsetY The Y offset for the scrollbar rendering.
protected int	scrollHeight The scroll height (Height for vertical, width for horizontal).
protected GuiShape	scrollShape
protected int	scrollThickness The scroll thickness (Width for vertical, height for horizontal).
protected UIScrollBar.Type	type The type of scrollbar.

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
UIScrollBar(MalisisGui gui, T parent, UIScrollBar.Type type)

Method Summary

Modifier and Type	Method and Description
protected void	createShape(MalisisGui gui) Creates the shapes for this UIScrollBar.
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.
int	getHeight() Gets the height of this UIComponent.
int	getLength() Gets the length of this UIScrollBar (width if UIScrollBar.Type.HORIZONTAL, height if UIScrollBar.Type.VERTICAL.
float	getOffset() Gets the offset of the parent component of this UIScrollBar.
java.lang.String	getPropertyString() Gets the property string.
protected IScrollable	getScrollable() Gets the parent as a IScrollable.
static UIScrollBar	getScrollbar(UIComponent<?> component, UIScrollBar.Type type) Gets the UIScrollBar for the UIComponent, if any.
int	getWidth() Gets the width of this UIComponent.
int	getZIndex() Gets the zIndex of this UIComponent.
boolean	hasVisibleOtherScrollbar() Checks if the other type of scrollbar is present and visible.
boolean	isHorizontal() Checks if this UIScrollBar is UIScrollBar.Type.HORIZONTAL.
boolean	onButtonPress(int x, int y, MouseButton button) On button press.
boolean	onClick(int x, int y) On click.
void	onContentUpdate(ContentUpdateEvent<UIScrollBar> event)
boolean	onDrag(int lastX, int lastY, int x, int y, MouseButton button) On drag.
boolean	onKeyTyped(char keyChar, int keyCode) Called when a key is typed inside MalisisGui.
boolean	onScrollWheel(int x, int y, int delta) On scroll wheel.
void	scrollBy(float amount) Scroll this UIScrollBar by the specified amount.
void	scrollTo(float offset) Scroll this UIScrollBar to the specified offset.
UIScrollBar	setAutoHide(boolean autoHide) Sets whether this UIScrollBar should automatically hide when scrolling is not possible (content size is inferior to component size).
UIScrollBar	setOffset(int x, int y) Sets the position offset for this UIScrollBar.
protected void	setPosition() Sets the scrollbar position.
void	setScrollSize(int thickness, int height) Sets the scroll size.
void	updateScrollbar() Update this UIScrollBar, hiding and disabling it if necessary, based on content size.

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

addControlComponent, attachData, componentX, componentY, draw, fireEvent, getAlpha, getAnchor, getComponentAt, getData, getGui, getIconProvider, getName, getParent, getRawHeight, getRawWidth, getRenderer, getTooltip, getX, getY, isDisabled, isFocused, isHovered, isInsideBounds, isRelativeHeight, isRelativeWidth, isVisible, onAddedToScreen, onButtonRelease, onDoubleClick, 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

Methods inherited from interface net.malisis.core.client.gui.component.control.IControlComponent

draw, getComponentAt, getParent, setParent

Field Detail

scrollThickness

protected int scrollThickness

The scroll thickness (Width for vertical, height for horizontal).

scrollHeight

protected int scrollHeight

The scroll height (Height for vertical, width for horizontal).

offsetX

protected int offsetX

The X offset for the scrollbar rendering.

offsetY

protected int offsetY

The Y offset for the scrollbar rendering.

type

protected UIScrollBar.Type type

The type of scrollbar.

autoHide

public boolean autoHide

scrollShape

protected GuiShape scrollShape

Constructor Detail

UIScrollBar

public UIScrollBar(MalisisGui gui,
                   T parent,
                   UIScrollBar.Type type)

Method Detail

setScrollSize

public void setScrollSize(int thickness,
                          int height)

Sets the scroll size.

Parameters:

thickness - the thickness

height - the height

setPosition

protected void setPosition()

Sets the scrollbar position.
The position is relative its parent component.

createShape

protected void createShape(MalisisGui gui)

Creates the shapes for this UIScrollBar.

Parameters:

gui - the gui

getScrollable

protected IScrollable getScrollable()

Gets the parent as a IScrollable.

Returns:

the scrollable

hasVisibleOtherScrollbar

public boolean hasVisibleOtherScrollbar()

Checks if the other type of scrollbar is present and visible.

Returns:

true, if visible

isHorizontal

public boolean isHorizontal()

Checks if this UIScrollBar is UIScrollBar.Type.HORIZONTAL.

Returns:

true, if is horizontal

setAutoHide

public UIScrollBar setAutoHide(boolean autoHide)

Sets whether this UIScrollBar should automatically hide when scrolling is not possible (content size is inferior to component size).

Parameters:

autoHide - the auto hide

Returns:

this UIScrollBar

getZIndex

public int getZIndex()

Description copied from class: UIComponent

Gets the zIndex of this UIComponent.

Overrides:

getZIndex in class UIComponent<UIScrollBar>

Returns:

the zIndex

getWidth

public int getWidth()

Description copied from class: UIComponent

Gets the width of this UIComponent.

Overrides:

getWidth in class UIComponent<UIScrollBar>

Returns:

the width, or 0 for relative width without a parent

getHeight

public int getHeight()

Description copied from class: UIComponent

Gets the height of this UIComponent.

Overrides:

getHeight in class UIComponent<UIScrollBar>

Returns:

the height, or 0 for relative width without a parent

getLength

public int getLength()

Gets the length of this UIScrollBar (width if UIScrollBar.Type.HORIZONTAL, height if UIScrollBar.Type.VERTICAL.

Returns:

the length

getOffset

public float getOffset()

Gets the offset of the parent component of this UIScrollBar.

Returns:

the offset

setOffset

public UIScrollBar setOffset(int x,
                             int y)

Sets the position offset for this UIScrollBar.

Parameters:

x - the x

y - the y

Returns:

the UI scroll bar

scrollTo

public void scrollTo(float offset)

Scroll this UIScrollBar to the specified offset.

Parameters:

offset - the offset

scrollBy

public void scrollBy(float amount)

Scroll this UIScrollBar by the specified amount.

Parameters:

amount - the amount

updateScrollbar

public void updateScrollbar()

Update this UIScrollBar, hiding and disabling it if necessary, based on content size.

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<UIScrollBar>

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<UIScrollBar>

Parameters:

renderer - the renderer

mouseX - the mouse x

mouseY - the mouse y

partialTick - the partial tick

onContentUpdate

public void onContentUpdate(ContentUpdateEvent<UIScrollBar> event)

onButtonPress

public boolean onButtonPress(int x,
                             int y,
                             MouseButton button)

Description copied from class: UIComponent

On button press.

Overrides:

onButtonPress in class UIComponent<UIScrollBar>

Parameters:

x - the x

y - the y

button - the button

Returns:

true, if successful

onClick

public boolean onClick(int x,
                       int y)

Description copied from class: UIComponent

On click.

Overrides:

onClick in class UIComponent<UIScrollBar>

Parameters:

x - the x

y - the y

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<UIScrollBar>

Parameters:

lastX - the last x

lastY - the last y

x - the x

y - the y

button - the button

Returns:

true, if successful

onScrollWheel

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

Description copied from class: UIComponent

On scroll wheel.

Specified by:

onScrollWheel in interface IControlComponent

Overrides:

onScrollWheel in class UIComponent<UIScrollBar>

Parameters:

x - the x

y - the y

delta - the delta

Returns:

true, if successful

onKeyTyped

public boolean onKeyTyped(char keyChar,
                          int keyCode)

Description copied from interface: IKeyListener

Called when a key is typed inside MalisisGui.

Specified by:

onKeyTyped in interface IControlComponent

Specified by:

onKeyTyped in interface IKeyListener

Overrides:

onKeyTyped in class UIComponent<UIScrollBar>

Parameters:

keyChar - the key char

keyCode - the key code

Returns:

true, to prevent parents and gui to handle the key typed

getPropertyString

public java.lang.String getPropertyString()

Description copied from class: UIComponent

Gets the property string.

Overrides:

getPropertyString in class UIComponent<UIScrollBar>

Returns:

the property string

getScrollbar

public static UIScrollBar getScrollbar(UIComponent<?> component,
                                       UIScrollBar.Type type)

Gets the UIScrollBar for the UIComponent, if any.

Parameters:

component - the component

type - the type

Returns:

the scrollbar