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 GuiIcon	disabledIcon
protected GuiIcon	horizontalDisabledIcon
protected GuiIcon	horizontalIcon
protected int	scrollHeight
protected GuiShape	scrollShape
protected int	scrollThickness
protected UIScrollBar.Type	type
protected GuiIcon	verticalDisabledIcon
protected GuiIcon	verticalIcon

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

alpha, anchor, disabled, focused, height, hovered, icon, 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

Methods

Modifier and Type	Method and Description
static void	addScrollbar(UIComponent component, UIScrollBar scrollbar)
protected void	createShape(MalisisGui gui)
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()
float	getOffset()
java.lang.String	getPropertyString() Gets the property string.
protected IScrollable	getScrollable()
static UIScrollBar	getScrollbar(UIComponent component, UIScrollBar.Type type)
int	getWidth() Gets the width of this UIComponent.
boolean	hasVisibleOtherScrollbar()
boolean	isHorizontal()
boolean	onButtonPress(int x, int y, MouseButton button) On button press.
void	onContentUpdate(ContentUpdateEvent 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)
void	scrollTo(float offset)
UIScrollBar	setAutoHide(boolean autoHide)
UIScrollBar	setLength(int length)
protected void	setPosition()
void	setScrollSize(int thickness, int height) Sets the scroll size.
void	updateScrollbars()

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

addControlComponent, componentX, componentY, draw, fireEvent, getAlpha, getAnchor, getComponentAt, getGui, getName, getParent, getRawHeight, getRawWidth, getRenderer, getTooltip, getX, getY, getZIndex, isDisabled, isFocused, isHovered, isInsideBounds, isRelativeHeight, isRelativeWidth, isVisible, onAddedToScreen, onButtonRelease, onClick, onDoubleClick, onMouseMove, onRightClick, parentX, parentY, register, relativeX, relativeY, removeAllControlComponents, removeControlComponent, screenX, screenY, 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

scrollHeight

protected int scrollHeight

disabledIcon

protected GuiIcon disabledIcon

verticalIcon

protected GuiIcon verticalIcon

verticalDisabledIcon

protected GuiIcon verticalDisabledIcon

horizontalIcon

protected GuiIcon horizontalIcon

horizontalDisabledIcon

protected GuiIcon horizontalDisabledIcon

type

protected UIScrollBar.Type type

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()

createShape

protected void createShape(MalisisGui gui)

getScrollable

protected IScrollable getScrollable()

hasVisibleOtherScrollbar

public boolean hasVisibleOtherScrollbar()

isHorizontal

public boolean isHorizontal()

setAutoHide

public UIScrollBar setAutoHide(boolean autoHide)

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()

setLength

public UIScrollBar setLength(int length)

getOffset

public float getOffset()

scrollTo

public void scrollTo(float offset)

scrollBy

public void scrollBy(float amount)

updateScrollbars

public void updateScrollbars()

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

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)

addScrollbar

public static void addScrollbar(UIComponent component,
                UIScrollBar scrollbar)