Module net.kyori.adventure.api

Package net.kyori.adventure.text

Interface TextComponent

All Superinterfaces:

Buildable<TextComponent.Builder>, BuildableComponent<TextComponent,TextComponent.Builder>, Component, ComponentBuilderApplicable, ComponentLike, HoverEventSource<Component>, ScopedComponent<TextComponent>, StyleGetter, StyleSetter<Component>

All Known Subinterfaces:

VirtualComponent

public sealed interface TextComponent
extends ScopedComponent<TextComponent>, BuildableComponent<TextComponent,TextComponent.Builder>
permits VirtualComponent (not exhaustive)

A component that displays a string.

This component consists of:

content

string to be displayed

Since:

4.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	TextComponent.Builder	A text component builder.

Field Summary

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

EQUALS, EQUALS_IDENTITY, IS_NOT_EMPTY

Method Summary

Modifier and Type	Method	Description
String	content()	Gets the plain text content.
TextComponent	content(String content)	Sets the plain text content.
TextComponent.Builder	toBuilder()	Returns a builder for this component.

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

asHoverEvent, children, clickEvent, color, compact, compact, componentBuilderApply, contains, contains, decoration, decorations, font, hasDecoration, hasStyling, hoverEvent, insertion, iterable, iterable, iterator, iterator, replaceText, replaceText, shadowColor, spliterator, spliterator, style

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

asHoverEvent

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

append, append, append, append, append, appendNewline, appendSpace, applyFallbackStyle, applyFallbackStyle, asComponent, children, clickEvent, color, colorIfAbsent, decorate, decoration, decoration, decorationIfAbsent, decorations, font, hoverEvent, insertion, mergeStyle, mergeStyle, mergeStyle, shadowColor, shadowColorIfAbsent, style, style, style, style

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

decorate, decorations

Method Details

content

String content()

Gets the plain text content.

Returns:

the plain text content

Since:

4.0.0

content

@Contract(pure=true)
TextComponent content(String content)

Sets the plain text content.

Parameters:

content - the plain text content

Returns:

a copy of this component

Since:

4.0.0

toBuilder

TextComponent.Builder toBuilder()

Description copied from interface: Component

Returns a builder for this component.

Specified by:

toBuilder in interface Buildable<TextComponent.Builder>

Specified by:

toBuilder in interface BuildableComponent<TextComponent,TextComponent.Builder>

Specified by:

toBuilder in interface Component

Specified by:

toBuilder in interface ScopedComponent<TextComponent>

Returns:

the builder