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

Class UITabGroup

java.lang.Object

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

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

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

All Implemented Interfaces:

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

public class UITabGroup
extends UIContainer<UITabGroup>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UITabGroup.TabChangeEvent Event fired when an inactive UITab is clicked.

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 UITab	activeTab The currently active UITab.
protected UIContainer<?>	attachedContainer The UIContainer this UITabGroup is attached to.
protected java.util.Map<UITab,UIContainer<?>>	listTabs The list of UITab added to this UITabGroup.
protected int	offset Number of pixels this UITabGroup is offset to the border of the attachedContainer.
protected GuiIcon[]	panelIcons Icons to use if this UITabGroup is attached to a UIPanel.
protected int	spacing Number of pixels between each tab.
protected ComponentPosition	tabPosition The position of this UITabGroup relative to its attachedContainer.
protected GuiIcon[]	windowIcons Icons to use if this UITabGroup is attached to a UIWindow.

Fields inherited from class net.malisis.core.client.gui.component.container.UIContainer

clipContent, components, contentHeight, contentWidth, horizontalPadding, titleLabel, verticalPadding, xOffset, yOffset

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
UITabGroup(MalisisGui gui) Instantiates a new UITabGroup.
UITabGroup(MalisisGui gui, ComponentPosition tabPosition) Instantiates a new UITabGroup.

Method Summary

Modifier and Type	Method and Description
UITab	addTab(UITab tab, UIContainer<?> container) Adds a UITab and its corresponding UIContainer to this UITabGroup.
UITabGroup	attachTo(UIContainer<?> container, boolean displace) Attach this UITabGroup to a UIContainer.
protected void	calculateTabPosition() Calculates the UITab position.
UIContainer<?>	getAttachedContainer() Gets the attached container for this UITabGroup.
GuiIcon	getIcons() Gets the icons for this UITabGroup
int	getOffset() Gets the offset for this UITabGroup.
int	getSpacing() Gets the spacing for this UITabGroup.
ComponentPosition	getTabPosition() Gets the relative position of the tabs around their containers.
int	screenX() Gets the X coordinate of this UIComponent relative to the screen.
int	screenY() Gets the Y coordinate of this UIComponent relative to the screen.
void	setActiveTab(java.lang.String tabName)
void	setActiveTab(UITab tab) Activates the UITab and deactivates currently active one.
UITabGroup	setOffset(int offset) Sets the offset for this UITabGroup.
UITabGroup	setSpacing(int spacing) Sets the spacing for this UITabGroup.

Methods inherited from class net.malisis.core.client.gui.component.container.UIContainer

add, calculateContentSize, componentX, componentY, drawBackground, drawForeground, getClipArea, getComponent, getComponent, getComponentAt, getContentHeight, getContentWidth, getHorizontalPadding, getOffsetX, getOffsetY, getScrollStep, getTitle, getVerticalPadding, onAddedToScreen, onClose, onComponentSpaceChange, onComponentStateChange, onContentUpdate, remove, removeAll, setClipContent, setDisabled, setOffsetX, setOffsetY, setPadding, setTitle, setVisible, shouldClipContent

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

Field Detail

listTabs

protected java.util.Map<UITab,UIContainer<?>> listTabs

The list of UITab added to this UITabGroup.

activeTab

protected UITab activeTab

The currently active UITab.

tabPosition

protected ComponentPosition tabPosition

The position of this UITabGroup relative to its attachedContainer.

attachedContainer

protected UIContainer<?> attachedContainer

The UIContainer this UITabGroup is attached to.

offset

protected int offset

Number of pixels this UITabGroup is offset to the border of the attachedContainer.

spacing

protected int spacing

Number of pixels between each tab.

windowIcons

protected GuiIcon[] windowIcons

Icons to use if this UITabGroup is attached to a UIWindow.

panelIcons

protected GuiIcon[] panelIcons

Icons to use if this UITabGroup is attached to a UIPanel.

Constructor Detail

UITabGroup

public UITabGroup(MalisisGui gui,
                  ComponentPosition tabPosition)

Instantiates a new UITabGroup.

Parameters:

gui - the gui

tabPosition - the tab position

UITabGroup

public UITabGroup(MalisisGui gui)

Instantiates a new UITabGroup.

Parameters:

gui - the gui

Method Detail

getTabPosition

public ComponentPosition getTabPosition()

Gets the relative position of the tabs around their containers.

Returns:

the tab position

getIcons

public GuiIcon getIcons()

Gets the icons for this UITabGroup

Returns:

the icons

getAttachedContainer

public UIContainer<?> getAttachedContainer()

Gets the attached container for this UITabGroup.

Returns:

the attached container

getOffset

public int getOffset()

Gets the offset for this UITabGroup.

Returns:

the offset

setOffset

public UITabGroup setOffset(int offset)

Sets the offset for this UITabGroup.

Parameters:

offset - the offset

Returns:

this UITabGroup

getSpacing

public int getSpacing()

Gets the spacing for this UITabGroup.

Returns:

the spacing

setSpacing

public UITabGroup setSpacing(int spacing)

Sets the spacing for this UITabGroup.

Parameters:

spacing - the spacing

Returns:

this UITabGroup

addTab

public UITab addTab(UITab tab,
                    UIContainer<?> container)

Adds a UITab and its corresponding UIContainer to this UITabGroup.
Also sets the width of this UITabGroup.

Parameters:

tab - tab to add to the UITabGroup

container - UIContainer linked to the UITab

Returns:

this UITab

calculateTabPosition

protected void calculateTabPosition()

Calculates the UITab position.
Sets the width and height of this UITabGroup.

setActiveTab

public void setActiveTab(java.lang.String tabName)

setActiveTab

public void setActiveTab(UITab tab)

Activates the UITab and deactivates currently active one.

Parameters:

tab - the new active tab

attachTo

public UITabGroup attachTo(UIContainer<?> container,
                           boolean displace)

Attach this UITabGroup to a UIContainer.

Parameters:

container - the container to attach to.

displace - if true, moves and resize the UIContainer to make place for the UITabGroup

Returns:

this UITab

screenX

public int screenX()

Description copied from class: UIComponent

Gets the X coordinate of this UIComponent relative to the screen.

Specified by:

screenX in interface IClipable

Overrides:

screenX in class UIComponent<UITabGroup>

Returns:

the the coordinate

screenY

public int screenY()

Description copied from class: UIComponent

Gets the Y coordinate of this UIComponent relative to the screen.

Specified by:

screenY in interface IClipable

Overrides:

screenY in class UIComponent<UITabGroup>

Returns:

the coordinate