Package io.jmix.reportsui.action.list

Class RunReportAction

java.lang.Object

io.jmix.ui.action.AbstractAction

io.jmix.ui.action.BaseAction

io.jmix.ui.action.ListAction

io.jmix.reportsui.action.list.RunReportAction

All Implemented Interfaces:

Action, Action.HasPrimaryState, Action.HasTarget, Action.SecuredAction

@StudioAction(target="io.jmix.ui.component.ListComponent",
              description="Runs the reports associated with current screen or list component")
@ActionType("runReport")
public class RunReportAction
extends ListAction

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.ui.action.BaseAction

BaseAction.EnabledRule

Nested classes/interfaces inherited from interface io.jmix.ui.action.Action

Action.ActionPerformedEvent, Action.AdjustWhenScreenReadOnly, Action.ExecutableAction, Action.HasPrimaryState, Action.HasSecurityConstraint, Action.HasTarget, Action.MainTabSheetAction, Action.ScreenOpeningAction, Action.SecuredAction, Action.Status

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
static final String	ID
protected ReportsClientProperties	reportsClientProperties
protected ScreenBuilders	screenBuilders
protected UiReportRunner	uiReportRunner

Fields inherited from class io.jmix.ui.action.ListAction

target

Fields inherited from class io.jmix.ui.action.AbstractAction

caption, description, enabled, eventHub, icon, id, owners, primary, shortcut, visible

Fields inherited from interface io.jmix.ui.action.Action

PROP_CAPTION, PROP_DESCRIPTION, PROP_ENABLED, PROP_ICON, PROP_SHORTCUT, PROP_VISIBLE

Constructor Summary

Constructors

Constructor	Description
RunReportAction()
RunReportAction(String id)

Method Summary

Modifier and Type	Method	Description
void	actionPerform(Component component)	Invoked by owning component to execute the action.
protected void	openLookup(FrameOwner screen)
protected void	openReportParamsDialog(Report report, FrameOwner screen)
protected void	runReports(Collection<Report> reports, FrameOwner screen)
void	setDataManager(DataManager dataManager)
void	setIcons(Icons icons)
void	setMessages(Messages messages)
void	setReportsClientProperties(ReportsClientProperties reportsClientProperties)
void	setScreenBuilders(ScreenBuilders screenBuilders)
void	setUiReportRunner(UiReportRunner uiReportRunner)

Methods inherited from class io.jmix.ui.action.ListAction

getTarget, setTarget, withCaption, withDescription, withHandler, withIcon, withPrimary, withShortcut

Methods inherited from class io.jmix.ui.action.BaseAction

addActionPerformedListener, addEnabledRule, isApplicable, isEnabledByRule, isEnabledByUiPermissions, isPermitted, isVisibleByUiPermissions, refreshState, removeEnabledRule, setEnabled, setEnabledByUiPermissions, setEnabledInternal, setVisible, setVisibleByUiPermissions, setVisibleInternal

Methods inherited from class io.jmix.ui.action.AbstractAction

addOwner, addPropertyChangeListener, firePropertyChange, getCaption, getDescription, getEventHub, getIcon, getId, getOwner, getOwners, getShortcutCombination, hasSubscriptions, isEnabled, isPrimary, isVisible, removeOwner, removePropertyChangeListener, setCaption, setDescription, setIcon, setPrimary, setShortcut, setShortcutCombination

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.jmix.ui.action.Action

addOwner, addPropertyChangeListener, getCaption, getDescription, getIcon, getId, getOwner, getOwners, getShortcutCombination, isEnabled, isVisible, refreshState, removeOwner, removePropertyChangeListener, setCaption, setDescription, setEnabled, setIcon, setShortcut, setShortcutCombination, setVisible

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

screenBuilders

protected ScreenBuilders screenBuilders

uiReportRunner

protected UiReportRunner uiReportRunner

reportsClientProperties

protected ReportsClientProperties reportsClientProperties

Constructor Details

RunReportAction

public RunReportAction()

RunReportAction

public RunReportAction(String id)

Method Details

setIcons

@Autowired
public void setIcons(Icons icons)

setMessages

@Autowired
public void setMessages(Messages messages)

setScreenBuilders

@Autowired
public void setScreenBuilders(ScreenBuilders screenBuilders)

setDataManager

@Autowired
public void setDataManager(DataManager dataManager)

setUiReportRunner

@Autowired
public void setUiReportRunner(UiReportRunner uiReportRunner)

setReportsClientProperties

@Autowired
public void setReportsClientProperties(ReportsClientProperties reportsClientProperties)

actionPerform

public void actionPerform(Component component)

Description copied from interface: Action

Invoked by owning component to execute the action.

Specified by:

actionPerform in interface Action

Overrides:

actionPerform in class BaseAction

Parameters:

component - invoking component

openLookup

protected void openLookup(FrameOwner screen)

runReports

protected void runReports(Collection<Report> reports,
 FrameOwner screen)

openReportParamsDialog

protected void openReportParamsDialog(Report report,
 FrameOwner screen)