Package io.jmix.aichat.action

Class AiChatAction<A extends AiChatAction<A,E,C>,E extends AiChatMessage,C extends AiChat<E>>

java.lang.Object

io.jmix.flowui.kit.action.AbstractAction

io.jmix.flowui.kit.action.BaseAction<A>

io.jmix.flowui.action.ObservableBaseAction<A>

io.jmix.flowui.action.SecuredBaseAction<A>

io.jmix.aichat.action.AiChatAction<A,E,C>

Type Parameters:

A - the concrete action type (self-type, for fluent setters)

E - the chat's message type

C - the AiChat type this action targets

All Implemented Interfaces:

ExecutableAction, TargetAction<C>, Action, HasShortcutCombination

public abstract class AiChatAction<A extends AiChatAction<A,E,C>,E extends AiChatMessage,C extends AiChat<E>>
extends SecuredBaseAction<A>
implements TargetAction<C>, ExecutableAction

An abstract base class for actions that can be associated with an AiChat.

The action reaches its chat through getTarget(); the target is wired by the chat's actions support when the action is added, and cleared when it is removed. Business logic goes in ExecutableAction.execute(); a custom ActionPerformedEvent listener overrides it.

Nested Class Summary

Nested classes/interfaces inherited from class io.jmix.flowui.action.SecuredBaseAction

SecuredBaseAction.EnabledRule

Field Summary

Fields

Modifier and Type	Field	Description
protected @Nullable C	target

Fields inherited from class io.jmix.flowui.action.SecuredBaseAction

enabledRules

Fields inherited from class io.jmix.flowui.action.ObservableBaseAction

uiObservationSupport

Fields inherited from class io.jmix.flowui.kit.action.BaseAction

enabledExplicitly, visibleExplicitly

Fields inherited from class io.jmix.flowui.kit.action.AbstractAction

description, enabled, eventBus, icon, id, shortcutCombination, text, variant, visible

Fields inherited from interface io.jmix.flowui.kit.action.Action

PROP_DESCRIPTION, PROP_ENABLED, PROP_ICON, PROP_SHORTCUT_COMBINATION, PROP_TEXT, PROP_VARIANT, PROP_VISIBLE

Constructor Summary

Constructors

Constructor	Description
AiChatAction(String id)	Creates the action with the given id.

Method Summary

Modifier and Type	Method	Description
void	actionPerform(com.vaadin.flow.component.Component component)	Executes action logic.
protected void	checkTarget()
@Nullable C	getTarget()
protected void	initAction()	Hook for subclasses to set defaults (icon, text, variant).
void	setTarget(@Nullable C target)
protected void	setTargetInternal(@Nullable C target)
A	withTarget(@Nullable C target)	Sets the chat this action operates on and returns this action, for fluent configuration.

Methods inherited from class io.jmix.flowui.action.SecuredBaseAction

addEnabledRule, isEnabledByRule, isPermitted, refreshState, removeEnabledRule

Methods inherited from class io.jmix.flowui.action.ObservableBaseAction

getUiObservationSupport

Methods inherited from class io.jmix.flowui.kit.action.BaseAction

addActionPerformedListener, isApplicable, self, setEnabled, setEnabledInternal, setVisible, setVisibleInternal, withDescription, withEnabled, withHandler, withIcon, withShortcutCombination, withText, withVariant, withVisible

Methods inherited from class io.jmix.flowui.kit.action.AbstractAction

addPropertyChangeListener, firePropertyChange, getDescription, getEventBus, getIcon, getIconComponent, getId, getShortcutCombination, getText, getVariant, hasListener, isEnabled, isVisible, setDescription, setIcon, setIconComponent, setShortcutCombination, setText, setVariant

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.jmix.flowui.kit.action.Action

addPropertyChangeListener, getDescription, getIcon, getIconComponent, getId, getText, getVariant, isEnabled, isVisible, refreshState, setDescription, setEnabled, setIcon, setIconComponent, setText, setVariant, setVisible

Methods inherited from interface io.jmix.flowui.action.ExecutableAction

execute

Methods inherited from interface io.jmix.flowui.kit.component.HasShortcutCombination

getShortcutCombination, setShortcutCombination

Field Details

target

protected @Nullable C extends AiChat<E> target

Constructor Details

AiChatAction

public AiChatAction(String id)

Creates the action with the given id.

Parameters:

id - the action id

Method Details

initAction

protected void initAction()

Hook for subclasses to set defaults (icon, text, variant). Empty by default.

getTarget

public @Nullable C getTarget()

Specified by:

getTarget in interface TargetAction<A extends AiChatAction<A,E,C>>

setTarget

public void setTarget(@Nullable C target)

Specified by:

setTarget in interface TargetAction<A extends AiChatAction<A,E,C>>

setTargetInternal

protected void setTargetInternal(@Nullable C target)

actionPerform

public void actionPerform(com.vaadin.flow.component.Component component)

Description copied from interface: Action

Executes action logic.

Specified by:

actionPerform in interface Action

Overrides:

actionPerform in class ObservableBaseAction<A extends AiChatAction<A,E,C>>

Parameters:

component - Component that triggered this action

withTarget

public A withTarget(@Nullable C target)

Sets the chat this action operates on and returns this action, for fluent configuration.

Parameters:

target - the chat to target, or null to clear

Returns:

this action

checkTarget

protected void checkTarget()