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:

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

public class UICheckBox
extends UIComponent<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

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 label)

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.
boolean	isChecked()
void	onButtonRelease(MouseEvent.Release event)
void	onKeyTyped(KeyboardEvent event)
UICheckBox	setChecked(boolean checked) Sets the state for this UICheckBox.
java.lang.String	toString()

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, getPropertyString, 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, setHovered, setName, setParent, setPosition, setPosition, setSize, setTooltip, setTooltip, setVisible, setZIndex, 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

Constructor Detail

UICheckBox

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

UICheckBox

public UICheckBox(MalisisGui gui)

Method Detail

isChecked

public boolean isChecked()

Returns:

whether this UICheckBox is checked or not.

setChecked

public UICheckBox setChecked(boolean checked)

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

Parameters:

checked - true if checked

Returns:

this UIComponent

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

onButtonRelease

public void onButtonRelease(MouseEvent.Release event)

onKeyTyped

public void onKeyTyped(KeyboardEvent event)

toString

public java.lang.String toString()

Overrides:

toString in class UIComponent<UICheckBox>