Package xyz.gmitch215.socketmc.screen.util

Class Tooltip

java.lang.Object

xyz.gmitch215.socketmc.screen.util.Tooltip

All Implemented Interfaces:

Serializable, Narratable

public final class Tooltip
extends Object
implements Narratable

Represents a Tooltip message.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
Tooltip()	Constructs a new, empty Tooltip.
Tooltip(@NotNull String tooltipJSON, @NotNull String narrationMessageJSON)	Constructs a new Tooltip.
Tooltip(@NotNull Text tooltip)	Constructs a new Tooltip.
Tooltip(@NotNull Text tooltip, @NotNull Text narratableMessage)	Constructs a new Tooltip.

Method Summary

Modifier and Type	Method	Description
String	getNarrationMessageJSON()	Gets the JSON message that represents the narration of this element.
@NotNull String	getTooltipJSON()	Gets the JSON representation for this tooltip.
void	setNarrationMessage(@NotNull Text narrationMessage)	Sets the Narration Message for this Tooltip.
void	setNarrationMessageJSON(@NotNull String narrationMessageJSON)	Sets the Narration Message JSON for this Tooltip.
void	setTooltip(@NotNull Text tooltip)	Sets the tooltip message for this Tooltip.
void	setTooltipJSON(@NotNull String tooltipJSON)	Sets the tooltip message JSON for this Tooltip.

Methods inherited from class java.lang.Object

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

Constructor Details

Tooltip

public Tooltip()

Constructs a new, empty Tooltip.

Tooltip

public Tooltip(@NotNull
 @NotNull Text tooltip)
        throws IllegalArgumentException

Constructs a new Tooltip.

Parameters:

tooltip - Tooltip Message

Throws:

IllegalArgumentException - if tooltip is null

Tooltip

public Tooltip(@NotNull
 @NotNull Text tooltip,
 @NotNull
 @NotNull Text narratableMessage)
        throws IllegalArgumentException

Constructs a new Tooltip.

Parameters:

tooltip - Tooltip Message

narratableMessage - Narration Message

Throws:

IllegalArgumentException - if tooltip or narratableMessage is null

Tooltip

public Tooltip(@NotNull
 @NotNull String tooltipJSON,
 @NotNull
 @NotNull String narrationMessageJSON)
        throws IllegalArgumentException

Constructs a new Tooltip.

Parameters:

tooltipJSON - Tooltip Message JSON

narrationMessageJSON - Narration Message JSON

Throws:

IllegalArgumentException - if tooltipJSON or narrationMessageJSON is null

Method Details

getTooltipJSON

@NotNull
public @NotNull String getTooltipJSON()

Gets the JSON representation for this tooltip.

Returns:

JSON Representation

setTooltip

public void setTooltip(@NotNull
 @NotNull Text tooltip)

Sets the tooltip message for this Tooltip.

Parameters:

tooltip - Tooltip Message

setTooltipJSON

public void setTooltipJSON(@NotNull
 @NotNull String tooltipJSON)
                    throws IllegalArgumentException

Sets the tooltip message JSON for this Tooltip.

Parameters:

tooltipJSON - Tooltip Message JSON

Throws:

IllegalArgumentException - if tooltipJSON is null

getNarrationMessageJSON

public String getNarrationMessageJSON()

Description copied from interface: Narratable

Gets the JSON message that represents the narration of this element. By default, this is the title of the element.

Specified by:

getNarrationMessageJSON in interface Narratable

Returns:

the JSON message

setNarrationMessage

public void setNarrationMessage(@NotNull
 @NotNull Text narrationMessage)
                         throws IllegalArgumentException

Sets the Narration Message for this Tooltip.

Parameters:

narrationMessage - Narration Message

Throws:

IllegalArgumentException - if narrationMessage is null

setNarrationMessageJSON

public void setNarrationMessageJSON(@NotNull
 @NotNull String narrationMessageJSON)
                             throws IllegalArgumentException

Sets the Narration Message JSON for this Tooltip.

Parameters:

narrationMessageJSON - Narration Message JSON

Throws:

IllegalArgumentException - if narrationMessageJSON is null