Package xyz.gmitch215.socketmc.screen.ui

Class CustomButton

java.lang.Object

xyz.gmitch215.socketmc.screen.ui.AbstractWidget

xyz.gmitch215.socketmc.screen.ui.AbstractTextWidget

xyz.gmitch215.socketmc.screen.ui.AbstractButton

xyz.gmitch215.socketmc.screen.ui.CustomButton

All Implemented Interfaces:

Serializable, LayoutElement, Positionable

public final class CustomButton
extends AbstractButton

Represents a custom button, rendered through a DrawingContext.

See Also:

• Serialized Form

Field Summary

Fields inherited from class xyz.gmitch215.socketmc.screen.ui.AbstractButton

BIG_WIDTH, DEFAULT_HEIGHT, DEFAULT_SPACING, DEFAULT_WIDTH, SMALL_WIDTH

Fields inherited from class xyz.gmitch215.socketmc.screen.ui.AbstractWidget

DEFAULT_PADDING, height, tooltip, width, x, y

Constructor Summary

Constructors

Constructor	Description
CustomButton(int x, int y, int width, int height, @NotNull String messageJSON, @NotNull DrawingContext context, boolean renderDefault)	Creates a new CustomButton.
CustomButton(int x, int y, int width, int height, @NotNull Text message, @NotNull DrawingContext context)	Creates a new CustomButton.
CustomButton(int x, int y, int width, int height, @NotNull Text message, @NotNull DrawingContext context, boolean renderDefault)	Creates a new CustomButton.
CustomButton(int x, int y, @NotNull Text message, @NotNull DrawingContext context)	Creates a new CustomButton.
CustomButton(int x, int y, @NotNull Text message, @NotNull DrawingContext context, boolean renderDefault)	Creates a new CustomButton.
CustomButton(@NotNull ElementBounds bounds, @NotNull Text message, @NotNull DrawingContext context)	Creates a new CustomButton.
CustomButton(@NotNull ElementBounds bounds, @NotNull Text message, @NotNull DrawingContext context, boolean renderDefault)	Creates a new CustomButton.

Method Summary

Modifier and Type	Method	Description
@NotNull DrawingContext	getContext()	Gets the drawing context of the button.
boolean	isRenderDefault()	Gets whether the default button setup should be rendered.
void	setRenderDefault(boolean renderDefault)	Sets whether to render the default button.

Methods inherited from class xyz.gmitch215.socketmc.screen.ui.AbstractTextWidget

equals, getMessageJSON, setMessage, setMessageJSON

Methods inherited from class xyz.gmitch215.socketmc.screen.ui.AbstractWidget

clearListeners, getHeight, getListeners, getTooltip, getWidth, getX, getY, hashCode, onClick, setHeight, setTooltip, setWidth, setX, setY, toString, visitWidgets

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

Constructor Details

CustomButton

public CustomButton(@NotNull
 @NotNull ElementBounds bounds,
 @NotNull
 @NotNull Text message,
 @NotNull
 @NotNull DrawingContext context)
             throws IllegalArgumentException

Creates a new CustomButton.

Parameters:

bounds - the bounds of the button

message - the message of the button

context - the drawing context

Throws:

IllegalArgumentException - if the text or drawing context is null

CustomButton

public CustomButton(int x,
 int y,
 @NotNull
 @NotNull Text message,
 @NotNull
 @NotNull DrawingContext context)
             throws IllegalArgumentException

Creates a new CustomButton.

Parameters:

x - the x-coordinate of the button

y - the y-coordinate of the button

message - the message of the button

context - the drawing context

Throws:

IllegalArgumentException - if the text or drawing context is null

CustomButton

public CustomButton(int x,
 int y,
 int width,
 int height,
 @NotNull
 @NotNull Text message,
 @NotNull
 @NotNull DrawingContext context)
             throws IllegalArgumentException

Creates a new CustomButton.

Parameters:

x - the x-coordinate of the button

y - the y-coordinate of the button

width - the width of the button

height - the height of the button

message - the message of the button

context - the drawing context

Throws:

IllegalArgumentException - if the bounds are invalid, or if the text or drawing context is null

CustomButton

public CustomButton(@NotNull
 @NotNull ElementBounds bounds,
 @NotNull
 @NotNull Text message,
 @NotNull
 @NotNull DrawingContext context,
 boolean renderDefault)
             throws IllegalArgumentException

Creates a new CustomButton.

Parameters:

bounds - the bounds of the button

message - the message of the button

context - the drawing context

renderDefault - whether to render the default button

Throws:

IllegalArgumentException - if the text or drawing context is null

CustomButton

public CustomButton(int x,
 int y,
 @NotNull
 @NotNull Text message,
 @NotNull
 @NotNull DrawingContext context,
 boolean renderDefault)
             throws IllegalArgumentException

Creates a new CustomButton.

Parameters:

x - the x-coordinate of the button

y - the y-coordinate of the button

message - the message of the button

context - the drawing context

renderDefault - whether to render the default button

Throws:

IllegalArgumentException - if the text or drawing context is null

CustomButton

public CustomButton(int x,
 int y,
 int width,
 int height,
 @NotNull
 @NotNull Text message,
 @NotNull
 @NotNull DrawingContext context,
 boolean renderDefault)
             throws IllegalArgumentException

Creates a new CustomButton.

Parameters:

x - the x-coordinate of the button

y - the y-coordinate of the button

width - the width of the button

height - the height of the button

message - the message of the button

context - the drawing context

renderDefault - whether to render the default button

Throws:

IllegalArgumentException - if the bounds are invalid, or if the text or drawing context is null

CustomButton

public CustomButton(int x,
 int y,
 int width,
 int height,
 @NotNull
 @NotNull String messageJSON,
 @NotNull
 @NotNull DrawingContext context,
 boolean renderDefault)
             throws IllegalArgumentException

Creates a new CustomButton.

Parameters:

x - the x-coordinate of the button

y - the y-coordinate of the button

width - the width of the button

height - the height of the button

messageJSON - the message of the button

context - the drawing context

renderDefault - whether to render the default button

Throws:

IllegalArgumentException - if the bounds are invalid, or if the text or drawing context is null

Method Details

getContext

@NotNull
public @NotNull DrawingContext getContext()

Gets the drawing context of the button.

Returns:

the drawing context

isRenderDefault

public boolean isRenderDefault()

Gets whether the default button setup should be rendered.

Returns:

Whether to render the default button

setRenderDefault

public void setRenderDefault(boolean renderDefault)

Sets whether to render the default button.

Parameters:

renderDefault - whether to render the default button