Package net.kyori.adventure.text

Interface ScopedComponent<C extends Component>

Type Parameters:

C - the component type

All Superinterfaces:

Component, ComponentBuilderApplicable, ComponentLike, net.kyori.examination.Examinable, HoverEventSource<Component>, StyleGetter, StyleSetter<Component>

All Known Subinterfaces:

BlockNBTComponent, EntityNBTComponent, KeybindComponent, ScoreComponent, SelectorComponent, StorageNBTComponent, TextComponent, TranslatableComponent

public interface ScopedComponent<C extends Component>
extends Component

Some magic to change return types.

Since:

4.0.0

Field Summary

Fields inherited from interface net.kyori.adventure.text.Component

EQUALS, EQUALS_IDENTITY, IS_NOT_EMPTY

Method Summary

Modifier and Type	Method	Description
default C	append(@NotNull Component component)	Appends a component to this component.
default C	append(@NotNull ComponentBuilder<?,?> builder)	Appends a component to this component.
default C	append(@NotNull ComponentLike like)	Appends a component to this component.
C	children(@NotNull java.util.List<? extends ComponentLike> 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	colorIfAbsent(@Nullable TextColor color)	Sets the color if there isn't one set already.
default C	decorate(@NotNull TextDecoration decoration)	Sets the state of decoration to TextDecoration.State.TRUE on this component.
default C	decoration(@NotNull TextDecoration decoration, boolean flag)	Sets the state of a decoration on this component.
default C	decoration(@NotNull TextDecoration decoration, @NotNull TextDecoration.State state)	Sets the value of a decoration on this component.
default C	hoverEvent(@Nullable HoverEventSource<?> 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	mergeStyle(@NotNull Component that)	Merges from another style into this component's style.
default C	mergeStyle(@NotNull Component that, @NotNull java.util.Set<Style.Merge> merges)	Merges from another style into this component's style.
default C	mergeStyle(@NotNull Component that, @NotNull Style.Merge @NotNull ... merges)	Merges from another style into this component's style.
default C	style(@NotNull java.util.function.Consumer<Style.Builder> style)	Sets the style of this component.
C	style(@NotNull Style style)	Sets the style of this component.
default C	style(@NotNull Style.Builder style)	Sets the style of this component.

Methods inherited from interface net.kyori.adventure.text.Component

appendNewline, appendSpace, applyFallbackStyle, applyFallbackStyle, asComponent, asHoverEvent, children, clickEvent, color, compact, componentBuilderApply, contains, contains, decoration, decorationIfAbsent, decorations, decorations, detectCycle, examinableProperties, font, font, hasDecoration, hasStyling, hoverEvent, insertion, iterable, iterable, iterator, iterator, replaceFirstText, replaceFirstText, replaceText, replaceText, replaceText, replaceText, replaceText, replaceText, replaceText, replaceText, spliterator, spliterator, style, style

Methods inherited from interface net.kyori.examination.Examinable

examinableName, examine

Methods inherited from interface net.kyori.adventure.text.event.HoverEventSource

asHoverEvent

Methods inherited from interface net.kyori.adventure.text.format.StyleSetter

decorate, decorations

Method Detail

children

@NotNull
C children(@NotNull
           @NotNull java.util.List<? extends ComponentLike> 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:

a component with the children set

style

@NotNull
C style(@NotNull
        @NotNull Style style)

Description copied from interface: Component

Sets the style of this component.

Specified by:

style in interface Component

Parameters:

style - the style

Returns:

a component

style

@NotNull
default C style(@NotNull
                @NotNull java.util.function.Consumer<Style.Builder> style)

Description copied from interface: Component

Sets the style of this component.

Specified by:

style in interface Component

Parameters:

style - the style consumer

Returns:

a component

style

@NotNull
default C style(@NotNull Style.Builder style)

Description copied from interface: Component

Sets the style of this component.

Specified by:

style in interface Component

Parameters:

style - the style

Returns:

a component

mergeStyle

@NotNull
default C mergeStyle(@NotNull
                     @NotNull Component that)

Description copied from interface: Component

Merges from another style into this component's style.

Specified by:

mergeStyle in interface Component

Parameters:

that - the other style

Returns:

a component

mergeStyle

@NotNull
default C mergeStyle(@NotNull
                     @NotNull Component that,
                     @NotNull Style.Merge @NotNull ... merges)

Description copied from interface: Component

Merges from another style into this component's style.

Specified by:

mergeStyle in interface Component

Parameters:

that - the other style

merges - the style parts to merge

Returns:

a component

append

@NotNull
default C append(@NotNull
                 @NotNull 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

@NotNull
default C append(@NotNull
                 @NotNull ComponentLike like)

Description copied from interface: Component

Appends a component to this component.

Specified by:

append in interface Component

Parameters:

like - the component to append

Returns:

a component with the component added

append

@NotNull
default C append(@NotNull
                 @NotNull 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

mergeStyle

@NotNull
default C mergeStyle(@NotNull
                     @NotNull Component that,
                     @NotNull
                     @NotNull java.util.Set<Style.Merge> merges)

Description copied from interface: Component

Merges from another style into this component's style.

Specified by:

mergeStyle in interface Component

Parameters:

that - the other style

merges - the style parts to merge

Returns:

a component

color

@NotNull
default C color(@Nullable
                @Nullable TextColor color)

Description copied from interface: Component

Sets the color of this component.

Specified by:

color in interface Component

Specified by:

color in interface StyleSetter<C extends Component>

Parameters:

color - the color

Returns:

a component

colorIfAbsent

@NotNull
default C colorIfAbsent(@Nullable
                        @Nullable TextColor color)

Description copied from interface: Component

Sets the color if there isn't one set already.

Specified by:

colorIfAbsent in interface Component

Specified by:

colorIfAbsent in interface StyleSetter<C extends Component>

Parameters:

color - the color

Returns:

a component

decorate

@NotNull
default C decorate(@NotNull
                   @NotNull TextDecoration decoration)

Description copied from interface: Component

Sets the state of decoration to TextDecoration.State.TRUE on this component.

Specified by:

decorate in interface Component

Specified by:

decorate in interface StyleSetter<C extends Component>

Parameters:

decoration - the decoration

Returns:

a component

decoration

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

Description copied from interface: Component

Sets the state of a decoration on this component.

Specified by:

decoration in interface Component

Specified by:

decoration in interface StyleSetter<C extends 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

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

Description copied from interface: Component

Sets the value of a decoration on this component.

Specified by:

decoration in interface Component

Specified by:

decoration in interface StyleSetter<C extends 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

@NotNull
default C clickEvent(@Nullable
                     @Nullable ClickEvent event)

Description copied from interface: Component

Sets the click event of this component.

Specified by:

clickEvent in interface Component

Specified by:

clickEvent in interface StyleSetter<C extends Component>

Parameters:

event - the click event

Returns:

a component

hoverEvent

@NotNull
default C hoverEvent(@Nullable
                     @Nullable HoverEventSource<?> event)

Description copied from interface: Component

Sets the hover event of this component.

Specified by:

hoverEvent in interface Component

Specified by:

hoverEvent in interface StyleSetter<C extends Component>

Parameters:

event - the hover event source

Returns:

a component

insertion

@NotNull
default C insertion(@Nullable
                    @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

Specified by:

insertion in interface StyleSetter<C extends Component>

Parameters:

insertion - the insertion string

Returns:

a component