Class GuiComponent

All Implemented Interfaces:
IRenderable, Tweenable, MouseListener, MouseMotionListener, MouseWheelListener, EventListener
Direct Known Subclasses:
DropdownListField, ImageComponent, ImageComponentList, ListField, Screen, Slider, SpeechBubble
public abstract class GuiComponent extends Object implements MouseListener, MouseMotionListener, MouseWheelListener, IRenderable, Tweenable
The abstract Class GuiComponent provides all properties and methods needed for screens, built-in, and custom GUI components such as buttons, sliders, etc... It includes mouse event handling, different hovering states and appearances, and texts to be rendered.

  • Field Details

    • ICON_FONT

      protected static final Font ICON_FONT

  • Constructor Details

    • GuiComponent

      protected GuiComponent(double x, double y)
      Instantiates a new gui component with the dimension (0,0) at the given location.
      Parameters:
      x - the x
      y - the y

    • GuiComponent

      protected GuiComponent(double x, double y, double width, double height)
      Instantiates a new gui component at the point (x,y) with the dimension (width,height).
      Parameters:
      x - the x
      y - the y
      width - the width
      height - the height

  • Method Details

    • getAppearance

      public Appearance getAppearance()
      Gets the default appearance object for this GuiComponent.
      Returns:
      the appearance

    • getAppearanceDisabled

      public Appearance getAppearanceDisabled()
      Gets the appearance object for this GuiComponent while disabled.
      Returns:
      the appearance disabled

    • getAppearanceHovered

      public Appearance getAppearanceHovered()
      Gets the appearance object for this GuiComponent while hovered.
      Returns:
      the hovered appearance

    • getBoundingBox

      public Rectangle2D getBoundingBox()
      Gets the bounding box of this GuiComponent.
      Returns:
      the bounding box

    • getComponentId

      public int getComponentId()
      Gets the component id of this GuiComponent.
      Returns:
      the component id

    • getFocusedComponent

      public static GuiComponent getFocusedComponent()

    • getComponents

      public List<GuiComponent> getComponents()
      Gets the child components of this GuiComponent. Components are rendered in list order. A later component is therefore above an earlier component and receives mouse input first where their bounds overlap.
      Returns:
      the child components

    • getFont

      public Font getFont()
      Gets the font of this GuiComponent's text.
      Returns:
      the GuiComponent's font

    • getHeight

      public double getHeight()
      Gets the height of this GuiComponent.
      Returns:
      the height

    • getHoverSound

      public Sound getHoverSound()
      Gets the sound that is played when hovering the GuiComponent.
      Returns:
      the hover sound

    • getLocation

      public Point2D getLocation()
      Gets the screen location of this GuiComponent.
      Returns:
      the screen location

    • getName

      public String getName()
      Gets the name of this GuiComponent.
      Returns:
      the name

    • getTag

      public Object getTag()
      Gets the tag.
      Returns:
      the tag

    • getText

      public String getText()
      Gets the entire Text associated with this GuiComponent. Parts of the Text may get cropped and can therefore be invisible. To retrieve only the visible part of the text, use GuiComponent.getTextToRender(Graphics2D g).
      Returns:
      the entire text on this GuiComponent

    • getTextAlign

      public Align getTextAlign()
      Gets the horizontal text alignment.
      Returns:
      the horizontal text alignment

    • getTextValign

      public Valign getTextValign()
      Gets the vertical text alignment.
      Returns:
      the vertical text alignment

    • getTextAngle

      public int getTextAngle()
      Gets the text angle.
      Returns:
      the text angle

    • hasTextAntialiasing

      public boolean hasTextAntialiasing()
      Check whether text antialiasing is activated.
      Returns:
      true, if this GuiComponent is currently configured to draw its text with antialiasing.

    • hasTextShadow

      public boolean hasTextShadow()
      Check whether text shadow is activated.
      Returns:
      true, if this GuiComponent is currently configured to draw a shadow below its text.

    • getTextShadowColor

      public Color getTextShadowColor()

    • setTextShadowColor

      public void setTextShadowColor(Color textShadowColor)

    • getTextShadowRadius

      public float getTextShadowRadius()

    • setTextShadowRadius

      public void setTextShadowRadius(float textShadowRadius)

    • hasAutomaticLineBreaks

      public boolean hasAutomaticLineBreaks()

    • getTextToRender

      public String getTextToRender(Graphics2D g)
      Gets only the non-cropped bits of Text visible on this GuiComponent.m To retrieve only the entire text associated with this GuiComponent, use GuiComponent.getText().
      Parameters:
      g - The graphics object to render on.
      Returns:
      the text to render

    • getTextX

      public double getTextX()
      Gets the text X coordinate.
      Returns:
      the text X

    • getTextY

      public double getTextY()
      Gets the text Y coordinate.
      Returns:
      the text Y

    • getWidth

      public double getWidth()
      Gets the width of this GuiComponent.
      Returns:
      the width

    • getX

      public double getX()
      Gets the x coordinate of this GuiComponent.
      Returns:
      the x coordinate

    • getCenterX

      public double getCenterX()
      Gets x coordinate of this GuiComponent's center point.
      Returns:
      the center x coordinate

    • getCenterY

      public double getCenterY()
      Gets y coordinate of this GuiComponent's center point.
      Returns:
      the center y coordinate

    • getY

      public double getY()
      Gets the y coordinate of this GuiComponent.
      Returns:
      the y coordinate

    • isEnabled

      public boolean isEnabled()
      Checks if the GuiComponent is enabled.
      Returns:
      true, if is enabled

    • isAutoScaling

      public boolean isAutoScaling()

      Returns whether this component automatically scales its position and size proportionally when the game window resolution changes.

      When enabled (the default), the component's position and size are stored as fractions of the window dimensions and recalculated on each resolution change via onResolutionChanged(Dimension). When disabled, the component retains its absolute pixel position and size across resolution changes; only child propagation still occurs.

      Returns:
      true if proportional auto-scaling is enabled; false otherwise
      See Also:

    • isForwardMouseEvents

      public boolean isForwardMouseEvents()
      Checks if mouse events are being forwarded by this GuiComponent.
      Returns:
      true, the GuiComponent forwards mouse events

    • isFocusable

      public boolean isFocusable()

    • hasInputFocus

      public boolean hasInputFocus()

    • isHovered

      public boolean isHovered()
      Checks if the cursor bounding box intersects with this GuiComponent's bounding box.
      Returns:
      true, if the GuiComponent is hovered

    • isPressed

      public boolean isPressed()
      Checks if the mouse button is currently being pressed on this GuiComponent.
      Returns:
      true, if the mouse is currently pressed on the GuiComponent

    • isSelected

      public boolean isSelected()
      Checks if the GuiComponent is currently selected.
      Returns:
      true, if the GuiComponent is selected

    • isSuspended

      public boolean isSuspended()
      Checks if the GuiComponent is currently suspended.
      Returns:
      true, if the GuiComponent is suspended

    • isVisible

      public boolean isVisible()
      Checks if the GuiComponent is currently visible.
      Returns:
      true, if the GuiComponent is visible

    • mouseClicked

      public void mouseClicked(MouseEvent e)
      Specified by:
      mouseClicked in interface MouseListener

    • mouseDragged

      public void mouseDragged(MouseEvent e)
      Specified by:
      mouseDragged in interface MouseMotionListener

    • mouseEntered

      public void mouseEntered(MouseEvent e)
      Specified by:
      mouseEntered in interface MouseListener

    • mouseExited

      public void mouseExited(MouseEvent e)
      Specified by:
      mouseExited in interface MouseListener

    • mouseMoved

      public void mouseMoved(MouseEvent e)
      Specified by:
      mouseMoved in interface MouseMotionListener

    • mousePressed

      public void mousePressed(MouseEvent e)
      Specified by:
      mousePressed in interface MouseListener

    • mouseReleased

      public void mouseReleased(MouseEvent e)
      Specified by:
      mouseReleased in interface MouseListener

    • mouseWheelMoved

      public void mouseWheelMoved(MouseWheelEvent e)
      Specified by:
      mouseWheelMoved in interface MouseWheelListener

    • onClicked

      public void onClicked(Consumer<ComponentMouseEvent> callback)
      Add a callback that is being executed if this GuiComponent is clicked once.
      Parameters:
      callback - the callback

    • onHovered

      public void onHovered(Consumer<ComponentMouseEvent> callback)
      Add a callback that is being executed if this GuiComponent is hovered with the mouse.
      Parameters:
      callback - the callback

    • onMouseDragged

      public void onMouseDragged(Consumer<ComponentMouseEvent> callback)
      Add a callback that is being executed if the mouse is pressed and moving around while within the bounds of this GuiComponent.
      Parameters:
      callback - the callback

    • onMouseEnter

      public void onMouseEnter(Consumer<ComponentMouseEvent> callback)
      Add a callback that is being executed if the mouse enters the bounds of this GuiComponent.
      Parameters:
      callback - the callback

    • onMouseLeave

      public void onMouseLeave(Consumer<ComponentMouseEvent> callback)
      Add a callback that is being executed if the mouse leaves the bounds of this GuiComponent.
      Parameters:
      callback - the callback

    • onMouseMoved

      public void onMouseMoved(Consumer<ComponentMouseEvent> callback)
      Add a callback that is being executed if the mouse is moving around while within the bounds of this GuiComponent.
      Parameters:
      callback - the callback

    • onMousePressed

      public void onMousePressed(Consumer<ComponentMouseEvent> callback)
      Add a callback that is being executed if the mouse is continually pressed while within the bounds of this GuiComponent.
      Parameters:
      callback - the callback

    • onMouseReleased

      public void onMouseReleased(Consumer<ComponentMouseEvent> callback)
      Add a callback that is being executed if the mouse button is released while within the bounds of this GuiComponent.
      Parameters:
      callback - the callback

    • onMouseWheelScrolled

      public void onMouseWheelScrolled(Consumer<ComponentMouseWheelEvent> callback)
      Add a callback that is being executed if the mouse wheel is scrolled while within the bounds of this GuiComponent.
      Parameters:
      callback - the callback

    • onTextChanged

      public void onTextChanged(Consumer<String> cons)
      Add a callback that is being executed if the text on this GuiComponent changes.
      Parameters:
      cons - the cons

    • addRenderListener

      public void addRenderListener(ComponentRenderListener listener)

    • removeListener

      public void removeListener(ComponentRenderListener listener)

    • addRenderedListener

      public void addRenderedListener(ComponentRenderedListener listener)

    • removeListener

      public void removeListener(ComponentRenderedListener listener)

    • prepare

      public void prepare()
      Prepare the GuiComponent and all its child Components (Makes the GuiComponent visible and adds mouse listeners.). This is, for example, done right before switching to a new screen.

    • render

      public void render(Graphics2D g)
      Note: If you override this and are modifying swing components, be sure you are in the AWT thread when you do so!
      Specified by:
      render in interface IRenderable
      Parameters:
      g - The current graphics object onto which this instance will render its visual contents.
      See Also:

    • getTweenValues

      public float[] getTweenValues(TweenType tweenType)
      Description copied from interface: Tweenable
      Gets one or many values from the target object associated to the given tween type. It is used by the Tween Engine to determine starting values.
      Specified by:
      getTweenValues in interface Tweenable
      Parameters:
      tweenType - The tween type of this interpolation, determining which values are modified.
      Returns:
      The array of current tween values.

    • setTweenValues

      public void setTweenValues(TweenType tweenType, float[] newValues)
      Description copied from interface: Tweenable
      This method is called in a Tween's update() method to set the new interpolated values.
      Specified by:
      setTweenValues in interface Tweenable
      Parameters:
      tweenType - The tween type of this interpolation, determining which values are modified.
      newValues - The new values determined by the tween equation.

    • getShape

      public RectangularShape getShape()

    • setDimension

      public void setDimension(double width, double height)
      Sets the width and height of this GuiComponent.
      Parameters:
      width - the width
      height - the height

    • onResolutionChanged

      public void onResolutionChanged(Dimension resolution)

      Called when the game window resolution changes, e.g. after switching DisplayMode at runtime.

      If isAutoScaling() is true (the default) and this component was initialized with valid window dimensions, its position and size are recalculated from the stored relative fractions so the component scales proportionally with the window. When auto-scaling is disabled, the component retains its absolute pixel position and size.

      The event is always recursively forwarded to all child components regardless of the parent's auto-scaling setting.

      Override this method to implement custom re-layout logic that goes beyond proportional scaling.

      Parameters:
      resolution - The new window dimensions.
      See Also:

    • setEnabled

      public void setEnabled(boolean enabled)
      Sets the "enabled" property on this GuiComponent and its child components.
      Parameters:
      enabled - the new enabled property

    • setAutoScaling

      public void setAutoScaling(boolean autoScaling)

      Enables or disables automatic proportional scaling of this component when the game window resolution changes.

      When set to false, the component keeps its current absolute pixel position and size across resolution changes. The resolution change event is still propagated to child components, so children with auto-scaling enabled will still scale even if the parent does not.

      Auto-scaling is enabled by default.

      Parameters:
      autoScaling - true to enable proportional auto-scaling; false to disable it
      See Also:

    • setFont

      public void setFont(Font font)
      Sets the font for this GuiComponent's text.
      Parameters:
      font - the new font

    • setFocusable

      public void setFocusable(boolean focusable)

    • setFontSize

      public void setFontSize(float size)
      Sets the font size for this GuiComponent's text.
      Parameters:
      size - the new font size

    • setForwardMouseEvents

      public void setForwardMouseEvents(boolean forwardMouseEvents)
      Enable or disable forwarding mouse events by this GuiComponent.
      Parameters:
      forwardMouseEvents - the new forward mouse events

    • setHeight

      public void setHeight(double height)
      Sets the GuiComponent's height.
      Parameters:
      height - the new height

    • setHovered

      public void setHovered(boolean hovered)
      Sets the "hovered" property on this GuiComponent.
      Parameters:
      hovered - the new hovered

    • setHoverSound

      public void setHoverSound(Sound hoverSound)
      Sets the hover sound.
      Parameters:
      hoverSound - the new hover sound

    • setLocation

      public void setLocation(double x, double y)
      Sets this GuiComponent's location.
      Parameters:
      x - the new x coordinate
      y - the new y coordinate

    • setLocation

      public void setLocation(Point2D location)
      Sets this GuiComponent's location.
      Parameters:
      location - the new location

    • setName

      public void setName(String name)
      Sets this GuiComponent's name.
      Parameters:
      name - the new name

    • setSelected

      public void setSelected(boolean bool)
      Sets the "selected" property on this GuiComponent.
      Parameters:
      bool - the new selected

    • setTag

      public void setTag(Object tag)
      Sets the tag.
      Parameters:
      tag - the new tag

    • setText

      public void setText(String text)
      Sets the text.
      Parameters:
      text - the new text

    • setTextAntialiasing

      public void setTextAntialiasing(boolean antialiasing)
      Sets the RenderingHints.KEY_TEXT_ANTIALIASING settings for the rendered text.
      Parameters:
      antialiasing - Either RenderingHints.VALUE_TEXT_ANTIALIAS_ON or RenderingHints.VALUE_TEXT_ANTIALIAS_OFF

    • setAutomaticLineBreaks

      public void setAutomaticLineBreaks(boolean automaticLineBreaks)

    • setTextAlign

      public void setTextAlign(Align textAlign)
      Sets the horizontal text alignment.
      Parameters:
      textAlign - the new text align

    • setTextValign

      public void setTextValign(Valign textValign)
      Sets the vertical text alignment.
      Parameters:
      textValign - the new text align

    • setTextAngle

      public void setTextAngle(int textAngle)
      Sets the text angle in degrees.
      Parameters:
      textAngle - the new text angle in degrees

    • setTextShadow

      public void setTextShadow(boolean drawTextShadow)
      Enable or disable the shadow being drawn below the text
      Parameters:
      drawTextShadow - the boolean determining if a text shadow should be drawn

    • setTextX

      public void setTextX(double x)
      Sets the text X coordinate.
      Parameters:
      x - the new text X

    • setTextY

      public void setTextY(double y)
      Sets the text Y coordinate.
      Parameters:
      y - the new text Y

    • setVisible

      public void setVisible(boolean visible)
      Sets the "visible" property on this GuiComponent.
      Parameters:
      visible - the new visible

    • setWidth

      public void setWidth(double width)
      Sets the GuiComponent's width.
      Parameters:
      width - the new width

    • setX

      public void setX(double x)
      Sets the GuiComponent's x coordinate.
      Parameters:
      x - the new x coordinate

    • setY

      public void setY(double y)
      Sets the GuiComponent's y coordinate.
      Parameters:
      y - the new y coordinate

    • suspend

      public void suspend()
      Suspend the GuiComponent and all its child Components (Makes the GuiComponent invisible and removes mouse listeners.).

    • toggleSelection

      public void toggleSelection()
      Toggle this GuiComponent's selection.

    • toggleSuspension

      public void toggleSuspension()
      Toggle this GuiComponent's suspension state. If it's suspended, prepare it. If it's prepared, suspend it.

    • getCurrentAppearance

      public Appearance getCurrentAppearance()

    • getClickConsumer

      protected List<Consumer<ComponentMouseEvent>> getClickConsumer()
      Gets the click consumer list.
      Returns:
      the click consumer list

    • getHoverConsumer

      protected List<Consumer<ComponentMouseEvent>> getHoverConsumer()
      Gets the hover consumer list.
      Returns:
      the hover consumer list

    • getMouseDraggedConsumer

      protected List<Consumer<ComponentMouseEvent>> getMouseDraggedConsumer()
      Gets the mouse dragged consumer list.
      Returns:
      the mouse dragged consumer list

    • getMouseEnterConsumer

      protected List<Consumer<ComponentMouseEvent>> getMouseEnterConsumer()
      Gets the mouse enter consumer list.
      Returns:
      the mouse enter consumer list

    • getMouseLeaveConsumer

      protected List<Consumer<ComponentMouseEvent>> getMouseLeaveConsumer()
      Gets the mouse leave consumer list.
      Returns:
      the mouse leave consumer list

    • getMouseMovedConsumer

      protected List<Consumer<ComponentMouseEvent>> getMouseMovedConsumer()
      Gets the mouse moved consumer list.
      Returns:
      the mouse moved consumer list

    • getMousePressedConsumer

      protected List<Consumer<ComponentMouseEvent>> getMousePressedConsumer()
      Gets the mouse pressed consumer list.
      Returns:
      the mouse pressed consumer list

    • getMouseReleasedConsumer

      protected List<Consumer<ComponentMouseEvent>> getMouseReleasedConsumer()
      Gets the mouse released consumer list.
      Returns:
      the mouse released consumer list

    • getMouseWheelConsumer

      protected List<Consumer<ComponentMouseWheelEvent>> getMouseWheelConsumer()
      Gets the mouse wheel consumer list.
      Returns:
      the mouse wheel consumer list

    • initializeComponents

      protected void initializeComponents()
      Initialize child components.

    • mouseEventShouldBeForwarded

      protected boolean mouseEventShouldBeForwarded(MouseEvent e)
      Check if a Mouse event should be forwarded.
      Parameters:
      e - the mouse event
      Returns:
      true, if the Mouse event should be forwarded