Package net.kyori.adventure.text
Interface TextComponent
- All Superinterfaces:
Buildable<TextComponent,TextComponent.Builder>
,BuildableComponent<TextComponent,TextComponent.Builder>
,Component
,ComponentBuilderApplicable
,ComponentLike
,net.kyori.examination.Examinable
,HoverEventSource<Component>
,ScopedComponent<TextComponent>
public interface TextComponent extends BuildableComponent<TextComponent,TextComponent.Builder>, ScopedComponent<TextComponent>
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
-
Method Summary
Modifier and Type Method Description @NotNull String
content()
Gets the plain text content.@NotNull TextComponent
content(@NotNull String content)
Sets the plain text content.static @NotNull TextComponent
ofChildren(@NotNull ComponentLike @NotNull ... components)
Creates a component withcomponents
as the children.Methods inherited from interface net.kyori.adventure.text.BuildableComponent
toBuilder
Methods inherited from interface net.kyori.adventure.text.Component
asComponent, asHoverEvent, children, clickEvent, color, componentBuilderApply, contains, contains, decoration, decorations, decorations, detectCycle, hasDecoration, hasStyling, hoverEvent, insertion, replaceFirstText, replaceFirstText, replaceText, replaceText, replaceText, replaceText, replaceText, replaceText, replaceText, replaceText, style, style
Methods inherited from interface net.kyori.examination.Examinable
examinableName, examinableProperties, examine
Methods inherited from interface net.kyori.adventure.text.event.HoverEventSource
asHoverEvent
Methods inherited from interface net.kyori.adventure.text.ScopedComponent
append, append, append, children, clickEvent, color, colorIfAbsent, decorate, decoration, decoration, hoverEvent, insertion, mergeStyle, mergeStyle, mergeStyle, style, style, style
-
Method Details
-
ofChildren
@NotNull static @NotNull TextComponent ofChildren(@NotNull @NotNull ComponentLike @NotNull ... components)Creates a component withcomponents
as the children.- Parameters:
components
- the children- Returns:
- a text component
- Since:
- 4.0.0
-
content
Gets the plain text content.- Returns:
- the plain text content
- Since:
- 4.0.0
-
content
Sets the plain text content.- Parameters:
content
- the plain text content- Returns:
- a copy of this component
- Since:
- 4.0.0
-