buildcraft.lib.gui.button

Class GuiAbstractButton

java.lang.Object

buildcraft.lib.gui.GuiElementSimple

buildcraft.lib.gui.button.GuiAbstractButton

All Implemented Interfaces:

IButtonClickEventTrigger, IGuiElement, IHelpElement, IInteractionElement, ITooltipElement, IGuiArea, IGuiPosition

Direct Known Subclasses:

GuiButtonDrawable, GuiImageButton

public abstract class GuiAbstractButton
extends GuiElementSimple
implements IButtonClickEventTrigger, IInteractionElement

If this only has 1 subclass (GuiButtonDrawable), then why not merge them?

Field Summary

Fields

Modifier and Type	Field and Description
boolean	active
boolean	enabled
java.lang.String	id
boolean	visible

Fields inherited from class buildcraft.lib.gui.GuiElementSimple

gui, name

Constructor Summary

Constructors

Constructor and Description
GuiAbstractButton(BuildCraftGui gui, java.lang.String id, IGuiArea area)

Method Summary

Modifier and Type	Method and Description
void	activate()
void	addToolTips(java.util.List<ToolTip> tooltips) Called to add tooltips to the list of existing tool tips.
GuiElementText	createTextElement(java.lang.String text)
GuiElementText	createTextElement(java.util.function.Supplier<java.lang.String> text)
void	deActivate()
int	getColourForText()
protected int	getHoverState(boolean mouseOver)
boolean	isActive()
boolean	isButtonActive()
boolean	isMouseOver()
void	notifyButtonClicked(int bkey)
void	onMouseClicked(int button) This is called EVEN IF the mouse is not inside your width and height!
void	onMouseReleased(int button) This is called EVEN IF the mouse is not inside your width and height!
void	registerListener(IButtonClickEventListener listener)
void	removeListener(IButtonClickEventListener listener)
void	setActive(boolean active)
void	setBehaviour(IButtonBehaviour behaviour)
void	setToolTip(ToolTip tips)

Methods inherited from class buildcraft.lib.gui.GuiElementSimple

getDebugInfo, getHeight, getWidth, getX, getY

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface buildcraft.lib.gui.IInteractionElement

onKeyPress, onMouseDragged

Methods inherited from interface buildcraft.lib.gui.IGuiElement

addHelpElements, drawBackground, drawForeground, getDebugInfo, getThisAndChildrenAt, tick

Methods inherited from interface buildcraft.lib.gui.pos.IGuiArea

asImmutable, contains, contains, contains, create, create, create, expand, expand, expand, expand, getCenter, getCenterTop, getCenterX, getCenterY, getEnd, getEndX, getEndY, getHeight, getPosition, getWidth, offset, offset, offset, offset, offset, offsetToOrigin, rectangleToString, resize, resize

Methods inherited from interface buildcraft.lib.gui.pos.IGuiPosition

getX, getY

Field Detail

id

public final java.lang.String id

active

public boolean active

enabled

public boolean enabled

visible

public boolean visible

Constructor Detail

GuiAbstractButton

public GuiAbstractButton(BuildCraftGui gui,
                         java.lang.String id,
                         IGuiArea area)

Method Detail

createTextElement

public GuiElementText createTextElement(java.lang.String text)

createTextElement

public GuiElementText createTextElement(java.util.function.Supplier<java.lang.String> text)

getColourForText

public int getColourForText()

isActive

public boolean isActive()

activate

public final void activate()

deActivate

public final void deActivate()

setActive

public void setActive(boolean active)

isMouseOver

public boolean isMouseOver()

getHoverState

protected int getHoverState(boolean mouseOver)

setBehaviour

public void setBehaviour(IButtonBehaviour behaviour)

setToolTip

public void setToolTip(ToolTip tips)

addToolTips

public void addToolTips(java.util.List<ToolTip> tooltips)

Description copied from interface: IGuiElement

Called to add tooltips to the list of existing tool tips. You MUST refresh the Tooltips if they need to be refreshed.

This is called EVEN IF the mouse is not inside your width and height!

Specified by:

addToolTips in interface IGuiElement

Specified by:

addToolTips in interface ITooltipElement

notifyButtonClicked

public void notifyButtonClicked(int bkey)

Specified by:

notifyButtonClicked in interface IButtonClickEventTrigger

registerListener

public void registerListener(IButtonClickEventListener listener)

Specified by:

registerListener in interface IButtonClickEventTrigger

removeListener

public void removeListener(IButtonClickEventListener listener)

Specified by:

removeListener in interface IButtonClickEventTrigger

isButtonActive

public boolean isButtonActive()

Specified by:

isButtonActive in interface IButtonClickEventTrigger

onMouseClicked

public void onMouseClicked(int button)

Description copied from interface: IInteractionElement

This is called EVEN IF the mouse is not inside your width and height!

Specified by:

onMouseClicked in interface IInteractionElement

onMouseReleased

public void onMouseReleased(int button)

Description copied from interface: IInteractionElement

This is called EVEN IF the mouse is not inside your width and height!

Specified by:

onMouseReleased in interface IInteractionElement