Package io.jmix.ui.component

Interface ActionsHolder

All Superinterfaces:

Component, HasSubParts

All Known Subinterfaces:

DataGrid<E>, DialogWindow, EntityComboBox<V>, EntityPicker<V>, EntitySuggestionField<V>, Filter, Fragment, FragmentImplementation, Frame, GroupTable<E>, ListComponent<E>, PopupButton, RootWindow, SecuredActionsHolder, Table<E>, TabWindow, TagPicker<V>, Tree<E>, TreeDataGrid<E>, TreeTable<E>, ValuePicker<V>, ValuesPicker<V>, Window, WindowImplementation

All Known Implementing Classes:

AbstractActionsHolderComponent, AbstractDataGrid, AbstractTable, DataGridImpl, DialogWindowImpl, EntityComboBoxImpl, EntityPickerImpl, EntitySuggestionFieldImpl, FilterImpl, FragmentImpl, GroupTableImpl, PopupButtonImpl, RelatedEntitiesImpl, RootWindowImpl, SearchFieldImpl, TableImpl, TabWindowImpl, TagPickerImpl, TreeDataGridImpl, TreeImpl, TreeTableImpl, ValuePickerImpl, ValuesPickerImpl, WindowImpl

public interface ActionsHolder
extends Component, HasSubParts

A component containing Actions.

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

Field Summary

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

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

Method Summary

Modifier and Type	Method	Description
void	addAction(Action action)	Add an action to the component
void	addAction(Action action, int index)	Add an action to the component with index.
Action	getAction(String id)
default Action	getActionNN(String id)
Collection<Action>	getActions()
default Object	getSubPart(String name)
void	removeAction(Action action)	Remove the action from the component
void	removeAction(String id)	Remove the action by its ID.
void	removeAllActions()	Remove all actions from the component

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

Method Details

addAction

void addAction(Action action)

Add an action to the component

addAction

void addAction(Action action,
 int index)

Add an action to the component with index.

removeAction

void removeAction(Action action)

Remove the action from the component

removeAction

void removeAction(String id)

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

removeAllActions

void removeAllActions()

Remove all actions from the component

getActions

Collection<Action> getActions()

Returns:

unmodifiable collection of actions

getAction

@Nullable
Action getAction(String id)

Returns:

an action by its ID, or null if not found

getActionNN

default Action getActionNN(String id)

Returns:

an action by its ID

Throws:

IllegalArgumentException - if not found

getSubPart

@Nullable
default Object getSubPart(String name)

Specified by:

getSubPart in interface HasSubParts