com.haulmont.reports.gui.actions.list

Class ListPrintFormAction

java.lang.Object

com.haulmont.cuba.gui.components.AbstractAction

com.haulmont.reports.gui.actions.AbstractPrintFormAction

com.haulmont.reports.gui.actions.list.ListPrintFormAction

All Implemented Interfaces:

com.haulmont.cuba.gui.components.Action, com.haulmont.cuba.gui.components.Action.HasBeforeActionPerformedHandler, com.haulmont.cuba.gui.components.Action.HasPrimaryState, com.haulmont.cuba.gui.components.Action.HasTarget

@StudioAction(category="Reports list actions",
              description="Prints the reports for a list of entity instances associated with a list component")
 @ActionType(value="listPrintForm")
public class ListPrintFormAction
extends AbstractPrintFormAction
implements com.haulmont.cuba.gui.components.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 com.haulmont.cuba.gui.components.Action

com.haulmont.cuba.gui.components.Action.ActionPerformedEvent, com.haulmont.cuba.gui.components.Action.AdjustWhenScreenReadOnly, com.haulmont.cuba.gui.components.Action.BeforeActionPerformedHandler, com.haulmont.cuba.gui.components.Action.DisabledWhenScreenReadOnly, com.haulmont.cuba.gui.components.Action.ExecutableAction, com.haulmont.cuba.gui.components.Action.HasBeforeActionPerformedHandler, com.haulmont.cuba.gui.components.Action.HasOpenType, com.haulmont.cuba.gui.components.Action.HasPrimaryState, com.haulmont.cuba.gui.components.Action.HasSecurityConstraint, com.haulmont.cuba.gui.components.Action.HasTarget, com.haulmont.cuba.gui.components.Action.SecuredAction, com.haulmont.cuba.gui.components.Action.Status

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ID

Fields inherited from interface com.haulmont.cuba.gui.components.Action

PROP_CAPTION, PROP_DESCRIPTION, PROP_ENABLED, PROP_ICON, PROP_SHORTCUT, PROP_VISIBLE

Constructor Summary

Constructors

Constructor and Description
ListPrintFormAction()
ListPrintFormAction(java.lang.String id)

Method Summary

Modifier and Type	Method and Description
void	actionPerform(com.haulmont.cuba.gui.components.Component component)
com.haulmont.cuba.gui.components.ListComponent	getTarget()
void	setIcons(com.haulmont.cuba.gui.icons.Icons icons)
void	setMessages(com.haulmont.cuba.core.global.Messages messages)
void	setTarget(com.haulmont.cuba.gui.components.ListComponent target)

Methods inherited from class com.haulmont.reports.gui.actions.AbstractPrintFormAction

getBeforeActionPerformedHandler, setBeforeActionPerformedHandler

Methods inherited from class com.haulmont.cuba.gui.components.AbstractAction

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.haulmont.cuba.gui.components.Action

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

Field Detail

ID

public static final java.lang.String ID

See Also:

Constant Field Values

Constructor Detail

ListPrintFormAction

public ListPrintFormAction()

ListPrintFormAction

public ListPrintFormAction(java.lang.String id)

Method Detail

setIcons

@Inject
public void setIcons(com.haulmont.cuba.gui.icons.Icons icons)

setMessages

@Inject
public void setMessages(com.haulmont.cuba.core.global.Messages messages)

getTarget

public com.haulmont.cuba.gui.components.ListComponent getTarget()

Specified by:

getTarget in interface com.haulmont.cuba.gui.components.Action.HasTarget

setTarget

public void setTarget(com.haulmont.cuba.gui.components.ListComponent target)

Specified by:

setTarget in interface com.haulmont.cuba.gui.components.Action.HasTarget

actionPerform

public void actionPerform(com.haulmont.cuba.gui.components.Component component)

Specified by:

actionPerform in interface com.haulmont.cuba.gui.components.Action