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

Class UIButton

java.lang.Object

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

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

All Implemented Interfaces:

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

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

UIButton

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UIButton.ClickEvent Event fired when a UIButton 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 boolean	autoSize Whether the size of this UIButton is automatically calculated based on its contents.
protected int	bgColor The background color of this UIButton.
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 GuiIconProvider	iconPressedProvider
protected UIImage	image Image used for this UIButton.
protected boolean	isPressed Whether this UIButton is currently being pressed.
protected int	offsetX Offset for the contents
protected int	offsetY Offset for the contents
protected java.lang.String	text Text used for this UIButton.

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

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.
int	getBgColor() Gets the background color of this UIButton.
MalisisFont	getFont() Gets the MalisisFont.
FontRenderOptions	getFontRenderOptions() Gets the FontRenderOptions.
FontRenderOptions	getHoveredFontRendererOptions() Gets the FontRenderOptions used for this UILabel when hovered.
UIImage	getImage() Gets the UIImage of this UIButton.
int	getOffsetX() Gets the text offset of this UIButton.
int	getOffsetY() Gets the text offset of this UIButton.
java.lang.String	getPropertyString() Gets the property string.
java.lang.String	getText() Gets the text of this UIButton.
boolean	isAutoSize() Checks if is width is automatically calculated.
boolean	onButtonPress(int x, int y, MouseButton button) On button press.
boolean	onButtonRelease(int x, int y, MouseButton button) On button release.
boolean	onClick(int x, int y) On click.
UIButton	setAutoSize(boolean autoSize) Sets whether the size of this UIButton should be calculated automatically.
UIButton	setBgColor(int bgColor) Sets the background color of this UIButton.
UIButton	setFont(MalisisFont font) Sets the MalisisFont.
UIButton	setFontRenderOptions(FontRenderOptions fro) Sets the FontRenderOptions.
UIButton	setHoveredFontRendererOptions(FontRenderOptions hoveredFro) Sets the FontRenderOptions used for this UILabel when hovered.
UIButton	setImage(UIImage image) Sets the UIImage for this UIButton.
UIButton	setOffset(int x, int y) Sets the text offset of this UIButton.
UIButton	setSize(int width) Sets the width of this UIButton with a default height of 20px.
UIButton	setSize(int width, int height) Sets the size of this UIButton.
UIButton	setText(java.lang.String text) Sets the text of this UIButton.

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

Field Detail

font

protected MalisisFont font

The MalisisFont to use for this UITooltip.

fro

protected FontRenderOptions fro

The FontRenderOptions to use for this UITooltip.

hoveredFro

protected FontRenderOptions hoveredFro

The FontRenderOptions to use for this UITooltip when hovered.

text

protected java.lang.String text

Text used for this UIButton. Exclusive with image.

image

protected UIImage image

Image used for this UIButton. Exclusive with text.

autoSize

protected boolean autoSize

Whether the size of this UIButton is automatically calculated based on its contents.

isPressed

protected boolean isPressed

Whether this UIButton is currently being pressed.

bgColor

protected int bgColor

The background color of this UIButton.

offsetX

protected int offsetX

Offset for the contents

offsetY

protected int offsetY

Offset for the contents

iconPressedProvider

protected GuiIconProvider iconPressedProvider

Constructor Detail

UIButton

public UIButton(MalisisGui gui)

Instantiates a new UIButton.

Parameters:

gui - the gui

UIButton

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

Instantiates a new UIButton.

Parameters:

gui - the gui

text - the text

UIButton

public UIButton(MalisisGui gui,
                UIImage image)

Instantiates a new UIButton.

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

Returns:

the font

setFont

public UIButton setFont(MalisisFont font)

Description copied from interface: IGuiText

Sets the MalisisFont.

Specified by:

setFont in interface IGuiText<UIButton>

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

Returns:

the font renderer options

setFontRenderOptions

public UIButton setFontRenderOptions(FontRenderOptions fro)

Description copied from interface: IGuiText

Sets the FontRenderOptions.

Specified by:

setFontRenderOptions in interface IGuiText<UIButton>

Parameters:

fro - the fro

Returns:

the t

getHoveredFontRendererOptions

public FontRenderOptions getHoveredFontRendererOptions()

Gets the FontRenderOptions used for this UILabel when hovered.

Returns:

the hoveredFro

setHoveredFontRendererOptions

public UIButton setHoveredFontRendererOptions(FontRenderOptions hoveredFro)

Sets the FontRenderOptions used for this UILabel when hovered.

Parameters:

hoveredFro - the hoveredFro to set

Returns:

this UIButton

getText

public java.lang.String getText()

Gets the text of this UIButton.

Returns:

the text of this UIButton.

setText

public UIButton setText(java.lang.String text)

Sets the text of this UIButton.

Parameters:

text - the text

Returns:

this UIButton

getImage

public UIImage getImage()

Gets the UIImage of this UIButton.

Returns:

the image

setImage

public UIButton setImage(UIImage image)

Sets the UIImage for this UIButton. If a width of 0 was previously set, it will be recalculated for this image.

Parameters:

image - the image

Returns:

this UIButton

setSize

public UIButton setSize(int width)

Sets the width of this UIButton with a default height of 20px.

Parameters:

width - the width

Returns:

this UIButton

setSize

public UIButton setSize(int width,
                        int height)

Sets the size of this UIButton.

Specified by:

setSize in interface ITransformable.Size<UIButton>

Overrides:

setSize in class UIComponent<UIButton>

Parameters:

width - the width

height - the height

Returns:

this UIButton

isAutoSize

public boolean isAutoSize()

Checks if is width is automatically calculated.
If true, this UIButton cannot be smaller that its contents.

Returns:

the autoWidth

setAutoSize

public UIButton setAutoSize(boolean autoSize)

Sets whether the size of this UIButton should be calculated automatically.

Parameters:

autoSize - the autoSize to set

getBgColor

public int getBgColor()

Gets the background color of this UIButton.

Returns:

the bg color

setBgColor

public UIButton setBgColor(int bgColor)

Sets the background color of this UIButton.

Parameters:

bgColor - the bg color

Returns:

the UI button

getOffsetX

public int getOffsetX()

Gets the text offset of this UIButton.

Returns:

the text offset x

getOffsetY

public int getOffsetY()

Gets the text offset of this UIButton.

Returns:

the text offset y

setOffset

public UIButton setOffset(int x,
                          int y)

Sets the text offset of this UIButton.

Parameters:

x - the x

y - the y

Returns:

the UI button

onClick

public boolean onClick(int x,
                       int y)

Description copied from class: UIComponent

On click.

Overrides:

onClick in class UIComponent<UIButton>

Parameters:

x - the x

y - the y

Returns:

true, if successful

onButtonPress

public boolean onButtonPress(int x,
                             int y,
                             MouseButton button)

Description copied from class: UIComponent

On button press.

Overrides:

onButtonPress in class UIComponent<UIButton>

Parameters:

x - the x

y - the y

button - the button

Returns:

true, if successful

onButtonRelease

public boolean onButtonRelease(int x,
                               int y,
                               MouseButton button)

Description copied from class: UIComponent

On button release.

Overrides:

onButtonRelease in class UIComponent<UIButton>

Parameters:

x - the x

y - the y

button - the button

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

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

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

Returns:

the property string