net.kyori.text

Interface ScopedComponent<C extends Component>

Type Parameters:

C - the component style

All Superinterfaces:

Component

All Known Subinterfaces:

BlockNbtComponent, EntityNbtComponent, KeybindComponent, ScoreComponent, SelectorComponent, TextComponent, TranslatableComponent

public interface ScopedComponent<C extends Component>
extends Component

Some magic to change return types.

Method Summary

Modifier and Type	Method and Description
default C	append(@NonNull Component component) Appends a component to this component.
default C	append(@NonNull ComponentBuilder<?,?> builder) Appends a component to this component.
C	children(@NonNull java.util.List<Component> children) Sets the list of children.
default C	clickEvent(@Nullable ClickEvent event) Sets the click event of this component.
default C	color(@Nullable TextColor color) Sets the color of this component.
default C	decoration(@NonNull TextDecoration decoration, boolean flag) Sets the state of a decoration on this component.
default C	decoration(@NonNull TextDecoration decoration, TextDecoration.State state) Sets the value of a decoration on this component.
default C	hoverEvent(@Nullable HoverEvent event) Sets the hover event of this component.
default C	insertion(@Nullable java.lang.String insertion) Sets the string to be inserted when this component is shift-clicked.
default C	mergeColor(@NonNull Component that) Merges the color from another component into this component.
default C	mergeDecorations(@NonNull Component that) Merges the decorations from another component into this component.
default C	mergeEvents(@NonNull Component that) Merges the events from another component into this component.

Methods inherited from interface net.kyori.text.Component

children, clickEvent, color, contains, decoration, decorations, decorations, detectCycle, hasDecoration, hasStyling, hoverEvent, insertion, style, style

Method Detail

children

C children(@NonNull java.util.List<Component> children)

Description copied from interface: Component

Sets the list of children.

The contents of children will be copied.

Specified by:

children in interface Component

Parameters:

children - the children

Returns:

the unmodifiable list of children

append

default C append(@NonNull Component component)

Description copied from interface: Component

Appends a component to this component.

Specified by:

append in interface Component

Parameters:

component - the component to append

Returns:

a component with the component added

append

default C append(@NonNull ComponentBuilder<?,?> builder)

Description copied from interface: Component

Appends a component to this component.

Specified by:

append in interface Component

Parameters:

builder - the component to append

Returns:

a component with the component added

color

default C color(@Nullable TextColor color)

Description copied from interface: Component

Sets the color of this component.

Specified by:

color in interface Component

Parameters:

color - the color

Returns:

a component

decoration

default C decoration(@NonNull TextDecoration decoration,
                     boolean flag)

Description copied from interface: Component

Sets the state of a decoration on this component.

Specified by:

decoration in interface Component

Parameters:

decoration - the decoration

flag - true if this component should have the decoration, false if this component should not have the decoration

Returns:

a component

decoration

default C decoration(@NonNull TextDecoration decoration,
                     TextDecoration.State state)

Description copied from interface: Component

Sets the value of a decoration on this component.

Specified by:

decoration in interface Component

Parameters:

decoration - the decoration

state - TextDecoration.State#TRUE if this component should have the decoration, TextDecoration.State#FALSE if this component should not have the decoration, and TextDecoration.State#NOT_SET if the decoration should not have a set value

Returns:

a component

clickEvent

default C clickEvent(@Nullable ClickEvent event)

Description copied from interface: Component

Sets the click event of this component.

Specified by:

clickEvent in interface Component

Parameters:

event - the click event

Returns:

a component

hoverEvent

default C hoverEvent(@Nullable HoverEvent event)

Description copied from interface: Component

Sets the hover event of this component.

Specified by:

hoverEvent in interface Component

Parameters:

event - the hover event

Returns:

a component

insertion

default C insertion(@Nullable java.lang.String insertion)

Description copied from interface: Component

Sets the string to be inserted when this component is shift-clicked.

Specified by:

insertion in interface Component

Parameters:

insertion - the insertion string

Returns:

a component

mergeColor

default C mergeColor(@NonNull Component that)

Description copied from interface: Component

Merges the color from another component into this component.

Specified by:

mergeColor in interface Component

Parameters:

that - the other component

Returns:

a component

mergeDecorations

default C mergeDecorations(@NonNull Component that)

Description copied from interface: Component

Merges the decorations from another component into this component.

Specified by:

mergeDecorations in interface Component

Parameters:

that - the other component

Returns:

a component

mergeEvents

default C mergeEvents(@NonNull Component that)

Description copied from interface: Component

Merges the events from another component into this component.

Specified by:

mergeEvents in interface Component

Parameters:

that - the other component

Returns:

a component