Package xyz.gmitch215.socketmc.screen.ui

Class AbstractWidget

java.lang.Object

xyz.gmitch215.socketmc.screen.ui.AbstractWidget

All Implemented Interfaces:

Serializable, LayoutElement, Positionable

Direct Known Subclasses:

AbstractTextWidget, ImageWidget

public abstract class AbstractWidget
extends Object
implements Positionable

Represents a Widget on the screen. This class is not legal for implementation!

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_PADDING	The default padding around text elements.
protected int	height	The height of this widget.
protected @Nullable Tooltip	tooltip	The tooltip for this widget.
protected int	width	The width of this widget.
protected int	x	The x-coordinate of this widget.
protected int	y	The y-coordinate of this widget.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractWidget(int x, int y, int width, int height)	Constructs a new widget.
protected	AbstractWidget(@NotNull ElementBounds bounds)	Constructs a new widget.

Method Summary

Modifier and Type	Method	Description
void	clearListeners()	Clears all listeners from this widget.
boolean	equals(Object o)
final int	getHeight()	Gets the height of this object.
Set<SerializableConsumer<Positionable>>	getListeners()	Gets an immutable copy of the listeners for this widget.
final Tooltip	getTooltip()	Gets the tooltip for this widget.
final int	getWidth()	Gets the width of this object.
final int	getX()	Gets the x-coordinate of this object.
final int	getY()	Gets the y-coordinate of this object.
final int	hashCode()
void	onClick(@NotNull SerializableConsumer<Positionable> listener)	Adds an on-click listener to this widget.
final void	setHeight(int height)	Sets the height of this object.
final void	setTooltip(@Nullable Tooltip tooltip)	Sets the tooltip for this widget.
final void	setWidth(int width)	Sets the width of this object.
final void	setX(int x)	Sets the x-coordinate of this object.
final void	setY(int y)	Sets the y-coordinate of this object.
final String	toString()
final void	visitWidgets(@NotNull Consumer<AbstractWidget> visitor)	Visits this object, applying a function to it.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface xyz.gmitch215.socketmc.screen.layout.LayoutElement

setPosition, setSize, setSize, setSize

Methods inherited from interface xyz.gmitch215.socketmc.screen.Positionable

inSamePosition

Field Details

DEFAULT_PADDING

public static final int DEFAULT_PADDING

The default padding around text elements.

See Also:

• Constant Field Values

x

protected int x

The x-coordinate of this widget.

y

protected int y

The y-coordinate of this widget.

width

protected int width

The width of this widget.

height

protected int height

The height of this widget.

tooltip

@Nullable
protected @Nullable Tooltip tooltip

The tooltip for this widget.

Constructor Details

AbstractWidget

protected AbstractWidget(@NotNull
 @NotNull ElementBounds bounds)

Constructs a new widget.

Parameters:

bounds - the bounds

AbstractWidget

protected AbstractWidget(int x,
 int y,
 int width,
 int height)
                  throws IllegalArgumentException

Constructs a new widget.

Parameters:

x - the x-coordinate

y - the y-coordinate

width - the width

height - the height

Throws:

IllegalArgumentException - if coordinates or dimensions are negative

Method Details

getX

public final int getX()

Description copied from interface: LayoutElement

Gets the x-coordinate of this object.

Specified by:

getX in interface LayoutElement

Returns:

the x-coordinate

setX

public final void setX(int x)

Description copied from interface: LayoutElement

Sets the x-coordinate of this object.

Specified by:

setX in interface LayoutElement

Parameters:

x - the x-coordinate

getY

public final int getY()

Description copied from interface: LayoutElement

Gets the y-coordinate of this object.

Specified by:

getY in interface LayoutElement

Returns:

the y-coordinate

setY

public final void setY(int y)

Description copied from interface: LayoutElement

Sets the y-coordinate of this object.

Specified by:

setY in interface LayoutElement

Parameters:

y - the y-coordinate

getWidth

public final int getWidth()

Description copied from interface: LayoutElement

Gets the width of this object.

Specified by:

getWidth in interface LayoutElement

Returns:

the width

setWidth

public final void setWidth(int width)

Description copied from interface: LayoutElement

Sets the width of this object.

Specified by:

setWidth in interface LayoutElement

Parameters:

width - the width

getHeight

public final int getHeight()

Description copied from interface: LayoutElement

Gets the height of this object.

Specified by:

getHeight in interface LayoutElement

Returns:

the height

setHeight

public final void setHeight(int height)

Description copied from interface: LayoutElement

Sets the height of this object.

Specified by:

setHeight in interface LayoutElement

Parameters:

height - the height

getTooltip

public final Tooltip getTooltip()

Description copied from interface: Positionable

Gets the tooltip for this widget.

Specified by:

getTooltip in interface Positionable

Returns:

Widget Tooltip

setTooltip

public final void setTooltip(@Nullable
 @Nullable Tooltip tooltip)

Description copied from interface: Positionable

Sets the tooltip for this widget.

Specified by:

setTooltip in interface Positionable

Parameters:

tooltip - Widget Tooltip

visitWidgets

public final void visitWidgets(@NotNull
 @NotNull Consumer<AbstractWidget> visitor)

Description copied from interface: LayoutElement

Visits this object, applying a function to it.

Specified by:

visitWidgets in interface LayoutElement

Parameters:

visitor - the visitor

onClick

public void onClick(@NotNull
 @NotNull SerializableConsumer<Positionable> listener)

Description copied from interface: Positionable

Adds an on-click listener to this widget.

Specified by:

onClick in interface Positionable

Parameters:

listener - the listener

See Also:

• SerializableConsumer

clearListeners

public void clearListeners()

Description copied from interface: Positionable

Clears all listeners from this widget.

Specified by:

clearListeners in interface Positionable

getListeners

public Set<SerializableConsumer<Positionable>> getListeners()

Description copied from interface: Positionable

Gets an immutable copy of the listeners for this widget.

Specified by:

getListeners in interface Positionable

Returns:

the listeners

toString

public final String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object