de.gurkenlabs.litiengine.gui

Class GuiComponent

java.lang.Object

de.gurkenlabs.litiengine.gui.GuiComponent

All Implemented Interfaces:

IRenderable, java.awt.event.MouseListener, java.awt.event.MouseMotionListener, java.awt.event.MouseWheelListener, java.util.EventListener

Direct Known Subclasses:

DropdownListField, ImageComponent, ImageComponentList, ListField, Screen, Slider

public abstract class GuiComponent
extends java.lang.Object
implements java.awt.event.MouseListener, java.awt.event.MouseMotionListener, java.awt.event.MouseWheelListener, IRenderable

The Class GuiComponent.

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.awt.Font	ICON_FONT

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GuiComponent(double x, double y)
protected	GuiComponent(double x, double y, double width, double height) Instantiates a new gui component.

Method Summary

Modifier and Type	Method and Description
boolean	drawTextShadow()
Appearance	getAppearance()
Appearance	getAppearanceDisabled()
Appearance	getAppearanceHovered()
java.awt.geom.Rectangle2D	getBoundingBox() Gets the bounding box.
protected java.util.List<java.util.function.Consumer<ComponentMouseEvent>>	getClickConsumer() Gets the click consumer.
int	getComponentId() Gets the component id.
java.util.List<GuiComponent>	getComponents() Gets the components.
java.awt.Font	getFont()
double	getHeight() Gets the height.
protected java.util.List<java.util.function.Consumer<ComponentMouseEvent>>	getHoverConsumer()
Sound	getHoverSound()
java.awt.geom.Point2D	getLocation()
protected java.util.List<java.util.function.Consumer<ComponentMouseEvent>>	getMouseDraggedConsumer()
protected java.util.List<java.util.function.Consumer<ComponentMouseEvent>>	getMouseEnterConsumer()
protected java.util.List<java.util.function.Consumer<ComponentMouseEvent>>	getMouseLeaveConsumer()
protected java.util.List<java.util.function.Consumer<ComponentMouseEvent>>	getMouseMovedConsumer()
protected java.util.List<java.util.function.Consumer<ComponentMouseEvent>>	getMousePressedConsumer()
protected java.util.List<java.util.function.Consumer<ComponentMouseEvent>>	getMouseReleasedConsumer()
protected java.util.List<java.util.function.Consumer<ComponentMouseWheelEvent>>	getMouseWheelConsumer()
java.lang.String	getName()
java.lang.Object	getTag() Gets the tag.
java.lang.String	getText()
Align	getTextAlign()
int	getTextAngle()
java.awt.Color	getTextShadowColor()
java.lang.String	getTextToRender(java.awt.Graphics2D g)
double	getTextX()
double	getTextXMargin()
double	getTextY()
double	getWidth() Gets the width.
double	getX() Gets the x.
double	getY() Gets the y.
protected void	initializeComponents()
boolean	isEnabled()
boolean	isForwardMouseEvents()
boolean	isHovered() Checks if is hovered.
boolean	isPressed() Checks if is hovered.
boolean	isSelected()
boolean	isSuspended() Checks if is suspended.
boolean	isVisible() Checks if is visible.
void	mouseClicked(java.awt.event.MouseEvent e)
void	mouseDragged(java.awt.event.MouseEvent e)
void	mouseEntered(java.awt.event.MouseEvent e)
protected boolean	mouseEventShouldBeForwarded(java.awt.event.MouseEvent e) Mouse event should be forwarded.
void	mouseExited(java.awt.event.MouseEvent e)
void	mouseMoved(java.awt.event.MouseEvent e)
void	mousePressed(java.awt.event.MouseEvent e)
void	mouseReleased(java.awt.event.MouseEvent e)
void	mouseWheelMoved(java.awt.event.MouseWheelEvent e)
void	onClicked(java.util.function.Consumer<ComponentMouseEvent> callback) On clicked.
void	onHovered(java.util.function.Consumer<ComponentMouseEvent> callback)
void	onMouseDragged(java.util.function.Consumer<ComponentMouseEvent> callback)
void	onMouseEnter(java.util.function.Consumer<ComponentMouseEvent> callback)
void	onMouseLeave(java.util.function.Consumer<ComponentMouseEvent> callback)
void	onMouseMoved(java.util.function.Consumer<ComponentMouseEvent> callback)
void	onMousePressed(java.util.function.Consumer<ComponentMouseEvent> callback)
void	onMouseReleased(java.util.function.Consumer<ComponentMouseEvent> callback)
void	onMouseWheelScrolled(java.util.function.Consumer<ComponentMouseWheelEvent> callback)
void	onTextChanged(java.util.function.Consumer<java.lang.String> cons)
void	prepare()
void	render(java.awt.Graphics2D g)
void	setDimension(double width, double height)
void	setEnabled(boolean enabled)
void	setFont(java.awt.Font font)
void	setFontSize(float size)
void	setForwardMouseEvents(boolean forwardMouseEvents)
void	setHeight(double height)
void	setHovered(boolean hovered)
void	setHoverSound(Sound hoverSound)
void	setLocation(double x, double y)
void	setLocation(java.awt.geom.Point2D location)
void	setName(java.lang.String name)
void	setSelected(boolean bool)
void	setTag(java.lang.Object tag) Sets the tag.
void	setText(java.lang.String text)
void	setTextAlignment(Align textAlignment)
void	setTextAngle(int textAngle)
void	setTextShadow(boolean drawTextShadow)
void	setTextShadowColor(java.awt.Color textShadowColor)
void	setTextX(double x)
void	setTextXMargin(double xMargin)
void	setTextY(double y)
void	setVisible(boolean visible) Sets the visible.
void	setWidth(double width)
void	setX(double x)
void	setY(double y)
void	suspend() Suspend.
void	toggleSelection()

