com.haulmont.cuba.gui.components

Interface Component.ActionsHolder

All Superinterfaces:

Component

All Known Subinterfaces:

Component.SecuredActionsHolder, DataGrid<E>, DetachableFrame, Frame, GroupTable<E>, ListComponent<E>, ListEditorWindowController, LookupPickerField, PickerField, PopupButton, SearchPickerField, SuggestionPickerField, Table<E>, Tree<E>, TreeTable<E>, WidgetsTree<E>, Window, Window.Committable, Window.Editor, Window.Lookup, Window.MainWindow, Window.TopLevelWindow

All Known Implementing Classes:

AboutWindow, AbstractEditor, AbstractFrame, AbstractLookup, AbstractMainWindow, AbstractTopLevelWindow, AbstractWindow, AddConditionWindow, AdditionLoggerWindow, AppLoginWindow, AppMainWindow, AppPropertiesBrowse, AppPropertiesEdit, AppPropertiesExport, AttributeEditor, AttributeEditWindow, AttributePermissionsFrame, BackgroundWorkProgressWindow, BackgroundWorkWindow, BulkEditorWindow, CategoryAttrsFrame, CategoryBrowser, CategoryEditor, ChangePasswordDialog, CommonLookupController, ConditionFrame, ConstraintEditor, ConstraintLocalizationEdit, ControlLoggerWindow, CopySettings, CreditsFrame, CustomConditionEditor, CustomConditionFrame, DateIntervalEditor, DesktopAbstractActionsHolderComponent, DesktopAbstractTable, DesktopFrame, DesktopGroupTable, DesktopLookupPickerField, DesktopPickerField, DesktopPopupButton, DesktopRelatedEntities, DesktopSearchPickerField, DesktopSuggestionPickerField, DesktopTable, DesktopTree, DesktopTreeTable, DesktopWidgetsTree, DesktopWindow, DesktopWindow.Editor, DesktopWindow.Lookup, DynamicAttributesConditionEditor, DynamicAttributesConditionFrame, EntityCombinedScreen, EntityDiffViewer, EntityInspectorBrowse, EntityInspectorEditor, EntityLogBrowser, EntityOpenHistoryFrame, EntityPermissionsFrame, EntityRestore, FileBrowser, FileEditor, FileFrameController, FileUploadDialog, FilterEditor, FilterSelectWindow, FtsConditionFrame, GroupBrowser, GroupConditionFrame, GroupEditor, GroupLookup, JmxInstanceBrowser, JmxInstanceEditor, LayoutAnalyzerWindow, LicenseFrame, LicenseWindow, ListEditorPopupWindow, LocalizedEnumerationWindow, LocalizedNameFrame, LockBrowser, LockEditor, LogDownloadOptionsWindow, MbeanInspectWindow, MbeansDisplayWindow, MultiUploader, NewPasswordsList, OperationResultWindow, PropertyConditionFrame, ResetPasswordsDialog, RoleBrowser, RoleEditor, RuntimePropertiesFrame, SaveFilterWindow, SaveSetWindow, ScheduledExecutionBrowser, ScheduledTaskBrowser, ScheduledTaskEditor, ScreenHistoryBrowse, ScreenPermissionsFrame, ScreenProfilerWindow, SendingMessageAttachments, SendingMessageBrowser, ServerLogWindow, SessionAttributeEditor, SessionBrowser, SessionLogBrowser, SessionMessageWindow, SettingsWindow, SpecificPermissionsFrame, StatisticsWindow, SystemInfoWindow, ThreadsMonitoringWindow, UiPermissionsFrame, UserBrowser, UserEditor, UserLookup, UserSubstitutionEditor, WebAbstractActionsHolderComponent, WebAbstractList, WebAbstractTable, WebAbstractTree, WebDataGrid, WebFrame, WebGroupTable, WebLookupPickerField, WebPickerField, WebPopupButton, WebRelatedEntities, WebSearchPickerField, WebSuggestionPickerField, WebTable, WebTree, WebTreeTable, WebWidgetsTree, WebWindow, WebWindow.Editor, WebWindow.Lookup

Enclosing interface:

Component

public static interface Component.ActionsHolder
extends Component

A component containing Actions

Nested Class Summary

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.Component

Component.ActionOwner, Component.ActionsHolder, Component.Alignment, Component.BelongToFrame, Component.Buffered, Component.ChildEditableController, Component.Collapsable, Component.Container, Component.Disposable, Component.Editable, Component.EditableChangeEvent, Component.EditableChangeListener, Component.EditableChangeNotifier, Component.ExpandedStateChangeEvent, Component.ExpandedStateChangeListener, Component.Focusable, Component.HasBorder, Component.HasButtonsPanel, Component.HasCaption, Component.HasFormatter, Component.HasIcon, Component.HasInputPrompt, Component.HasNamedComponents, Component.HasPresentations, Component.HasRowsCount, Component.HasSettings, Component.HasValue, Component.HasXmlDescriptor, Component.LayoutClickEvent, Component.LayoutClickListener, Component.LayoutClickNotifier, Component.Margin, Component.MouseEventDetails, Component.OrderedContainer, Component.OuterMargin, Component.SecuredActionsHolder, Component.ShortcutAction, Component.ShortcutNotifier, Component.ShortcutTriggeredEvent, Component.Spacing, Component.UiPermissionAware, Component.Validatable, Component.ValueChangeEvent, Component.ValueChangeListener, Component.Wrapper

Field Summary

Fields inherited from interface com.haulmont.cuba.gui.components.Component

AUTO_SIZE, AUTO_SIZE_PX, UNITS_PERCENTAGE, UNITS_PIXELS

Method Summary

Modifier and Type	Method and 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(java.lang.String id)
default Action	getActionNN(java.lang.String id)
java.util.Collection<Action>	getActions()
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

Methods inherited from interface com.haulmont.cuba.gui.components.Component

addStyleName, getAlignment, getDebugId, getHeight, getHeightUnits, getId, getParent, getStyleName, getWidth, getWidthUnits, isEnabled, isEnabledItself, isResponsive, isVisible, isVisibleItself, removeStyleName, requestFocus, setAlignment, setDebugId, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, setStyleName, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition

Method Detail

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(@Nullable
                  Action action)

Remove the action from the component

removeAction

void removeAction(@Nullable
                  java.lang.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

java.util.Collection<Action> getActions()

Returns:

unmodifiable collection of actions

getAction

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

Returns:

an action by its ID, or null if not found

getActionNN

@Nonnull
default Action getActionNN(java.lang.String id)

Returns:

an action by its ID

Throws:

java.lang.IllegalArgumentException - if not found