Package io.jmix.reportsflowui.action

Class RunReportAction<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<RunReportAction<E>,E>

io.jmix.reportsflowui.action.RunReportAction<E>

All Implemented Interfaces:

ExecutableAction, SecuredAction, TargetAction<ListDataComponent<E>>, Action, HasShortcutCombination

@ActionType("report_runReport")
public class RunReportAction<E>
extends ListDataComponentAction<RunReportAction<E>,E>

Standard action for running the reports associated with current screen or list component.

Should be defined in the screen that is associated with Report. Should be defined for a Button or a list component (Table, DataGrid, etc.).

Nested Class Summary

Nested classes/interfaces inherited from class io.jmix.flowui.action.SecuredBaseAction

SecuredBaseAction.EnabledRule

Field Summary

Fields

Modifier and Type	Field	Description
protected DataManager	dataManager
static final String	DEFAULT_LIST_OF_ENTITIES_ALIAS
static final String	DEFAULT_SINGLE_ENTITY_ALIAS
protected DialogWindows	dialogWindows
static final String	ID
protected ReportsClientProperties	reportsClientProperties
protected UiReportRunner	uiReportRunner

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

Constructors

Constructor	Description
RunReportAction()
RunReportAction(String id)

Method Summary

Modifier and Type	Method	Description
void	execute()	Executes the Action
protected void	initAction()
protected void	openLookup(View<?> parent)
protected void	openReportParamsDialog(Report report, View<?> view)
protected void	runReports(Collection<Report> reports, View<?> view)
void	setDataManager(DataManager dataManager)
void	setDialogWindows(DialogWindows dialogWindows)
void	setMessages(Messages messages)
void	setReportsClientProperties(ReportsClientProperties reportsClientProperties)
void	setUiReportRunner(UiReportRunner uiReportRunner)

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.kit.component.HasShortcutCombination

getShortcutCombination, setShortcutCombination

Field Details

ID

public static final String ID

See Also:

• Constant Field Values

DEFAULT_SINGLE_ENTITY_ALIAS

public static final String DEFAULT_SINGLE_ENTITY_ALIAS

See Also:

• Constant Field Values

DEFAULT_LIST_OF_ENTITIES_ALIAS

public static final String DEFAULT_LIST_OF_ENTITIES_ALIAS

See Also:

• Constant Field Values

dataManager

protected DataManager dataManager

dialogWindows

protected DialogWindows dialogWindows

uiReportRunner

protected UiReportRunner uiReportRunner

reportsClientProperties

protected ReportsClientProperties reportsClientProperties

Constructor Details

RunReportAction

public RunReportAction()

RunReportAction

public RunReportAction(String id)

Method Details

setMessages

@Autowired
public void setMessages(Messages messages)

setDialogWindows

@Autowired
public void setDialogWindows(DialogWindows dialogWindows)

setDataManager

@Autowired
public void setDataManager(DataManager dataManager)

setUiReportRunner

@Autowired
public void setUiReportRunner(UiReportRunner uiReportRunner)

setReportsClientProperties

@Autowired
public void setReportsClientProperties(ReportsClientProperties reportsClientProperties)

initAction

protected void initAction()

Overrides:

initAction in class ListDataComponentAction<RunReportAction<E>,E>

execute

public void execute()

Description copied from interface: ExecutableAction

Executes the Action

openLookup

protected void openLookup(View<?> parent)

runReports

protected void runReports(Collection<Report> reports,
 View<?> view)

openReportParamsDialog

protected void openReportParamsDialog(Report report,
 View<?> view)