Methods inherited from class java.lang.Object

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

Field Detail

ICON_FONT

protected static final java.awt.Font ICON_FONT

Constructor Detail

GuiComponent

protected GuiComponent(double x,
                       double y)

GuiComponent

protected GuiComponent(double x,
                       double y,
                       double width,
                       double height)

Instantiates a new gui component.

Parameters:

x - the x

y - the y

width - the width

height - the height

Method Detail

drawTextShadow

public boolean drawTextShadow()

getAppearance

public Appearance getAppearance()

getAppearanceHovered

public Appearance getAppearanceHovered()

getAppearanceDisabled

public Appearance getAppearanceDisabled()

getBoundingBox

public java.awt.geom.Rectangle2D getBoundingBox()

Gets the bounding box.

Returns:

the bounding box

getComponentId

public int getComponentId()

Gets the component id.

Returns:

the component id

getComponents

public java.util.List<GuiComponent> getComponents()

Gets the components.

Returns:

the components

getFont

public java.awt.Font getFont()

getHeight

public double getHeight()

Gets the height.

Returns:

the height

getHoverSound

public Sound getHoverSound()

getName

public java.lang.String getName()

getLocation

public java.awt.geom.Point2D getLocation()

getTag

public java.lang.Object getTag()

Gets the tag.

Returns:

the tag

getText

public java.lang.String getText()

getTextAlign

public Align getTextAlign()

getTextAngle

public int getTextAngle()

getTextShadowColor

public java.awt.Color getTextShadowColor()

getTextToRender

public java.lang.String getTextToRender(java.awt.Graphics2D g)

getTextX

public double getTextX()

getTextXMargin

public double getTextXMargin()

getTextY

public double getTextY()

getWidth

public double getWidth()

Gets the width.

Returns:

the width

getX

public double getX()

Gets the x.

Returns:

the x

getY

public double getY()

Gets the y.

Returns:

the y

isEnabled

public boolean isEnabled()

isForwardMouseEvents

public boolean isForwardMouseEvents()

isHovered

public boolean isHovered()

Checks if is hovered.

Returns:

the boolean

isPressed

public boolean isPressed()

Checks if is hovered.

Returns:

the boolean

isSelected

public boolean isSelected()

isSuspended

public boolean isSuspended()

Checks if is suspended.

Returns:

true, if is suspended

isVisible

public boolean isVisible()

Checks if is visible.

Returns:

true, if is visible

mouseClicked

public void mouseClicked(java.awt.event.MouseEvent e)

Specified by:

mouseClicked in interface java.awt.event.MouseListener

mouseDragged

public void mouseDragged(java.awt.event.MouseEvent e)

Specified by:

mouseDragged in interface java.awt.event.MouseMotionListener

mouseEntered

public void mouseEntered(java.awt.event.MouseEvent e)

Specified by:

mouseEntered in interface java.awt.event.MouseListener

mouseExited

public void mouseExited(java.awt.event.MouseEvent e)

Specified by:

mouseExited in interface java.awt.event.MouseListener

mouseMoved

public void mouseMoved(java.awt.event.MouseEvent e)

Specified by:

mouseMoved in interface java.awt.event.MouseMotionListener

mousePressed

public void mousePressed(java.awt.event.MouseEvent e)

Specified by:

mousePressed in interface java.awt.event.MouseListener

mouseReleased

public void mouseReleased(java.awt.event.MouseEvent e)

