io.jmix.reportsui.action

Class AbstractPrintFormAction

java.lang.Object

io.jmix.ui.action.AbstractAction

io.jmix.reportsui.action.AbstractPrintFormAction

All Implemented Interfaces:

io.jmix.ui.action.Action, io.jmix.ui.action.Action.HasPrimaryState

Direct Known Subclasses:

EditorPrintFormAction, ListPrintFormAction

public abstract class AbstractPrintFormAction
extends io.jmix.ui.action.AbstractAction

Nested Class Summary

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

io.jmix.ui.action.Action.ActionPerformedEvent, io.jmix.ui.action.Action.AdjustWhenScreenReadOnly, io.jmix.ui.action.Action.ExecutableAction, io.jmix.ui.action.Action.HasPrimaryState, io.jmix.ui.action.Action.HasSecurityConstraint, io.jmix.ui.action.Action.HasTarget, io.jmix.ui.action.Action.MainTabSheetAction, io.jmix.ui.action.Action.ScreenOpeningAction, io.jmix.ui.action.Action.SecuredAction, io.jmix.ui.action.Action.Status

Field Summary

Fields

Modifier and Type	Field and Description
protected io.jmix.core.usersubstitution.CurrentUserSubstitution	currentUserSubstitution
protected io.jmix.core.DataManager	dataManager
protected io.jmix.core.FetchPlanRepository	fetchPlanRepository
protected io.jmix.core.Messages	messages
protected io.jmix.core.Metadata	metadata
protected PrototypesLoader	prototypesLoader
protected ReportsClientProperties	reportsClientProperties
protected ReportSecurityManager	reportSecurityManager
protected io.jmix.ui.ScreenBuilders	screenBuilder
protected io.jmix.ui.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 and Description
protected	AbstractPrintFormAction(java.lang.String id)

Method Summary

Modifier and Type	Method and Description
protected java.lang.Object	convertParameterIfNecessary(ReportInputParameter parameter, java.lang.Object paramValue, boolean useForInputParametersForm)
protected ReportInputParameter	getParameterAlias(Report report, io.jmix.core.metamodel.model.MetaClass inputValueMetaClass)
protected java.lang.Object	handleCollectionParameter(java.lang.Object paramValue, boolean convertToSingleItem)
protected void	openReportParamsDialog(Report report, java.util.Map<java.lang.String,java.lang.Object> params, java.lang.String outputNamePattern, ReportInputParameter inputParameter, boolean bulkPrint)
protected void	openRunReportScreen(io.jmix.ui.screen.Screen screen, java.lang.Object selectedValue, io.jmix.core.metamodel.model.MetaClass inputValueMetaClass)
protected void	openRunReportScreen(io.jmix.ui.screen.Screen screen, java.lang.Object selectedValue, io.jmix.core.metamodel.model.MetaClass inputValueMetaClass, java.lang.String outputFileName)
protected boolean	parameterMatchesMetaClass(ReportInputParameter parameter, io.jmix.core.metamodel.model.MetaClass metaClass)
protected Report	reloadReport(Report report)
void	runAndShow(Report report, io.jmix.ui.screen.FrameOwner screen, ReportInputParameter reportInputParameter, java.lang.Object parameterValue, java.lang.String outputFileName)
protected void	runReport(Report report, io.jmix.ui.screen.Screen screen, java.lang.Object selectedValue, io.jmix.core.metamodel.model.MetaClass inputValueMetaClass, java.lang.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 Detail

reportSecurityManager

@Autowired
protected ReportSecurityManager reportSecurityManager

dataManager

@Autowired
protected io.jmix.core.DataManager dataManager

messages

@Autowired
protected io.jmix.core.Messages messages

screenBuilder

@Autowired
protected io.jmix.ui.ScreenBuilders screenBuilder

fetchPlanRepository

@Autowired
protected io.jmix.core.FetchPlanRepository fetchPlanRepository

currentUserSubstitution

@Autowired
protected io.jmix.core.usersubstitution.CurrentUserSubstitution currentUserSubstitution

uiReportRunner

@Autowired
protected UiReportRunner uiReportRunner

screens

@Autowired
protected io.jmix.ui.Screens screens

prototypesLoader

@Autowired
protected PrototypesLoader prototypesLoader

metadata

@Autowired
protected io.jmix.core.Metadata metadata

reportsClientProperties

@Autowired
protected ReportsClientProperties reportsClientProperties

Constructor Detail

AbstractPrintFormAction

protected AbstractPrintFormAction(java.lang.String id)

Method Detail

openRunReportScreen

protected void openRunReportScreen(io.jmix.ui.screen.Screen screen,
                                   java.lang.Object selectedValue,
                                   io.jmix.core.metamodel.model.MetaClass inputValueMetaClass)

openRunReportScreen

protected void openRunReportScreen(io.jmix.ui.screen.Screen screen,
                                   java.lang.Object selectedValue,
                                   io.jmix.core.metamodel.model.MetaClass inputValueMetaClass,
                                   @Nullable
                                   java.lang.String outputFileName)

runReport

protected void runReport(Report report,
                         io.jmix.ui.screen.Screen screen,
                         java.lang.Object selectedValue,
                         io.jmix.core.metamodel.model.MetaClass inputValueMetaClass,
                         @Nullable
                         java.lang.String outputFileName)

runAndShow

public void runAndShow(Report report,
                       io.jmix.ui.screen.FrameOwner screen,
                       ReportInputParameter reportInputParameter,
                       java.lang.Object parameterValue,
                       @Nullable
                       java.lang.String outputFileName)

openReportParamsDialog

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

convertParameterIfNecessary

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

handleCollectionParameter

@Nullable
protected java.lang.Object handleCollectionParameter(@Nullable
                                                               java.lang.Object paramValue,
                                                               boolean convertToSingleItem)

getParameterAlias

protected ReportInputParameter getParameterAlias(Report report,
                                                 io.jmix.core.metamodel.model.MetaClass inputValueMetaClass)

parameterMatchesMetaClass

protected boolean parameterMatchesMetaClass(ReportInputParameter parameter,
                                            io.jmix.core.metamodel.model.MetaClass metaClass)

reloadReport

protected Report reloadReport(Report report)