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

Class UIContainer<T extends UIContainer<T>>

java.lang.Object

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

net.malisis.core.client.gui.component.container.UIContainer<T>

Type Parameters:

T - type of UIContainer

All Implemented Interfaces:

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

Direct Known Subclasses:

BBCodeEditor, MCEditor, UIBackgroundContainer, UIInventory, UIPanel, UIPlayerInventory, UITabGroup, UIWindow

public class UIContainer<T extends UIContainer<T>>
extends UIComponent<T>
implements IClipable, IScrollable, ICloseable

UIContainer are the base for components holding other components.
Child components are drawn in the foreground.
Mouse events received are passed to the child concerned (getComponentAt()).
Keyboard event are passed to all the children.

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 boolean	clipContent Determines whether this UIContainer should clip its contents to its drawn area.
protected java.util.Set<UIComponent<?>>	components List of UIComponent inside this UIContainer.
protected int	contentHeight Height of the contents of this UIContainer.
protected int	contentWidth Width of the contents of this UIContainer.
protected int	horizontalPadding Horizontal padding to apply to this UIContainer.
protected UILabel	titleLabel Label for the title of this UIContainer.
protected int	verticalPadding Vertical padding to apply to this UIContainer.
protected int	xOffset X Offset for the contents of this UIContainer from 0 to 1.
protected int	yOffset Y Offset for the contents of this UIContainer from 0 to 1.

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
UIContainer(MalisisGui gui) Default constructor, creates the components list.
UIContainer(MalisisGui gui, int width, int height) Instantiates a new UIContainer.
UIContainer(MalisisGui gui, java.lang.String title) Instantiates a new UIContainer.
UIContainer(MalisisGui gui, java.lang.String title, int width, int height) Instantiates a new UIContainer.

Method Summary

Modifier and Type	Method and Description
void	add(UIComponent<?>... components) Adds components to this UIContainer.
void	calculateContentSize() Calculates content size.
int	componentX(UIComponent<?> component) Gets the relative position of the specified UIComponent inside this UIContainer.
int	componentY(UIComponent<?> component) Gets the relative position of the specified UIComponent inside this UIContainer.
void	drawBackground(GuiRenderer renderer, int mouseX, int mouseY, float partialTick) Draws the background.
void	drawForeground(GuiRenderer renderer, int mouseX, int mouseY, float partialTick) Draws the foreground.
ClipArea	getClipArea() Gets the ClipArea.
UIComponent<?>	getComponent(java.lang.String name) Gets the UIComponent matching the specified name.
UIComponent<?>	getComponent(java.lang.String name, boolean recursive) Gets the UIComponent matching the specified name.
UIComponent<?>	getComponentAt(int x, int y) Gets the UIComponent at the specified coordinates.
int	getContentHeight() Gets the height of the scrollable content.
int	getContentWidth() Gets the width of the scrollable content.
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.
java.lang.String	getTitle() Gets the title.
int	getVerticalPadding() Gets the vertical padding.
void	onAddedToScreen() Called when this UIComponent is added to screen.
void	onClose()
void	onComponentSpaceChange(SpaceChangeEvent<T> event) Called when a child UIComponent gets its size or position changed
void	onComponentStateChange(StateChangeEvent.VisibleStateChange<T> event) Called when a child UIComponent gets its visibility changed
void	onContentUpdate() Called when this UIComponent gets its content updated.
void	remove(UIComponent<?> component) Removes the component from this UIContainer.
void	removeAll() Removes all the components from this UIContainer.
void	setClipContent(boolean clipContent) Sets whether this UIContainer should clip its contents
T	setDisabled(boolean disabled) Sets the disabled.
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	setPadding(int horizontal, int vertical) Set the padding for this UIContainer.
T	setTitle(java.lang.String title) Sets the title for UIContainer.
T	setVisible(boolean visible) Sets the visible.
boolean	shouldClipContent() Checks whether this UIContainer should clip its contents

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

addControlComponent, attachData, draw, fireEvent, getAlpha, getAnchor, getData, getGui, getHeight, getIconProvider, getName, getParent, getPropertyString, getRawHeight, getRawWidth, getRenderer, getTooltip, getWidth, getX, getY, getZIndex, isDisabled, isFocused, isHovered, isInsideBounds, isRelativeHeight, isRelativeWidth, isVisible, onButtonPress, onButtonRelease, onClick, onDoubleClick, onDrag, onKeyTyped, onMouseMove, onRightClick, onScrollWheel, parentX, parentY, register, relativeX, relativeY, removeAllControlComponents, removeControlComponent, screenX, screenY, self, setAlpha, setAnchor, setFocused, setHovered, setName, setParent, setPosition, setPosition, setSize, setTooltip, setTooltip, 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

components

protected final java.util.Set<UIComponent<?>> components

List of UIComponent inside this UIContainer.

horizontalPadding

protected int horizontalPadding

Horizontal padding to apply to this UIContainer.

verticalPadding

protected int verticalPadding

