net.malisis.core.client.gui.component.container

Class UIListContainer<T extends UIListContainer<T,S>,S>

java.lang.Object

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

net.malisis.core.client.gui.component.container.UIListContainer<T,S>

All Implemented Interfaces:

IScrollable, IClipable, IKeyListener, ITransformable, ITransformable.Alpha, ITransformable.Position<T>, ITransformable.Size<T>

public abstract class UIListContainer<T extends UIListContainer<T,S>,S>
extends UIComponent<T>
implements IScrollable, IClipable

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UIListContainer.SelectEvent<T extends UIListContainer<T,S>,S> Event fired when a UIListContainer changes its selected element.

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 java.util.Collection<S>	elements
protected int	elementSpacing
protected int	lastSize
protected UIScrollBar	scrollbar Vertical Scrollbar.
protected S	selected
protected boolean	unselect
protected int	yOffset Y Offset for the contents of this UIListContainer.

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
UIListContainer(MalisisGui gui)
UIListContainer(MalisisGui gui, int width, int height)

Method Summary

Modifier and Type	Method and Description
boolean	canUnselect()
void	draw(GuiRenderer renderer, int mouseX, int mouseY, float partialTick) Draws this UIComponent Called by UIComponent.parent component.
void	drawBackground(GuiRenderer renderer, int mouseX, int mouseY, float partialTick) Called first when drawing this UIComponent.
abstract void	drawElementBackground(GuiRenderer renderer, int mouseX, int mouseY, float partialTick, S element, boolean isHovered)
abstract void	drawElementForeground(GuiRenderer renderer, int mouseX, int mouseY, float partialTick, S element, boolean isHovered)
void	drawElements(GuiRenderer renderer, int mouseX, int mouseY, float partialTick)
void	drawEmpty(GuiRenderer renderer, int mouseX, int mouseY, float partialTick)
void	drawForeground(GuiRenderer renderer, int mouseX, int mouseY, float partialTick) Called last when drawing this UIComponent.
ClipArea	getClipArea() Gets the ClipArea.
int	getContentHeight() Gets the height of the scrollable content.
int	getContentWidth() Gets the width of the scrollable content.
S	getElementAt(int x, int y)
abstract int	getElementHeight(S element)
java.lang.Iterable<S>	getElements()
int	getHorizontalPadding() Gets the horizontal padding.
float	getOffsetX() Gets the offset from 0 to 1 of the scrollable content.
float	getOffsetY() Gets the offset from 0 to 1 of the scrollable content.
float	getScrollStep() Gets the amount of scrolling from 0 to 1, done by one step of the scroll wheel.
S	getSelected()
int	getVerticalPadding() Gets the vertical padding.
boolean	isSelected(S element)
boolean	onClick(int x, int y) On click.
S	select(S element)
void	setClipContent(boolean clipContent) Sets whether this UIContainer should clip its contents
void	setElements(java.util.Collection<S> elements)
void	setElementSpacing(int elementSpacing)
void	setOffsetX(float offsetX, int delta) Sets the offset from 0 to 1 of the scrollable content.
void	setOffsetY(float offsetY, int delta) Sets the offset from 0 to 1 of the scrollable content.
void	setSelected(S comp)
T	setSize(int width, int height) Sets the size of this UIComponent.
void	setUnselect(boolean unselect)
boolean	shouldClipContent() Checks whether this UIContainer should clip its contents

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

addControlComponent, attachData, componentX, componentY, 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, onDrag, onKeyTyped, onMouseMove, onRightClick, onScrollWheel, parentX, parentY, register, relativeX, relativeY, removeAllControlComponents, removeControlComponent, screenX, screenY, self, setAlpha, setAnchor, setDisabled, setFocused, setHovered, setName, setParent, setPosition, setPosition, 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.IClipable

getHeight, getParent, getWidth, screenX, screenY

Field Detail

elementSpacing

protected int elementSpacing

unselect

protected boolean unselect

elements

protected java.util.Collection<S> elements

selected

protected S selected

lastSize

protected int lastSize

scrollbar

protected UIScrollBar scrollbar

Vertical Scrollbar.

yOffset

protected int yOffset

Y Offset for the contents of this UIListContainer.

Constructor Detail

UIListContainer

public UIListContainer(MalisisGui gui)

UIListContainer

public UIListContainer(MalisisGui gui,
                       int width,
                       int height)

Method Detail

setSize

public T setSize(int width,
                 int height)

Description copied from class: UIComponent

Sets the size of this UIComponent.

Specified by:

setSize in interface ITransformable.Size<T extends UIListContainer<T,S>>

Overrides:

setSize in class UIComponent<T extends UIListContainer<T,S>>

Parameters:

width - the width

height - the height

Returns:

this UIComponent

setElements

public void setElements(java.util.Collection<S> elements)

getElements

public java.lang.Iterable<S> getElements()

setElementSpacing

public void setElementSpacing(int elementSpacing)