Specified by:

mouseReleased in interface java.awt.event.MouseListener

mouseWheelMoved

public void mouseWheelMoved(java.awt.event.MouseWheelEvent e)

Specified by:

mouseWheelMoved in interface java.awt.event.MouseWheelListener

onClicked

public void onClicked(java.util.function.Consumer<ComponentMouseEvent> callback)

On clicked.

Parameters:

callback - the callback

onHovered

public void onHovered(java.util.function.Consumer<ComponentMouseEvent> callback)

onMouseDragged

public void onMouseDragged(java.util.function.Consumer<ComponentMouseEvent> callback)

onMouseEnter

public void onMouseEnter(java.util.function.Consumer<ComponentMouseEvent> callback)

onMouseLeave

public void onMouseLeave(java.util.function.Consumer<ComponentMouseEvent> callback)

onMouseMoved

public void onMouseMoved(java.util.function.Consumer<ComponentMouseEvent> callback)

onMousePressed

public void onMousePressed(java.util.function.Consumer<ComponentMouseEvent> callback)

onMouseReleased

public void onMouseReleased(java.util.function.Consumer<ComponentMouseEvent> callback)

onMouseWheelScrolled

public void onMouseWheelScrolled(java.util.function.Consumer<ComponentMouseWheelEvent> callback)

onTextChanged

public void onTextChanged(java.util.function.Consumer<java.lang.String> cons)

prepare

public void prepare()

render

public void render(java.awt.Graphics2D g)

Specified by:

render in interface IRenderable

setDimension

public void setDimension(double width,
                         double height)

setEnabled

public void setEnabled(boolean enabled)

setFont

public void setFont(java.awt.Font font)

setFontSize

public void setFontSize(float size)

setForwardMouseEvents

public void setForwardMouseEvents(boolean forwardMouseEvents)

setHeight

public void setHeight(double height)

setHovered

public void setHovered(boolean hovered)

setHoverSound

public void setHoverSound(Sound hoverSound)

setLocation

public void setLocation(double x,
                        double y)

setName

public void setName(java.lang.String name)

setLocation

public void setLocation(java.awt.geom.Point2D location)

setSelected

public void setSelected(boolean bool)

setTag

public void setTag(java.lang.Object tag)

Sets the tag.

Parameters:

tag - the new tag

setText

public void setText(java.lang.String text)

setTextAlignment

public void setTextAlignment(Align textAlignment)

setTextAngle

public void setTextAngle(int textAngle)

setTextShadow

public void setTextShadow(boolean drawTextShadow)

setTextShadowColor

public void setTextShadowColor(java.awt.Color textShadowColor)

setTextX

public void setTextX(double x)

setTextXMargin

public void setTextXMargin(double xMargin)

setTextY

public void setTextY(double y)

setVisible

public void setVisible(boolean visible)

Sets the visible.

Parameters:

visible - the new visible

setWidth

public void setWidth(double width)

setX

public void setX(double x)

setY

public void setY(double y)

suspend

public void suspend()

Suspend.

toggleSelection

public void toggleSelection()

getClickConsumer

protected java.util.List<java.util.function.Consumer<ComponentMouseEvent>> getClickConsumer()

Gets the click consumer.

Returns:

the click consumer

getHoverConsumer

protected java.util.List<java.util.function.Consumer<ComponentMouseEvent>> getHoverConsumer()

getMouseDraggedConsumer

protected java.util.List<java.util.function.Consumer<ComponentMouseEvent>> getMouseDraggedConsumer()

getMouseEnterConsumer

protected java.util.List<java.util.function.Consumer<ComponentMouseEvent>> getMouseEnterConsumer()

getMouseLeaveConsumer

protected java.util.List<java.util.function.Consumer<ComponentMouseEvent>> getMouseLeaveConsumer()

getMouseMovedConsumer

protected java.util.List<java.util.function.Consumer<ComponentMouseEvent>> getMouseMovedConsumer()

getMousePressedConsumer

protected java.util.List<java.util.function.Consumer<ComponentMouseEvent>> getMousePressedConsumer()

getMouseReleasedConsumer

protected java.util.List<java.util.function.Consumer<ComponentMouseEvent>> getMouseReleasedConsumer()

getMouseWheelConsumer

protected java.util.List<java.util.function.Consumer<ComponentMouseWheelEvent>> getMouseWheelConsumer()

initializeComponents

protected void initializeComponents()

mouseEventShouldBeForwarded

protected boolean mouseEventShouldBeForwarded(java.awt.event.MouseEvent e)

Mouse event should be forwarded.

Parameters:

e - the e

Returns:

true, if successful