Package io.jmix.reportsui.action.list

Class ListPrintFormAction

java.lang.Object

io.jmix.ui.action.AbstractAction

io.jmix.reportsui.action.AbstractPrintFormAction

io.jmix.reportsui.action.list.ListPrintFormAction

All Implemented Interfaces:

Action, Action.HasPrimaryState, Action.HasTarget

@StudioAction(target="io.jmix.ui.component.ListComponent",
              description="Prints the reports for a list of entity instances associated with a list component")
@ActionType("listPrintForm")
public class ListPrintFormAction
extends AbstractPrintFormAction
implements Action.HasTarget

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 interface io.jmix.ui.action.Action

Action.ActionPerformedEvent, Action.AdjustWhenScreenReadOnly, Action.ExecutableAction, Action.HasPrimaryState, Action.HasSecurityConstraint, Action.HasTarget, Action.MainTabSheetAction, Action.OperationResultAction, Action.ScreenAction<S extends Screen>, Action.ScreenOpeningAction, Action.SecuredAction, Action.Status

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ID
protected ListComponent	target

Fields inherited from class io.jmix.reportsui.action.AbstractPrintFormAction

currentUserSubstitution, dataManager, fetchPlanRepository, messages, metadata, prototypesLoader, reportsClientProperties, reportSecurityManager, screenBuilder, screens, 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

Constructor	Description
ListPrintFormAction()
ListPrintFormAction(String id)

Method Summary

Modifier and Type	Method	Description
void	actionPerform(Component component)	Invoked by owning component to execute the action.
ListComponent	getTarget()
protected boolean	isDataAvailable()
protected void	printAll()
protected void	printSelected(Set selected)
void	setIcons(Icons icons)
void	setMessages(Messages messages)
void	setTarget(ListComponent target)

Methods inherited from class io.jmix.reportsui.action.AbstractPrintFormAction

convertParameterIfNecessary, getParameterAlias, handleCollectionParameter, openReportParamsDialog, openRunReportScreen, openRunReportScreen, parameterMatchesMetaClass, reloadReport, runAndShow, runReport

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

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

target

protected ListComponent target

Constructor Details

ListPrintFormAction

public ListPrintFormAction()

ListPrintFormAction

public ListPrintFormAction(String id)

Method Details

setIcons

@Autowired
public void setIcons(Icons icons)

setMessages

@Autowired
public void setMessages(Messages messages)

getTarget

public ListComponent getTarget()

Specified by:

getTarget in interface Action.HasTarget

setTarget

public void setTarget(ListComponent target)

Specified by:

setTarget in interface Action.HasTarget

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

Parameters:

component - invoking component

isDataAvailable

protected boolean isDataAvailable()

printSelected

protected void printSelected(Set selected)

printAll

protected void printAll()