io.jmix.ui.component.impl

Class AbstractActionsHolderComponent<T extends com.vaadin.ui.AbstractComponent & com.vaadin.event.Action.ShortcutNotifier>

java.lang.Object

io.jmix.ui.component.impl.AbstractComponent<T>

io.jmix.ui.component.impl.AbstractActionsHolderComponent<T>

All Implemented Interfaces:

ActionsHolder, AttachNotifier, Component, Component.BelongToFrame, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.Wrapper, HasContextHelp, HasDebugId, HasHtmlCaption, HasHtmlDescription, HasHtmlSanitizer, HasSubParts, SecuredActionsHolder

Direct Known Subclasses:

AbstractTable

public abstract class AbstractActionsHolderComponent<T extends com.vaadin.ui.AbstractComponent & com.vaadin.event.Action.ShortcutNotifier>
extends AbstractComponent<T>
implements SecuredActionsHolder

Base class for action holders with shortcuts support

Nested Class Summary

Nested classes/interfaces inherited from interface io.jmix.ui.component.Component

Component.Alignment, Component.BelongToFrame, Component.Disposable, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.Wrapper

Nested classes/interfaces inherited from interface io.jmix.ui.component.HasContextHelp

HasContextHelp.ContextHelpIconClickEvent

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<Action,JmixButton>	actionButtons
protected java.util.List<Action>	actionList
protected java.util.function.Consumer<java.beans.PropertyChangeEvent>	actionPropertyChangeListener
protected ActionsPermissions	actionsPermissions
protected com.vaadin.ui.VerticalLayout	contextMenuPopup
protected ShortcutsDelegate<com.vaadin.event.ShortcutListener>	shortcutsDelegate
protected boolean	showIconsForPopupMenuActions

Fields inherited from class io.jmix.ui.component.impl.AbstractComponent

alignment, applicationContext, component, contextHelpIconClickHandler, contextHelpIconClickListener, descriptionAsHtml, element, frame, htmlSanitizerEnabled, icon, ICON_STYLE, id, parent

Fields inherited from interface io.jmix.ui.component.Component

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractActionsHolderComponent()

Method Summary

Modifier and Type	Method and Description
protected void	actionPropertyChanged(java.beans.PropertyChangeEvent evt)
void	addAction(Action action) Add an action to the component
void	addAction(Action action, int index) Add an action to the component with index.
protected void	attachAction(Action action)
protected void	beforeContextMenuButtonHandlerPerformed()
protected abstract JmixButton	createContextMenuButton()
protected com.vaadin.ui.VerticalLayout	createContextMenuPopup()
protected ShortcutsDelegate<com.vaadin.event.ShortcutListener>	createShortcutsDelegate()
Action	getAction(java.lang.String id)
java.util.Collection<Action>	getActions()
ActionsPermissions	getActionsPermissions()
protected void	initContextMenuButton(JmixButton contextMenuButton, Action action)
protected void	initContextMenuPopup(com.vaadin.ui.VerticalLayout contextMenuPopup)
void	removeAction(Action action) Remove the action from the component
void	removeAction(java.lang.String id) Remove the action by its ID.
void	removeAllActions() Remove all actions from the component
protected void	setContextMenuButtonAction(JmixButton button, Action action)
protected void	setContextMenuButtonCaption(JmixButton button, java.lang.String caption, KeyCombination shortcutCombination)
protected void	setContextMenuButtonIcon(JmixButton button, java.lang.String icon)
void	setThemeConstantsManager(ThemeConstantsManager themeConstantsManager)

Methods inherited from class io.jmix.ui.component.impl.AbstractComponent

addAttachListener, addDetachListener, addStyleName, assignDebugId, attached, detached, getAlignment, getCaption, getComponent, getComposition, getContextHelpIconClickHandler, getContextHelpText, getDebugId, getDescription, getEventHub, getFrame, getHeight, getHeightSizeUnit, getHtmlSanitizer, getIcon, getIconName, getIconResource, getId, getParent, getStyleName, getUiComponentProperties, getUiProperties, getWidth, getWidthSizeUnit, getXmlDescriptor, hasSubscriptions, hasValidationError, isAttached, isCaptionAsHtml, isContextHelpTextHtmlEnabled, isDescriptionAsHtml, isEnabled, isEnabledRecursive, isHtmlSanitizerEnabled, isResponsive, isVisible, isVisibleRecursive, onContextHelpIconClick, publish, removeStyleName, sanitize, setAlignment, setApplicationContext, setCaption, setCaptionAsHtml, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled, setDebugId, setDescription, setDescriptionAsHtml, setEnabled, setFrame, setHeight, setHtmlSanitizerEnabled, setIcon, setIconFromSet, setId, setParent, setResponsive, setStyleName, setValidationError, setVisible, setWidth, setXmlDescriptor, unsubscribe, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedComposition

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.jmix.ui.component.ActionsHolder

