Package io.jmix.reportsui.action

Class AbstractPrintFormAction

java.lang.Object

io.jmix.ui.action.AbstractAction

io.jmix.reportsui.action.AbstractPrintFormAction

All Implemented Interfaces:

Action, Action.HasPrimaryState

Direct Known Subclasses:

EditorPrintFormAction, ListPrintFormAction

public abstract class AbstractPrintFormAction
extends AbstractAction

Nested Class Summary

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 CurrentUserSubstitution	currentUserSubstitution
protected DataManager	dataManager
protected FetchPlanRepository	fetchPlanRepository
protected Messages	messages
protected Metadata	metadata
protected PrototypesLoader	prototypesLoader
protected ReportsClientProperties	reportsClientProperties
protected ReportSecurityManager	reportSecurityManager
protected ScreenBuilders	screenBuilder
protected Screens	screens
protected UiReportRunner	uiReportRunner

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

Modifier	Constructor	Description
protected	AbstractPrintFormAction(String id)

Method Summary

Modifier and Type	Method	Description
protected Object	convertParameterIfNecessary(ReportInputParameter parameter, Object paramValue, boolean useForInputParametersForm)
protected ReportInputParameter	getParameterAlias(Report report, MetaClass inputValueMetaClass)
protected Object	handleCollectionParameter(Object paramValue, boolean convertToSingleItem)
protected void	openReportParamsDialog(Report report, Map<String,Object> params, String outputNamePattern, ReportInputParameter inputParameter, boolean bulkPrint)
protected void	openRunReportScreen(Screen screen, Object selectedValue, MetaClass inputValueMetaClass)
protected void	openRunReportScreen(Screen screen, Object selectedValue, MetaClass inputValueMetaClass, String outputFileName)
protected boolean	parameterMatchesMetaClass(ReportInputParameter parameter, MetaClass metaClass)
protected Report	reloadReport(Report report)
void	runAndShow(Report report, FrameOwner screen, ReportInputParameter reportInputParameter, Object parameterValue, String outputFileName)
protected void	runReport(Report report, Screen screen, Object selectedValue, MetaClass inputValueMetaClass, String outputFileName)

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

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

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

actionPerform

Field Details

reportSecurityManager

@Autowired
protected ReportSecurityManager reportSecurityManager

dataManager

@Autowired
protected DataManager dataManager

messages

@Autowired
protected Messages messages

screenBuilder

@Autowired
protected ScreenBuilders screenBuilder

fetchPlanRepository

@Autowired
protected FetchPlanRepository fetchPlanRepository

currentUserSubstitution

@Autowired
protected CurrentUserSubstitution currentUserSubstitution

uiReportRunner

@Autowired
protected UiReportRunner uiReportRunner

screens

@Autowired
protected Screens screens

prototypesLoader

@Autowired
protected PrototypesLoader prototypesLoader

metadata

@Autowired
protected Metadata metadata

reportsClientProperties

@Autowired
protected ReportsClientProperties reportsClientProperties

Constructor Details

AbstractPrintFormAction

protected AbstractPrintFormAction(String id)

Method Details

openRunReportScreen

protected void openRunReportScreen(Screen screen,
 Object selectedValue,
 MetaClass inputValueMetaClass)

openRunReportScreen

protected void openRunReportScreen(Screen screen,
 Object selectedValue,
 MetaClass inputValueMetaClass,
 @Nullable
 String outputFileName)

runReport

protected void runReport(Report report,
 Screen screen,
 Object selectedValue,
 MetaClass inputValueMetaClass,
 @Nullable
 String outputFileName)

runAndShow

public void runAndShow(Report report,
 FrameOwner screen,
 ReportInputParameter reportInputParameter,
 Object parameterValue,
 @Nullable
 String outputFileName)

openReportParamsDialog

protected void openReportParamsDialog(Report report,
 Map<String,Object> params,
 @Nullable
 String outputNamePattern,
 ReportInputParameter inputParameter,
 boolean bulkPrint)

convertParameterIfNecessary

@Nullable
protected Object convertParameterIfNecessary(ReportInputParameter parameter,
 Object paramValue,
 boolean useForInputParametersForm)

handleCollectionParameter

@Nullable
protected Object handleCollectionParameter(@Nullable
 Object paramValue,
 boolean convertToSingleItem)

getParameterAlias

protected ReportInputParameter getParameterAlias(Report report,
 MetaClass inputValueMetaClass)

parameterMatchesMetaClass

protected boolean parameterMatchesMetaClass(ReportInputParameter parameter,
 MetaClass metaClass)

reloadReport

protected Report reloadReport(Report report)