Package io.jmix.flowui.view.impl

Class ViewActionsImpl

java.lang.Object

io.jmix.flowui.view.impl.ViewActionsImpl

All Implemented Interfaces:

HasActions, ViewActions

@Component("flowui_ViewActions")
@Scope("prototype")
public class ViewActionsImpl
extends Object
implements ViewActions

Field Summary

Fields

Modifier and Type	Field	Description
protected ActionBinder<View<?>>	actionBinder
protected List<Action>	actions
protected Map<Action,com.vaadin.flow.component.ShortcutRegistration>	actionShortcutBinding
protected View<?>	view

Constructor Summary

Constructors

Constructor	Description
ViewActionsImpl(ActionBinder<View<?>> actionBinder)	Deprecated, for removal: This API element is subject to removal in a future version. Use ViewActionsImpl(View) instead
ViewActionsImpl(View<?> view)

Method Summary

Modifier and Type	Method	Description
void	addAction(Action action, int index)	Add an action to the component at the specified index.
protected void	addActionInternal(Action action, int index)
protected void	addShortcutListenerIfNeeded(Action action)
protected void	attachAction(Action action)
protected void	detachAction(Action action)
Action	getAction(String id)	Returns an action with passed id.
protected Optional<Action>	getActionInternal(String id)
Collection<Action>	getActions()
protected Map<Action,com.vaadin.flow.component.ShortcutRegistration>	getActionShortcutBinding()
protected View<?>	getView()
void	removeAction(Action action)	Removes the action from the component.
protected void	removeActionInternal(Action action)
protected void	removeShortcutListener(Action action)
protected <C extends com.vaadin.flow.component.Component> com.vaadin.flow.component.ShortcutRegistration	shortcutHandler(C viewLayout, com.vaadin.flow.component.ShortcutEventListener shortcutEventListener, KeyCombination keyCombination)

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.component.HasActions

addAction, removeAction, removeAllActions

Field Details

view

protected View<?> view

actions

protected List<Action> actions

actionShortcutBinding

protected Map<Action,com.vaadin.flow.component.ShortcutRegistration> actionShortcutBinding

actionBinder

protected ActionBinder<View<?>> actionBinder

Constructor Details

ViewActionsImpl

public ViewActionsImpl(View<?> view)

ViewActionsImpl

@Deprecated(since="2.2",
            forRemoval=true)
public ViewActionsImpl(ActionBinder<View<?>> actionBinder)

Deprecated, for removal: This API element is subject to removal in a future version.

Use ViewActionsImpl(View) instead

Method Details

addAction

public void addAction(Action action,
 int index)

Description copied from interface: HasActions

Add an action to the component at the specified index.

Specified by:

addAction in interface HasActions

Parameters:

action - action to add

index - index at which the specified action is to be added

addActionInternal

protected void addActionInternal(Action action,
 int index)

removeAction

public void removeAction(Action action)

Description copied from interface: HasActions

Removes the action from the component.

Specified by:

removeAction in interface HasActions

Parameters:

action - action to remove

removeActionInternal

protected void removeActionInternal(Action action)

getActions

public Collection<Action> getActions()

Specified by:

getActions in interface HasActions

Returns:

unmodifiable collection of actions

getAction

@Nullable
public Action getAction(String id)

Description copied from interface: HasActions

Returns an action with passed id.

Specified by:

getAction in interface HasActions

Parameters:

id - id of the action to find

Returns:

an action by its id, or null if not found

getActionInternal

protected Optional<Action> getActionInternal(String id)

shortcutHandler

protected <C extends com.vaadin.flow.component.Component>
com.vaadin.flow.component.ShortcutRegistration shortcutHandler(C viewLayout,
 com.vaadin.flow.component.ShortcutEventListener shortcutEventListener,
 KeyCombination keyCombination)

getView

protected View<?> getView()

attachAction

protected void attachAction(Action action)

addShortcutListenerIfNeeded

protected void addShortcutListenerIfNeeded(Action action)

removeShortcutListener

protected void removeShortcutListener(Action action)

detachAction

protected void detachAction(Action action)

getActionShortcutBinding

protected Map<Action,com.vaadin.flow.component.ShortcutRegistration> getActionShortcutBinding()