Interface VirtualComponent

All Superinterfaces:

Component, ComponentBuilderApplicable, ComponentLike, HoverEventSource<Component>, ScopedComponent<TextComponent>, StyleGetter, StyleSetter<Component>, TextComponent

public sealed interface VirtualComponent
extends TextComponent

A virtual component.

This component type is transient and not guaranteed to survive during any sort of transformations or serialization.

Since:

4.18.0

See Also:

• Component.virtual(Class, VirtualComponentRenderer)

Nested Class Summary

Nested classes/interfaces inherited from interface TextComponent

TextComponent.Builder

Field Summary

Fields inherited from interface Component

EQUALS, EQUALS_IDENTITY, IS_NOT_EMPTY

Method Summary

Modifier and Type	Method	Description
Class<?>	contextType()	Gets the renderer context type.
VirtualComponentRenderer<?>	renderer()	Gets the renderer.

Methods inherited from interface 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 HoverEventSource

asHoverEvent

Methods inherited from interface 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 StyleSetter

decorate, decorations

Methods inherited from interface TextComponent

content, content, toBuilder

Method Details

contextType

Class<?> contextType()

Gets the renderer context type.

Returns:

the renderer context type

Since:

4.18.0

renderer

VirtualComponentRenderer<?> renderer()

Gets the renderer.

Returns:

the renderer

Since:

4.18.0