Vertical padding to apply to this UIContainer.

titleLabel

protected UILabel titleLabel

Label for the title of this UIContainer.

clipContent

protected boolean clipContent

Determines whether this UIContainer should clip its contents to its drawn area.

contentWidth

protected int contentWidth

Width of the contents of this UIContainer.

contentHeight

protected int contentHeight

Height of the contents of this UIContainer.

xOffset

protected int xOffset

X Offset for the contents of this UIContainer from 0 to 1.

yOffset

protected int yOffset

Y Offset for the contents of this UIContainer from 0 to 1.

Constructor Detail

UIContainer

public UIContainer(MalisisGui gui)

Default constructor, creates the components list.

Parameters:

gui - the gui

UIContainer

public UIContainer(MalisisGui gui,
                   java.lang.String title)

Instantiates a new UIContainer.

Parameters:

gui - the gui

title - the title

UIContainer

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

Instantiates a new UIContainer.

Parameters:

gui - the gui

width - the width

height - the height

UIContainer

public UIContainer(MalisisGui gui,
                   java.lang.String title,
                   int width,
                   int height)

Instantiates a new UIContainer.

Parameters:

gui - the gui

title - the title

width - the width

height - the height

Method Detail

setVisible

public T setVisible(boolean visible)

Sets the visible.

Overrides:

setVisible in class UIComponent<T extends UIContainer<T>>

Parameters:

visible - the visible

Returns:

the t

setDisabled

public T setDisabled(boolean disabled)

Sets the disabled.

Overrides:

setDisabled in class UIComponent<T extends UIContainer<T>>

Parameters:

disabled - the disabled

Returns:

the t

setPadding

public void setPadding(int horizontal,
                       int vertical)

Set the padding for this UIContainer.

Parameters:

horizontal - the horizontal

vertical - the vertical

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.

setTitle

public T setTitle(java.lang.String title)

Sets the title for UIContainer.
Creates a UILabel and adds it inside UIContainer.

Parameters:

title - the title

Returns:

the UI container

getTitle

public java.lang.String getTitle()

Gets the title.

Returns:

the title for this UIContainer.

componentX

public int componentX(UIComponent<?> component)

Gets the relative position of the specified UIComponent inside this UIContainer.

Overrides:

componentX in class UIComponent<T extends UIContainer<T>>

Parameters:

component - the component

Returns:

the coordinate

componentY

public int componentY(UIComponent<?> component)

Gets the relative position of the specified UIComponent inside this UIContainer.

Overrides:

componentY in class UIComponent<T extends UIContainer<T>>

Parameters:

component - the component

Returns:

the coordinate

getComponent

public UIComponent<?> getComponent(java.lang.String name)

Gets the UIComponent matching the specified name.

Parameters:

name - the name

Returns:

the component

getComponent

public UIComponent<?> getComponent(java.lang.String name,
                                   boolean recursive)

Gets the UIComponent matching the specified name. If recursive is true, looks for the UIComponent inside it child UIContainer too.

Parameters:

name - the name

recursive - if true, look inside child UIContainer

Returns:

the component

getComponentAt

public UIComponent<?> getComponentAt(int x,
                                     int y)

Gets the UIComponent at the specified coordinates.
Selects the component with the highest z-index from the components overlapping the coordinates.

Overrides:

getComponentAt in class UIComponent<T extends UIContainer<T>>

Parameters:

x - the x

y - the y

Returns:

the child component in this UIContainer, this UIContainer if none, or null if outside its bounds.

onContentUpdate

public void onContentUpdate()

Called when this UIComponent gets its content updated.

calculateContentSize

public void calculateContentSize()

Calculates content size.

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

add

public void add(UIComponent<?>... components)

Adds components to this UIContainer.

Parameters:

components - the components

remove

public void remove(UIComponent<?> component)

Removes the component from this UIContainer.

Parameters:

component - the component

removeAll

public void removeAll()

Removes all the components from this UIContainer. Does not remove control components

onAddedToScreen

public void onAddedToScreen()

Description copied from class: UIComponent

Called when this UIComponent is added to screen.
Triggers a SpaceChangeEvent.SizeChangeEvent if this component size is relative.

Overrides:

onAddedToScreen in class UIComponent<T extends UIContainer<T>>

onClose

public void onClose()

Specified by:

onClose in interface ICloseable

drawBackground

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

Draws the background.

Specified by:

drawBackground in class UIComponent<T extends UIContainer<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)

Draws the foreground.

Specified by:

drawForeground in class UIComponent<T extends UIContainer<T>>

Parameters:

renderer - the renderer

mouseX - the mouse x

mouseY - the mouse y

partialTick - the partial tick

onComponentStateChange

public void onComponentStateChange(StateChangeEvent.VisibleStateChange<T> event)

Called when a child UIComponent gets its visibility changed

Parameters:

event - the event

onComponentSpaceChange

public void onComponentSpaceChange(SpaceChangeEvent<T> event)

Called when a child UIComponent gets its size or position changed

Parameters:

event - the event