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:

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

public class UIButton
extends UIComponent<UIButton>

UIButton

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UIButton.ClickEvent

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 GuiIcon	iconDisabled
protected GuiIcon	iconHovered

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

alpha, anchor, disabled, focused, height, hovered, icon, 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

Methods

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.
java.lang.String	getPropertyString() Gets the property string.
java.lang.String	getText() Gets the text of this UIButton.
void	onClick(MouseEvent.ButtonStateEvent event)
void	setHovered(boolean hovered) Sets the hovered state of this UIComponent.
UIButton	setImage(UIImage image) Sets the UIImage for 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, componentX, componentY, draw, fireEvent, fireKeyboardEvent, fireMouseEvent, getAlpha, getAnchor, getComponentAt, getGui, getHeight, getName, getParent, getRawHeight, getRawWidth, getTooltip, getWidth, getX, getY, getZIndex, isDisabled, isFocused, isHovered, isInsideBounds, isRelativeHeight, isRelativeWidth, isVisible, onAddedToScreen, parentX, parentY, register, relativeX, relativeY, removeAllControlComponents, removeControlComponent, screenX, screenY, setAlpha, setAnchor, setDisabled, setFocused, 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

iconHovered

protected GuiIcon iconHovered

iconDisabled

protected GuiIcon iconDisabled

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

setText

public UIButton setText(java.lang.String text)

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

Parameters:

text - the text

Returns:

this UIButton

getText

public java.lang.String getText()

Gets the text of this UIButton.

Returns:

the text of this UIButton.

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

setHovered

public void setHovered(boolean hovered)

Description copied from class: UIComponent

Sets the hovered state of this UIComponent.

Overrides:

setHovered in class UIComponent<UIButton>

Parameters:

hovered - the new state

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

onClick

public void onClick(MouseEvent.ButtonStateEvent event)

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