net.malisis.core.client.gui.component.interaction

Class UITab

java.lang.Object

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

net.malisis.core.client.gui.component.interaction.UITab

All Implemented Interfaces:

IGuiText<UITab>, IKeyListener, ITransformable, ITransformable.Alpha, ITransformable.Position<UITab>, ITransformable.Size<UITab>

public class UITab
extends UIComponent<UITab>
implements IGuiText<UITab>

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	active Whether this UITab is currently active.
protected FontRenderOptions	activeFro The FontRenderOptions to use for this UITooltip when active.
protected boolean	autoHeight Whether the height of this UITab is calculated based on the label or image .
protected boolean	autoWidth Whether the width of this UITab is calculated based on the label or image .
protected int	bgColor Background color for this UITab.
protected UIContainer<?>	container The container this UITab is linked to.
protected MalisisFont	font The MalisisFont to use for this UITooltip.
protected FontRenderOptions	fro The FontRenderOptions to use for this UITooltip.
protected FontRenderOptions	hoveredFro The FontRenderOptions to use for this UITooltip when hovered.
protected UIImage	image Image for this UITab.
protected java.lang.String	label Label for this UITab.

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
UITab(MalisisGui gui, java.lang.String label) Instantiates a new UITab.
UITab(MalisisGui gui, UIImage image) Instantiates a new UITab.

Method Summary

Modifier and Type	Method and Description
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.
FontRenderOptions	getActiveFontRendererOptions() Gets the active FontRenderOptions.
int	getBgColor() Gets the background color for this UITab.
MalisisFont	getFont() Gets the MalisisFont.
FontRenderOptions	getFontRenderOptions() Gets the FontRenderOptions.
FontRenderOptions	getHoveredFontRendererOptions() Gets the hovered FontRenderOptions.
java.lang.String	getPropertyString() Gets the property string.
ComponentPosition	getTabPosition() Gets the ComponentPosition of this UITab.
boolean	isActive()
boolean	isAutoHeight() Checks if height is calculated automatically.
boolean	isAutoWidth() Checks if the width is calculated automatically.
protected boolean	isHorizontal() Checks whether this UITab is horizontally positioned.
boolean	onClick(int x, int y) On click.
UITab	setActive(boolean active) Sets this tab to be active.
UITab	setActiveFontRendererOptions(FontRenderOptions fro) Sets the active FontRenderOptions.
UITab	setBgColor(int color) Sets the baground color for this UITab.
UITab	setContainer(UIContainer<?> container) Set the UIContainer linked with this UITab.
UITab	setFont(MalisisFont font) Sets the MalisisFont.
UITab	setFontRenderOptions(FontRenderOptions fro) Sets the FontRenderOptions.
UITab	setHoveredFontRendererOptions(FontRenderOptions fro) Sets the hovered FontRenderOptions.
UITab	setImage(UIImage image) Sets the image UITab.
UITab	setLabel(java.lang.String label) Sets the label for this UITab.
void	setParent(UIComponent<?> parent) Sets the parent for this UITab.
UITab	setSize(int width, int height) Sets the size of this UITab.

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

addControlComponent, attachData, componentX, componentY, draw, fireEvent, getAlpha, getAnchor, getComponentAt, getData, getGui, getHeight, getIconProvider, getName, getParent, 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, 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

Field Detail

font

protected MalisisFont font

The MalisisFont to use for this UITooltip.

fro

protected FontRenderOptions fro

The FontRenderOptions to use for this UITooltip.

activeFro

protected FontRenderOptions activeFro

The FontRenderOptions to use for this UITooltip when active.

hoveredFro

protected FontRenderOptions hoveredFro

The FontRenderOptions to use for this UITooltip when hovered.

label

protected java.lang.String label

Label for this UITab.

image

protected UIImage image

Image for this UITab.

autoWidth

protected boolean autoWidth

Whether the width of this UITab is calculated based on the label or image .

autoHeight

protected boolean autoHeight

Whether the height of this UITab is calculated based on the label or image .

container

protected UIContainer<?> container

The container this UITab is linked to.

active

protected boolean active

Whether this UITab is currently active.

bgColor

protected int bgColor

Background color for this UITab.

Constructor Detail

UITab

public UITab(MalisisGui gui,
             java.lang.String label)

Instantiates a new UITab.

Parameters:

gui - the gui

label - the label

UITab

public UITab(MalisisGui gui,
             UIImage image)

Instantiates a new UITab.

Parameters:

gui - the gui

