Package io.jmix.aichat.action

Class AiMessageRegenerateAction

java.lang.Object

io.jmix.flowui.kit.action.AbstractAction

io.jmix.aichat.action.AiMessageAction<AiMessageRegenerateAction>

io.jmix.aichat.action.AiMessageRegenerateAction

All Implemented Interfaces:

TargetAction<AiChat<?>>, Action, HasShortcutCombination

@ActionType("aichat_messageRegenerate")
public class AiMessageRegenerateAction
extends AiMessageAction<AiMessageRegenerateAction>
implements TargetAction<AiChat<?>>

Built-in action that rewinds the conversation to the prompt the clicked message belongs to and streams a fresh answer. Everything after that prompt — the message itself and every message following it — is removed from the chat's source first, so the answer replaces the tail rather than being appended to it.

The prompt is the nearest AiMessageRole.USER message at or before the clicked one, which is why the same action serves both roles: under an assistant message it re-asks the question that message answers, under a user message it re-asks that message.

Rewinding needs the message source, which only AiChat has, so the action is a TargetAction: the chat wires itself as the target when the action is assigned to one of its roles. Assigned to a standalone AiMessageList it has no target and execute(io.jmix.aichat.action.AiMessageActionPerformedEvent) throws.

Like AiMessageCopyAction it carries no icon component — the glyph comes from CSS through the jmix-ai-message-action-regenerate class and the --jmix-ai-message-icon-regenerate mask — and its description is localized from the message bundle through an injected Messages, so an instance built with new rather than through the registry carries none.

See Also:

• AiChat.regenerate(AiMessageListItem)

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ID	The action type id, for <action type="aichat_messageRegenerate"/> in a descriptor.
static final String	REGENERATE_CLASS_NAME	The class name applied to the rendered button, so the action can be styled per theme.
protected @Nullable AiChat<?>	target

Fields inherited from class io.jmix.aichat.action.AiMessageAction

classNames

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
AiMessageRegenerateAction()	Creates the action with the default id ID.
AiMessageRegenerateAction(String id)	Creates the action with the given id.

Method Summary

Modifier and Type	Method	Description
protected void	execute(AiMessageActionPerformedEvent event)	Business logic of the action.
@Nullable AiChat<?>	getTarget()
protected void	initAction()	Hook for subclasses to set defaults (icon, description, class names).
protected void	setMessages(Messages messages)
void	setTarget(@Nullable AiChat<?> target)

Methods inherited from class io.jmix.aichat.action.AiMessageAction

actionPerform, actionPerform, addActionPerformedListener, addClassNames, getClassNames, refreshState, self, setEnabled, setShortcutCombination, setText, setVariant, setVisible, unsupported, withClassNames, withDescription, withHandler, withIcon

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

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

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

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

getShortcutCombination, setShortcutCombination

Field Details

ID

public static final String ID

The action type id, for <action type="aichat_messageRegenerate"/> in a descriptor.

See Also:

• Constant Field Values

REGENERATE_CLASS_NAME

public static final String REGENERATE_CLASS_NAME

The class name applied to the rendered button, so the action can be styled per theme.

See Also:

• Constant Field Values

target

protected @Nullable AiChat<?> target

Constructor Details

AiMessageRegenerateAction

public AiMessageRegenerateAction()

Creates the action with the default id ID.

AiMessageRegenerateAction

public AiMessageRegenerateAction(String id)

Creates the action with the given id.

Parameters:

id - the action id

Method Details

initAction

protected void initAction()

Description copied from class: AiMessageAction

Hook for subclasses to set defaults (icon, description, class names). Empty by default.

Called from the constructor, so it runs before the subclass's own field initializers: set state through the inherited setters, not through subclass fields.

Overrides:

initAction in class AiMessageAction<AiMessageRegenerateAction>

getTarget

public @Nullable AiChat<?> getTarget()

Specified by:

getTarget in interface TargetAction<AiChat<?>>

setTarget

public void setTarget(@Nullable AiChat<?> target)

Specified by:

setTarget in interface TargetAction<AiChat<?>>

execute

protected void execute(AiMessageActionPerformedEvent event)

Description copied from class: AiMessageAction

Business logic of the action. Empty by default.

Overrides:

execute in class AiMessageAction<AiMessageRegenerateAction>

Parameters:

event - the performed event, carrying the rendered item, the domain message it was rendered from, and the host list

setMessages

@Autowired
protected void setMessages(Messages messages)