canUnselect

public boolean canUnselect()

setUnselect

public void setUnselect(boolean unselect)

setSelected

public void setSelected(S comp)

getSelected

public S getSelected()

isSelected

public boolean isSelected(S element)

select

public S select(S element)

getClipArea

public ClipArea getClipArea()

Gets the ClipArea.

Specified by:

getClipArea in interface IClipable

Returns:

the clip area

setClipContent

public void setClipContent(boolean clipContent)

Sets whether this UIContainer should clip its contents

Specified by:

setClipContent in interface IClipable

Parameters:

clipContent - if true, clip contents

shouldClipContent

public boolean shouldClipContent()

Checks whether this UIContainer should clip its contents

Specified by:

shouldClipContent in interface IClipable

Returns:

true, if should clip contents

getContentWidth

public int getContentWidth()

Description copied from interface: IScrollable

Gets the width of the scrollable content. It should count the total content size to be displayed when not clipped.

Specified by:

getContentWidth in interface IScrollable

Returns:

the content width

getContentHeight

public int getContentHeight()

Description copied from interface: IScrollable

Gets the height of the scrollable content. It should count the total content size to be displayed when not clipped.

Specified by:

getContentHeight in interface IScrollable

Returns:

the content height

getOffsetX

public float getOffsetX()

Description copied from interface: IScrollable

Gets the offset from 0 to 1 of the scrollable content. Only used for UIScrollBar.Type.HORIZONTAL scrollbars.

Specified by:

getOffsetX in interface IScrollable

Returns:

the offset x

setOffsetX

public void setOffsetX(float offsetX,
                       int delta)

Description copied from interface: IScrollable

Sets the offset from 0 to 1 of the scrollable content. Only used for UIScrollBar.Type.HORIZONTAL scrollbars.
Delta is the size taken for the UIScrollBar.Type.VERTICAL scrollbar if available.

Specified by:

setOffsetX in interface IScrollable

Parameters:

offsetX - the offset x

delta - the delta

getOffsetY

public float getOffsetY()

Description copied from interface: IScrollable

Gets the offset from 0 to 1 of the scrollable content. Only used for UIScrollBar.Type.VERTICAL scrollbars.

Specified by:

getOffsetY in interface IScrollable

Returns:

the offset x

setOffsetY

public void setOffsetY(float offsetY,
                       int delta)

Description copied from interface: IScrollable

Sets the offset from 0 to 1 of the scrollable content. Only used for UIScrollBar.Type.VERTICAL scrollbars.
Delta is the size taken for the UIScrollBar.Type.HORIZONTAL scrollbar if available.

Specified by:

setOffsetY in interface IScrollable

Parameters:

offsetY - the offset y

delta - the delta

getScrollStep

public float getScrollStep()

Description copied from interface: IScrollable

Gets the amount of scrolling from 0 to 1, done by one step of the scroll wheel.

Specified by:

getScrollStep in interface IScrollable

Returns:

the scroll step

getHorizontalPadding

public int getHorizontalPadding()

Gets the horizontal padding.

Specified by:

getHorizontalPadding in interface IScrollable

Returns:

horizontal padding of this UIContainer.

getVerticalPadding

public int getVerticalPadding()

Gets the vertical padding.

Specified by:

getVerticalPadding in interface IScrollable

Returns:

horizontal padding of this UIContainer.

getElementAt

public S getElementAt(int x,
                      int y)

onClick

public boolean onClick(int x,
                       int y)

Description copied from class: UIComponent

On click.

Overrides:

onClick in class UIComponent<T extends UIListContainer<T,S>>

Parameters:

x - the x

y - the y

Returns:

true, if successful

draw

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

Description copied from class: UIComponent

Draws this UIComponent Called by UIComponent.parent component.
Will set the size of UIComponent.shape according to the size of this UIComponent
Rendering is surrounded by glPushAttrib(GL_ALL_ATTRIB_BITS) so no state should bleed between components. Also, a draw() is triggered between background and foreground.

Overrides:

draw in class UIComponent<T extends UIListContainer<T,S>>

Parameters:

renderer - the renderer

mouseX - the mouse x

mouseY - the mouse y

partialTick - the partial tick

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<T extends UIListContainer<T,S>>

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<T extends UIListContainer<T,S>>

Parameters:

renderer - the renderer

mouseX - the mouse x

mouseY - the mouse y

partialTick - the partial tick

drawElements

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

drawEmpty

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

getElementHeight

public abstract int getElementHeight(S element)

drawElementBackground

public abstract void drawElementBackground(GuiRenderer renderer,
                                           int mouseX,
                                           int mouseY,
                                           float partialTick,
                                           S element,
                                           boolean isHovered)

drawElementForeground

public abstract void drawElementForeground(GuiRenderer renderer,
                                           int mouseX,
                                           int mouseY,
                                           float partialTick,
                                           S element,
                                           boolean isHovered)