Package io.jmix.flowui.kit.component.grid

Class GridActionsSupport<C extends com.vaadin.flow.component.grid.Grid<T>,T>

java.lang.Object

io.jmix.flowui.kit.component.delegate.AbstractActionsHolderSupport<C>

io.jmix.flowui.kit.component.grid.GridActionsSupport<C,T>

Type Parameters:

C - the type of grid component

T - the type of items within the grid

Direct Known Subclasses:

DataGridActionsSupport

public class GridActionsSupport<C extends com.vaadin.flow.component.grid.Grid<T>,T>
extends AbstractActionsHolderSupport<C>

A support class for managing actions in grids, providing functionality for binding actions to grid components and displaying them in a context menu.

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<Action,GridMenuItemActionWrapper<T>>	actionBinding
protected JmixGridContextMenu<T>	contextMenu
protected boolean	showActionsInContextMenuEnabled

Fields inherited from class io.jmix.flowui.kit.component.delegate.AbstractActionsHolderSupport

actions, actionShortcutBinding, component

Constructor Summary

Constructors

Constructor	Description
GridActionsSupport(C component)

Method Summary

Modifier and Type	Method	Description
protected void	addActionInternal(Action action, int index)
protected void	addContextMenuItem(Action action)
protected GridMenuItemActionWrapper<T>	createContextMenuItemComponent()
protected JmixGridContextMenu<T>	getContextMenu()
protected void	initContextMenu()
boolean	isShowActionsInContextMenuEnabled()
protected boolean	removeActionInternal(Action action)
protected void	removeContextMenuItem(Action action)
void	setShowActionsInContextMenuEnabled(boolean showActionsInContextMenuEnabled)	Enables or disables the display of actions in the grid's context menu.
protected void	updateContextMenu()

Methods inherited from class io.jmix.flowui.kit.component.delegate.AbstractActionsHolderSupport

addAction, addAction, addShortcutListenerIfNeeded, attachAction, detachAction, getAction, getActions, getActionShortcutBinding, getShortcutLifecycleOwner, removeAction, removeShortcutListener

Methods inherited from class java.lang.Object

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

Field Details

actionBinding

protected Map<Action,GridMenuItemActionWrapper<T>> actionBinding

contextMenu

protected JmixGridContextMenu<T> contextMenu

showActionsInContextMenuEnabled

protected boolean showActionsInContextMenuEnabled

Constructor Details

GridActionsSupport

public GridActionsSupport(C component)

Method Details

addActionInternal

protected void addActionInternal(Action action,
 int index)

Overrides:

addActionInternal in class AbstractActionsHolderSupport<C extends com.vaadin.flow.component.grid.Grid<T>>

addContextMenuItem

protected void addContextMenuItem(Action action)

createContextMenuItemComponent

protected GridMenuItemActionWrapper<T> createContextMenuItemComponent()

getContextMenu

protected JmixGridContextMenu<T> getContextMenu()

initContextMenu

protected void initContextMenu()

updateContextMenu

protected void updateContextMenu()

removeActionInternal

protected boolean removeActionInternal(Action action)

Overrides:

removeActionInternal in class AbstractActionsHolderSupport<C extends com.vaadin.flow.component.grid.Grid<T>>

removeContextMenuItem

protected void removeContextMenuItem(Action action)

isShowActionsInContextMenuEnabled

public boolean isShowActionsInContextMenuEnabled()

Returns:

true if actions are shown in the grid context menu, false otherwise

setShowActionsInContextMenuEnabled

public void setShowActionsInContextMenuEnabled(boolean showActionsInContextMenuEnabled)

Enables or disables the display of actions in the grid's context menu.

Parameters:

showActionsInContextMenuEnabled - a boolean flag indicating whether actions should be displayed in the context menu. If true, actions will be shown; if false, they will be hidden