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

Class UICheckBox

java.lang.Object

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

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

All Implemented Interfaces:

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

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

UICheckBox

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UICheckBox.CheckEvent Event fired when a UICheckBox is checked or unchecked.

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	bgIcon
protected GuiIcon	bgIconDisabled
protected GuiIcon	cbChecked
protected GuiIcon	cbDisabled
protected GuiIcon	cbHovered
protected MalisisFont	font The MalisisFont to use for this UICheckBox.
protected FontRenderOptions	fro The FontRenderOptions to use for this UICheckBox.

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
UICheckBox(MalisisGui gui)
UICheckBox(MalisisGui gui, java.lang.String text)

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.
MalisisFont	getFont() Gets the MalisisFont used for this UILabel.
FontRenderOptions	getFontRendererOptions() Gets the FontRenderOptions used for this UILabel.
java.lang.String	getPropertyString() Gets the property string.
java.lang.String	getText() Gets the text for this UICheckBox.
boolean	isChecked() Checks if this UICheckBox is checked.
boolean	onClick(int x, int y) On click.
boolean	onKeyTyped(char keyChar, int keyCode) Called when a key is typed inside MalisisGui.
UICheckBox	setChecked(boolean checked) Sets the state for this UICheckBox.
UICheckBox	setFont(MalisisFont font, FontRenderOptions fro) Sets the MalisisFont and FontRenderOptions to use for this UILabel.
UICheckBox	setText(java.lang.String text) Sets the text for this UICheckBox.

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

addControlComponent, componentX, componentY, draw, fireEvent, getAlpha, getAnchor, getComponentAt, getGui, getHeight, getName, getParent, getRawHeight, getRawWidth, getRenderer, getTooltip, getWidth, getX, getY, getZIndex, isDisabled, isFocused, isHovered, isInsideBounds, isRelativeHeight, isRelativeWidth, isVisible, onAddedToScreen, onButtonPress, onButtonRelease, onDoubleClick, onDrag, onMouseMove, onRightClick, onScrollWheel, parentX, parentY, register, relativeX, relativeY, removeAllControlComponents, removeControlComponent, screenX, screenY, 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

Field Detail

bgIcon

protected GuiIcon bgIcon

bgIconDisabled

protected GuiIcon bgIconDisabled

cbDisabled

protected GuiIcon cbDisabled

cbChecked

protected GuiIcon cbChecked

cbHovered

protected GuiIcon cbHovered

font

protected MalisisFont font

The MalisisFont to use for this UICheckBox. If null, uses GuiRenderer.getDefaultFont().

fro

protected FontRenderOptions fro

The FontRenderOptions to use for this UICheckBox. If null, uses GuiRenderer.getDefaultFontRendererOptions().

Constructor Detail

UICheckBox

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

UICheckBox

public UICheckBox(MalisisGui gui)

Method Detail

getFont

public MalisisFont getFont()

Gets the MalisisFont used for this UILabel.

Specified by:

getFont in interface IGuiText<UICheckBox>

Returns:

the font

getFontRendererOptions

public FontRenderOptions getFontRendererOptions()

Gets the FontRenderOptions used for this UILabel.

Specified by:

getFontRendererOptions in interface IGuiText<UICheckBox>

Returns:

the font renderer options

setFont

public UICheckBox setFont(MalisisFont font,
                 FontRenderOptions fro)

Sets the MalisisFont and FontRenderOptions to use for this UILabel.

Specified by:

setFont in interface IGuiText<UICheckBox>

Parameters:

font - the new font

fro - the fro

setText

public UICheckBox setText(java.lang.String text)

Sets the text for this UICheckBox.

Parameters:

text - the new text

getText

public java.lang.String getText()

Gets the text for this UICheckBox.

Returns:

the text

isChecked

public boolean isChecked()

Checks if this UICheckBox is checked.

Returns:

whether this UICheckBox is checked or not.

setChecked

public UICheckBox setChecked(boolean checked)

Sets the state for this UICheckBox. Does not fire UICheckBox.CheckEvent.

Parameters:

checked - true if checked

Returns:

this UIComponent

onClick

public boolean onClick(int x,
              int y)

Description copied from class: UIComponent

On click.

Overrides:

onClick in class UIComponent<UICheckBox>

Parameters:

x - the x

y - the y

Returns:

true, if successful

onKeyTyped

public boolean onKeyTyped(char keyChar,
                 int keyCode)

Description copied from interface: IKeyListener

Called when a key is typed inside MalisisGui.

Specified by:

onKeyTyped in interface IKeyListener

Overrides:

onKeyTyped in class UIComponent<UICheckBox>

Parameters:

keyChar - the key char

keyCode - the key code

Returns:

true, to prevent parents and gui to handle the key typed

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

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

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

Returns:

the property string