Package io.jmix.aichat.component.chat

Enum Class AiChatVariant

java.lang.Object

java.lang.Enum<AiChatVariant>

io.jmix.aichat.component.chat.AiChatVariant

All Implemented Interfaces:

com.vaadin.flow.component.shared.ThemeVariant, Serializable, Comparable<AiChatVariant>, Constable

public enum AiChatVariant
extends Enum<AiChatVariant>
implements com.vaadin.flow.component.shared.ThemeVariant

Set of theme variants applicable for the AiChat component. Setting a variant on the chat projects it onto the inner message list and message input (see AiChat.getThemeNames()), so a single knob styles the composite.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FIXED_TOOLBAR	Forces the message input's expanded "toolbar" layout at all times, the chat-level counterpart of AiMessageInputVariant#FIXED_TOOLBAR: the textarea spans the top and the prefix/suffix/send controls sit in a row beneath it, even for short input.
INPUT_FOOTER_COMPONENT_ALWAYS_VISIBLE	Opts the input's footer band out of the default hidden-while-empty behavior, so it stays shown even while the chat is empty.
INPUT_HEADER_COMPONENT_ALWAYS_VISIBLE	Opts the input's header band out of the default hidden-while-empty behavior, so it stays shown even while the chat is empty.
NO_HEADER_FOOTER_GAP	Removes the composer's own gap between the input box and its header / footer bands, the chat-level counterpart of AiMessageInputVariant#NO_HEADER_FOOTER_GAP: content declared via inputHeader / inputFooter sits directly against the box.

Method Summary

Modifier and Type	Method	Description
String	getVariantName()	Gets the variant name.
static AiChatVariant	valueOf(String name)	Returns the enum constant of this class with the specified name.
static AiChatVariant[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

FIXED_TOOLBAR

public static final AiChatVariant FIXED_TOOLBAR

Forces the message input's expanded "toolbar" layout at all times, the chat-level counterpart of AiMessageInputVariant#FIXED_TOOLBAR: the textarea spans the top and the prefix/suffix/send controls sit in a row beneath it, even for short input.

NO_HEADER_FOOTER_GAP

public static final AiChatVariant NO_HEADER_FOOTER_GAP

Removes the composer's own gap between the input box and its header / footer bands, the chat-level counterpart of AiMessageInputVariant#NO_HEADER_FOOTER_GAP: content declared via inputHeader / inputFooter sits directly against the box. The gaps inside the box stay as they are.

INPUT_HEADER_COMPONENT_ALWAYS_VISIBLE

public static final AiChatVariant INPUT_HEADER_COMPONENT_ALWAYS_VISIBLE

Opts the input's header band out of the default hidden-while-empty behavior, so it stays shown even while the chat is empty. Does not otherwise force visibility — application CSS or setVisible(false) can still hide the band.

INPUT_FOOTER_COMPONENT_ALWAYS_VISIBLE

public static final AiChatVariant INPUT_FOOTER_COMPONENT_ALWAYS_VISIBLE

Opts the input's footer band out of the default hidden-while-empty behavior, so it stays shown even while the chat is empty. Does not otherwise force visibility — application CSS or setVisible(false) can still hide the band.

Method Details

values

public static AiChatVariant[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static AiChatVariant valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getVariantName

public String getVariantName()

Gets the variant name.

Specified by:

getVariantName in interface com.vaadin.flow.component.shared.ThemeVariant

Returns:

variant name