image - the image

Method Detail

getFont

public MalisisFont getFont()

Description copied from interface: IGuiText

Gets the MalisisFont.

Specified by:

getFont in interface IGuiText<UITab>

Returns:

the font

setFont

public UITab setFont(MalisisFont font)

Description copied from interface: IGuiText

Sets the MalisisFont.

Specified by:

setFont in interface IGuiText<UITab>

Parameters:

font - the new font

Returns:

the t

getFontRenderOptions

public FontRenderOptions getFontRenderOptions()

Description copied from interface: IGuiText

Gets the FontRenderOptions.

Specified by:

getFontRenderOptions in interface IGuiText<UITab>

Returns:

the font renderer options

setFontRenderOptions

public UITab setFontRenderOptions(FontRenderOptions fro)

Description copied from interface: IGuiText

Sets the FontRenderOptions.

Specified by:

setFontRenderOptions in interface IGuiText<UITab>

Parameters:

fro - the fro

Returns:

the t

getActiveFontRendererOptions

public FontRenderOptions getActiveFontRendererOptions()

Gets the active FontRenderOptions.

Returns:

the activeFro

setActiveFontRendererOptions

public UITab setActiveFontRendererOptions(FontRenderOptions fro)

Sets the active FontRenderOptions.

Parameters:

fro - the fro

Returns:

the UI tab

getHoveredFontRendererOptions

public FontRenderOptions getHoveredFontRendererOptions()

Gets the hovered FontRenderOptions.

Returns:

the hoveredFro

setHoveredFontRendererOptions

public UITab setHoveredFontRendererOptions(FontRenderOptions fro)

Sets the hovered FontRenderOptions.

Parameters:

fro - the fro

Returns:

the UI tab

setLabel

public UITab setLabel(java.lang.String label)

Sets the label for this UITab.
Removes the image if previously set.
Recalculates the width if autoWidth is true, the height if autoHeight is true.

Parameters:

label - the label

Returns:

this UITab

setImage

public UITab setImage(UIImage image)

Sets the image UITab.
Removes the label if previously set.
Recalculates the width if autoWidth is true, the height if autoHeight is true.

Parameters:

image - the image

Returns:

this UITab

setParent

public void setParent(UIComponent<?> parent)

Sets the parent for this UITab.

Overrides:

setParent in class UIComponent<UITab>

Parameters:

parent - the new parent

Throws:

java.lang.IllegalArgumentException - if the parent is not a UITabGroup

setSize

public UITab setSize(int width,
                     int height)

Sets the size of this UITab.
If width or height is 0, it will be automatically calculated base on label or image.

Specified by:

setSize in interface ITransformable.Size<UITab>

Overrides:

setSize in class UIComponent<UITab>

Parameters:

width - the width

height - the height

Returns:

this UITab

isAutoWidth

public boolean isAutoWidth()

Checks if the width is calculated automatically.

Returns:

true if the width is calculated automatically.

isAutoHeight

public boolean isAutoHeight()

Checks if height is calculated automatically.

Returns:

true if the height is calculated automatically.

setContainer

public UITab setContainer(UIContainer<?> container)

Set the UIContainer linked with this UITab.

Parameters:

container - the container

Returns:

this UITab

getTabPosition

public ComponentPosition getTabPosition()

Gets the ComponentPosition of this UITab.

Returns:

the tab position

getBgColor

public int getBgColor()

Gets the background color for this UITab.

Returns:

the color of this UITab.

setBgColor

public UITab setBgColor(int color)

Sets the baground color for this UITab.
Also sets the bacground color for its container.

Parameters:

color - the color

Returns:

this UITab

isActive

public boolean isActive()

setActive

public UITab setActive(boolean active)

Sets this tab to be active. Enables and sets visibility for its container.

Parameters:

active - true if active

isHorizontal

protected boolean isHorizontal()

Checks whether this UITab is horizontally positioned.

Returns:

true, if is horizontal

onClick

public boolean onClick(int x,
                       int y)

Description copied from class: UIComponent

On click.

Overrides:

onClick in class UIComponent<UITab>

Parameters:

x - the x

y - the y

Returns:

true, if successful

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

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

Parameters:

renderer - the renderer

mouseX - the mouse x

mouseY - the mouse y

partialTick - the partial tick

getPropertyString

public java.lang.String getPropertyString()

Description copied from class: UIComponent

Gets the property string.

Overrides:

getPropertyString in class UIComponent<UITab>

Returns:

the property string