getActionNN, getSubPart

Methods inherited from interface io.jmix.ui.component.Component

addStyleName, getAlignment, getHeight, getHeightSizeUnit, getId, getParent, getStyleName, getWidth, getWidthSizeUnit, isEnabled, isEnabledRecursive, isResponsive, isVisible, isVisibleRecursive, removeStyleName, setAlignment, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, setStyleName, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedComposition

Field Detail

actionList

protected java.util.List<Action> actionList

actionButtons

protected java.util.Map<Action,JmixButton> actionButtons

contextMenuPopup

protected com.vaadin.ui.VerticalLayout contextMenuPopup

shortcutsDelegate

protected ShortcutsDelegate<com.vaadin.event.ShortcutListener> shortcutsDelegate

actionsPermissions

protected ActionsPermissions actionsPermissions

showIconsForPopupMenuActions

protected boolean showIconsForPopupMenuActions

actionPropertyChangeListener

protected java.util.function.Consumer<java.beans.PropertyChangeEvent> actionPropertyChangeListener

Constructor Detail

AbstractActionsHolderComponent

protected AbstractActionsHolderComponent()

Method Detail

createContextMenuPopup

protected com.vaadin.ui.VerticalLayout createContextMenuPopup()

initContextMenuPopup

protected void initContextMenuPopup(com.vaadin.ui.VerticalLayout contextMenuPopup)

createShortcutsDelegate

protected ShortcutsDelegate<com.vaadin.event.ShortcutListener> createShortcutsDelegate()

actionPropertyChanged

protected void actionPropertyChanged(java.beans.PropertyChangeEvent evt)

setContextMenuButtonCaption

protected void setContextMenuButtonCaption(JmixButton button,
                                           @Nullable
                                           java.lang.String caption,
                                           @Nullable
                                           KeyCombination shortcutCombination)

setContextMenuButtonIcon

protected void setContextMenuButtonIcon(JmixButton button,
                                        @Nullable
                                        java.lang.String icon)

setContextMenuButtonAction

protected void setContextMenuButtonAction(JmixButton button,
                                          Action action)

beforeContextMenuButtonHandlerPerformed

protected void beforeContextMenuButtonHandlerPerformed()

setThemeConstantsManager

@Autowired
public void setThemeConstantsManager(ThemeConstantsManager themeConstantsManager)

addAction

public void addAction(Action action)

Description copied from interface: ActionsHolder

Add an action to the component

Specified by:

addAction in interface ActionsHolder

addAction

public void addAction(Action action,
                      int index)

Description copied from interface: ActionsHolder

Add an action to the component with index.

Specified by:

addAction in interface ActionsHolder

initContextMenuButton

protected void initContextMenuButton(JmixButton contextMenuButton,
                                     Action action)

attachAction

protected void attachAction(Action action)

createContextMenuButton

protected abstract JmixButton createContextMenuButton()

removeAction

public void removeAction(Action action)

Description copied from interface: ActionsHolder

Remove the action from the component

Specified by:

removeAction in interface ActionsHolder

removeAction

public void removeAction(java.lang.String id)

Description copied from interface: ActionsHolder

Remove the action by its ID. If there is no action with that ID, nothing happens.

Specified by:

removeAction in interface ActionsHolder

removeAllActions

public void removeAllActions()

Description copied from interface: ActionsHolder

Remove all actions from the component

Specified by:

removeAllActions in interface ActionsHolder

getActions

public java.util.Collection<Action> getActions()

Specified by:

getActions in interface ActionsHolder

Returns:

unmodifiable collection of actions

getAction

@Nullable
public Action getAction(java.lang.String id)

Specified by:

getAction in interface ActionsHolder

Returns:

an action by its ID, or null if not found

getActionsPermissions

public ActionsPermissions getActionsPermissions()

Specified by:

getActionsPermissions in interface SecuredActionsHolder

Returns:

permissions container