net.malisis.core.client.gui.component.decoration

Class UILabel

java.lang.Object

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

net.malisis.core.client.gui.component.decoration.UILabel

All Implemented Interfaces:

IScrollable, IGuiText<UILabel>, IKeyListener, ITransformable, ITransformable.Alpha, ITransformable.Position<UILabel>, ITransformable.Size<UILabel>, IBBCodeRenderer<UILabel>

public class UILabel
extends UIComponent<UILabel>
implements IScrollable, IGuiText<UILabel>, IBBCodeRenderer<UILabel>

UILabel.

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 BBCodeRenderer	bbRenderer BBCode renderer
protected BBString	bbText BBCode for this UILabel.
protected MalisisFont	font The MalisisFont to use for this UILabel.
protected FontRenderOptions	fro The FontRenderOptions to use for this UILabel.
protected int	lineOffset Number of line offset out of this UILabel when drawn.
protected java.util.List<java.lang.String>	lines List of strings making the text of this UILabel.
protected int	lineSpacing Space used between each line.
protected boolean	multiLine Whether this UITextField handles multiline text.
protected UISlimScrollbar	scrollBar Scrollbar of the textfield
protected java.lang.String	text Text of this UILabel.
protected int	textHeight Height of the text.
protected int	textWidth Width of the text.

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
UILabel(MalisisGui gui) Instantiates a new UILabel.
UILabel(MalisisGui gui, BBString text) Instantiates a new UILabel.
UILabel(MalisisGui gui, boolean multiLine) Instantiates a new UILabel.
UILabel(MalisisGui gui, java.lang.String text) Instantiates a new UILabel.
UILabel(MalisisGui gui, java.lang.String text, boolean multiLine) Instantiates a new UILabel.

Method Summary

Modifier and Type	Method and Description
protected void	buildLines() Builds the lines for this UILabel.
protected void	calculateSize() Calculate the size of this UILabel.
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.
BBString	getBBText() Gets the BB text of this UILabel.
UIComponent<?>	getComponentAt(int x, int y) Gets the component at.
int	getContentHeight() Gets the height of the scrollable content.
int	getContentWidth() Gets the width of the scrollable content.
MalisisFont	getFont() Gets the MalisisFont used for this UILabel.
FontRenderOptions	getFontRenderOptions() Gets the FontRenderOptions used for this UILabel.
float	getFontScale() Gets the font scale for this UILabel.
int	getHorizontalPadding() Gets the horizontal padding.
int	getLineHeight()
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.
java.lang.String	getPropertyString() Gets the property string.
float	getScrollStep() Gets the amount of scrolling from 0 to 1, done by one step of the scroll wheel.
int	getStartLine()
java.lang.String	getText() Gets the text of this UILabel.
int	getVerticalPadding() Gets the vertical padding.
int	getVisibleLines()
void	onSizeChange(SpaceChangeEvent.SizeChangeEvent<UILabel> event)
UILabel	setFont(MalisisFont font) Sets the MalisisFont.
UILabel	setFontRenderOptions(FontRenderOptions fro) Sets the MalisisFont and FontRenderOptions to use for this UILabel.
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.
UILabel	setText(BBString str)
UILabel	setText(java.lang.String text) Sets the text of this UILabel.

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

addControlComponent, attachData, componentX, componentY, draw, fireEvent, getAlpha, getAnchor, getData, getGui, getHeight, getIconProvider, getName, getParent, getRawHeight, getRawWidth, getRenderer, getTooltip, getWidth, getX, getY, getZIndex, isDisabled, isFocused, isHovered, isInsideBounds, isRelativeHeight, isRelativeWidth, isVisible, onAddedToScreen, onButtonPress, onButtonRelease, onClick, 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, 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.util.bbcode.render.IBBCodeRenderer

getHeight, getWidth

Field Detail

font

protected MalisisFont font

The MalisisFont to use for this UILabel.

fro

protected FontRenderOptions fro

The FontRenderOptions to use for this UILabel.

text

protected java.lang.String text

Text of this UILabel.

bbText

protected BBString bbText

BBCode for this UILabel.

bbRenderer

protected BBCodeRenderer bbRenderer

BBCode renderer

lines

protected java.util.List<java.lang.String> lines

List of strings making the text of this UILabel.

multiLine

protected boolean multiLine

Whether this UITextField handles multiline text.

lineOffset

protected int lineOffset

Number of line offset out of this UILabel when drawn. Always 0 if multiLine is false.

