Package io.jmix.reportsflowui.action
Class RunListEntityReportAction<E>
java.lang.Object
io.jmix.flowui.kit.action.AbstractAction
io.jmix.flowui.kit.action.BaseAction
io.jmix.flowui.action.SecuredBaseAction
io.jmix.flowui.action.list.ListDataComponentAction<RunListEntityReportAction<E>,E>
io.jmix.reportsflowui.action.RunListEntityReportAction<E>
- All Implemented Interfaces:
AdjustWhenViewReadOnly
,ExecutableAction
,SecuredAction
,TargetAction<ListDataComponent<E>>
,Action
,HasShortcutCombination
@ActionType("report_runListEntityReport")
public class RunListEntityReportAction<E>
extends ListDataComponentAction<RunListEntityReportAction<E>,E>
implements AdjustWhenViewReadOnly
Standard action for printing reports for a list of entity instances associated with a list component.
Should be defined for a list component (Table
, DataGrid
, etc.) in a screen XML descriptor.
The action only selects reports having an external parameter of the Entity
or the List of entities type
and where the parameter entity type matches the entity type displayed by the list component.
If only one report is available as a result of selection, it is invoked immediately.
If several reports are available, their list is offered to the user for selection.
-
Nested Class Summary
Nested classes/interfaces inherited from class io.jmix.flowui.action.SecuredBaseAction
SecuredBaseAction.EnabledRule
-
Field Summary
Modifier and TypeFieldDescriptionprotected Dialogs
static final String
protected Messages
protected Metadata
protected Notifications
protected ReportActionSupport
protected String
Fields inherited from class io.jmix.flowui.action.list.ListDataComponentAction
selectionListenerRegistration, target
Fields inherited from class io.jmix.flowui.action.SecuredBaseAction
enabledByUiPermissions, enabledRules, visibleByUiPermissions
Fields inherited from class io.jmix.flowui.kit.action.BaseAction
enabledExplicitly, visibleExplicitly
Fields inherited from class io.jmix.flowui.kit.action.AbstractAction
description, enabled, eventBus, icon, id, shortcutCombination, text, variant, visible
Fields inherited from interface io.jmix.flowui.kit.action.Action
PROP_DESCRIPTION, PROP_ENABLED, PROP_ICON, PROP_SHORTCUT_COMBINATION, PROP_TEXT, PROP_VARIANT, PROP_VISIBLE
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
execute()
Executes theAction
protected void
protected boolean
protected void
printAll()
protected void
printSelected
(Set<?> selected) void
setDialogs
(Dialogs dialogs) void
setMessages
(Messages messages) void
setMetadata
(Metadata metadata) void
setNotifications
(Notifications notifications) void
setPrintReport
(ReportActionSupport reportActionSupport) void
setReportOutputName
(String reportOutputName) Methods inherited from class io.jmix.flowui.action.list.ListDataComponentAction
actionPerform, attachSelectionListener, checkTarget, checkTargetItems, getTarget, onSelectionChange, setTarget, withEnabled, withEnabledByUiPermissions, withHandler, withIcon, withIcon, withShortcutCombination, withTarget, withText, withTitle, withVariant, withVisible, withVisibleByUiPermissions
Methods inherited from class io.jmix.flowui.action.SecuredBaseAction
addEnabledRule, isEnabledByRule, isEnabledByUiPermissions, isPermitted, isVisibleByUiPermissions, refreshState, removeEnabledRule, setEnabledByUiPermissions, setVisibleByUiPermissions
Methods inherited from class io.jmix.flowui.kit.action.BaseAction
addActionPerformedListener, isApplicable, setEnabled, setEnabledInternal, setVisible, setVisibleInternal
Methods inherited from class io.jmix.flowui.kit.action.AbstractAction
addPropertyChangeListener, firePropertyChange, getDescription, getEventBus, getIcon, getId, getShortcutCombination, getText, getVariant, hasListener, isEnabled, isVisible, setDescription, setIcon, setShortcutCombination, setText, setVariant
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.action.Action
addPropertyChangeListener, getDescription, getIcon, getId, getText, getVariant, isEnabled, isVisible, refreshState, setDescription, setEnabled, setIcon, setText, setVariant, setVisible
Methods inherited from interface io.jmix.flowui.action.AdjustWhenViewReadOnly
isDisabledWhenViewReadOnly
Methods inherited from interface io.jmix.flowui.kit.component.HasShortcutCombination
getShortcutCombination, setShortcutCombination
-
Field Details
-
ID
- See Also:
-
dialogs
-
messages
-
metadata
-
notifications
-
reportActionSupport
-
reportOutputName
-
-
Constructor Details
-
RunListEntityReportAction
public RunListEntityReportAction() -
RunListEntityReportAction
-
-
Method Details
-
setMessages
-
setDialogs
-
setNotifications
-
setPrintReport
-
setMetadata
-
setReportOutputName
-
initAction
protected void initAction()- Overrides:
initAction
in classListDataComponentAction<RunListEntityReportAction<E>,
E>
-
isDataAvailable
protected boolean isDataAvailable() -
printSelected
-
printAll
protected void printAll() -
execute
public void execute()Description copied from interface:ExecutableAction
Executes theAction
- Specified by:
execute
in interfaceExecutableAction
-