lineSpacing

protected int lineSpacing

Space used between each line.

scrollBar

protected UISlimScrollbar scrollBar

Scrollbar of the textfield

textWidth

protected int textWidth

Width of the text.

textHeight

protected int textHeight

Height of the text.

Constructor Detail

UILabel

public UILabel(MalisisGui gui,
               java.lang.String text,
               boolean multiLine)

Instantiates a new UILabel.

Parameters:

gui - the gui

text - the text

multiLine - the multi line

UILabel

public UILabel(MalisisGui gui,
               BBString text)

Instantiates a new UILabel.

Parameters:

gui - the gui

text - the text

UILabel

public UILabel(MalisisGui gui,
               java.lang.String text)

Instantiates a new UILabel.

Parameters:

gui - the gui

text - the text

UILabel

public UILabel(MalisisGui gui,
               boolean multiLine)

Instantiates a new UILabel.

Parameters:

gui - the gui

multiLine - the multi line

UILabel

public UILabel(MalisisGui gui)

Instantiates a new UILabel.

Parameters:

gui - the gui

Method Detail

getText

public java.lang.String getText()

Gets the text of this UILabel.

Returns:

the text

setText

public UILabel setText(java.lang.String text)

Sets the text of this UILabel.
If multiLine is false, the width is recalculated.
If multiLine is true, the lines will be recreated.

Parameters:

text - the text

Returns:

this UILabel

getFont

public MalisisFont getFont()

Gets the MalisisFont used for this UILabel.

Specified by:

getFont in interface IGuiText<UILabel>

Returns:

the font

setFont

public UILabel setFont(MalisisFont font)

Description copied from interface: IGuiText

Sets the MalisisFont.

Specified by:

setFont in interface IGuiText<UILabel>

Parameters:

font - the new font

Returns:

the t

getFontRenderOptions

public FontRenderOptions getFontRenderOptions()

Gets the FontRenderOptions used for this UILabel.

Specified by:

getFontRenderOptions in interface IGuiText<UILabel>

Returns:

the font renderer options

setFontRenderOptions

public UILabel setFontRenderOptions(FontRenderOptions fro)

Sets the MalisisFont and FontRenderOptions to use for this UILabel.

Specified by:

setFontRenderOptions in interface IGuiText<UILabel>

Parameters:

fro - the fro

Returns:

this UILabel

getFontScale

public float getFontScale()

Gets the font scale for this UILabel.

Specified by:

getFontScale in interface IBBCodeRenderer<UILabel>

Returns:

the font scale

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

getVerticalPadding

public int getVerticalPadding()

Description copied from interface: IScrollable

Gets the vertical padding.

Specified by:

getVerticalPadding in interface IScrollable

Returns:

the vertical padding

getHorizontalPadding

public int getHorizontalPadding()

Description copied from interface: IScrollable

Gets the horizontal padding.

Specified by:

getHorizontalPadding in interface IScrollable

Returns:

the horizontal padding

getBBText

public BBString getBBText()

Gets the BB text of this UILabel.

Specified by:

getBBText in interface IBBCodeRenderer<UILabel>

Returns:

the BB text

setText

public UILabel setText(BBString str)

Specified by:

setText in interface IBBCodeRenderer<UILabel>

getStartLine

public int getStartLine()

Specified by:

getStartLine in interface IBBCodeRenderer<UILabel>

getVisibleLines

public int getVisibleLines()

Specified by:

getVisibleLines in interface IBBCodeRenderer<UILabel>

getLineHeight

public int getLineHeight()

Specified by:

getLineHeight in interface IBBCodeRenderer<UILabel>

getComponentAt

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

Gets the component at.

Overrides:

getComponentAt in class UIComponent<UILabel>

Parameters:

x - the x

y - the y

Returns:

the component at

buildLines

protected void buildLines()

Builds the lines for this UILabel. Only used if multiLine is true.

calculateSize

protected void calculateSize()

Calculate the size of this UILabel.

drawBackground

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

Draws the background.

Specified by:

drawBackground in class UIComponent<UILabel>

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

Parameters:

renderer - the renderer

mouseX - the mouse x

mouseY - the mouse y

partialTick - the partial tick

onSizeChange

public void onSizeChange(SpaceChangeEvent.SizeChangeEvent<UILabel> event)

getPropertyString

public java.lang.String getPropertyString()

Description copied from class: UIComponent

Gets the property string.

Overrides:

getPropertyString in class UIComponent<UILabel>

Returns:

the property string