Package io.jmix.reportsflowui.view.run

Class ReportTableView

java.lang.Object

com.vaadin.flow.component.Component

com.vaadin.flow.component.Composite<ViewLayout>

io.jmix.flowui.view.View<ViewLayout>

io.jmix.flowui.view.StandardView

io.jmix.reportsflowui.view.run.ReportTableView

All Implemented Interfaces:

com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasStyle, com.vaadin.flow.router.AfterNavigationObserver, com.vaadin.flow.router.BeforeEnterObserver, com.vaadin.flow.router.BeforeLeaveObserver, com.vaadin.flow.router.HasDynamicTitle, com.vaadin.flow.router.internal.AfterNavigationHandler, com.vaadin.flow.router.internal.BeforeEnterHandler, com.vaadin.flow.router.internal.BeforeLeaveHandler, FacetOwner, FragmentOwner, Serializable

@RouteAlias(value="reports/tables",
            layout=DefaultMainViewParent.class)
@Route(value="report/tables",
       layout=DefaultMainViewParent.class)
@ViewController("report_ReportTableView")
@ViewDescriptor("report-table-view.xml")
@DialogMode(width="50em",
            resizable=true)
public class ReportTableView
extends StandardView

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class io.jmix.flowui.view.View

View.AfterCloseEvent, View.BeforeCloseEvent, View.BeforeShowEvent, View.InitEvent, View.PostReadyEvent, View.QueryParametersChangeEvent, View.ReadyEvent, View.RestoreComponentsStateEvent

Field Summary

Fields

Modifier and Type	Field	Description
protected Actions	actions
protected CurrentUserSubstitution	currentUserSubstitution
protected DataComponents	dataComponents
protected DatatypeRegistry	datatypeRegistry
protected InputParametersFragment	inputParametersFrame
protected Messages	messages
protected Metadata	metadata
protected MetadataTools	metadataTools
protected Notifications	notifications
protected OpenedDialogWindows	openedDialogWindows
protected JmixButton	openInViewBtn
protected com.vaadin.flow.component.html.Div	parametersBox
protected com.vaadin.flow.component.orderedlayout.HorizontalLayout	parametersFrameHolder
protected ReportExcelHelper	reportExcelHelper
protected com.vaadin.flow.component.orderedlayout.HorizontalLayout	reportForm
protected ReportOutputDocument	reportOutputDocument
protected Map<String,Object>	reportParameters
protected ReportRepository	reportRepository
protected ReportRunner	reportRunner
protected CollectionLoader<Report>	reportsDl
protected StandardSerialization	serialization
protected boolean	tablesDrawn
protected com.vaadin.flow.component.orderedlayout.VerticalLayout	tablesVBoxLayout
protected String	templateCode
protected com.vaadin.flow.component.orderedlayout.HorizontalLayout	topActionsPanel
protected UiComponents	uiComponents
protected ViewNavigators	viewNavigators
protected ViewValidation	viewValidation

Constructor Summary

Constructors

Constructor	Description
ReportTableView()

Method Summary

Modifier and Type	Method	Description
protected void	closeOtherDialogs(@Nullable com.vaadin.flow.component.UI ui)	Closes any other dialog views that remained open (e.g.
protected void	createColumns(KeyValueCollectionContainer collectionContainer, DataGrid<KeyValueEntity> table, Set<JmixTableData.ColumnInfo> headers)
protected KeyValueCollectionContainer	createContainer(String dataSetName, List<KeyValueEntity> keyValueEntities, Map<String,Set<JmixTableData.ColumnInfo>> headerMap)
protected ReportFilter	createFilter()
protected DataGrid<KeyValueEntity>	createTable(String dataSetName, KeyValueCollectionContainer container, Map<String,Set<JmixTableData.ColumnInfo>> headerMap)
protected void	drawTables(ReportOutputDocument document)
protected @Nullable String	findTableCode(Report report)
void	loadReportContent()	Renders the configured report output document into the view.
protected void	onBeforeShow(View.BeforeShowEvent event)
protected void	onOpenInViewBtnClick(com.vaadin.flow.component.ClickEvent<JmixButton> event)
protected void	onReady(View.ReadyEvent event)
void	onReportEntityComboBoxComponentValueChange(com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<EntityComboBox<Report>,Report> event)
void	onRunAction(ActionPerformedEvent event)
protected List<Report>	reportsDlLoadDelegate(LoadContext<Report> ignored)
void	setReportOutputDocument(ReportOutputDocument reportOutputDocument)
void	setReportParameters(Map<String,Object> reportParameters)
void	setTemplateCode(@Nullable String templateCode)

Methods inherited from class io.jmix.flowui.view.View

addAfterCloseListener, addApplicationListeners, addBeforeCloseListener, addBeforeShowListener, addInitListener, addQueryParametersChangeListener, addReadyListener, addRestoreComponentsStateEventListener, afterNavigation, beforeEnter, beforeLeave, close, close, closeWithDefaultAction, configureDialogWindowFooter, configureDialogWindowHeader, getApplicationContext, getEventBus, getId, getPageTitle, getReturnParameters, getViewActions, getViewAttributes, getViewData, getViewFacets, getViewSupport, isPreventBrowserTabClosing, onAttach, onAttachInternal, onDetach, onDetachInternal, processBeforeEnterInternal, removeApplicationListeners, removeViewAttributes, setAfterNavigationHandler, setApplicationContext, setId, setPageTitle, setPreventBrowserTabClosing, setViewActions, setViewData, setViewFacets, unregisterBackNavigation

Methods inherited from class com.vaadin.flow.component.Composite

getChildren, getContent, getElement, initContent

Methods inherited from class com.vaadin.flow.component.Component

addListener, bindVisible, findAncestor, fireEvent, from, get, getListeners, getLocale, getParent, getTestId, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onEnabledStateChanged, removeFromParent, scrollIntoView, scrollIntoView, set, setElement, setTestId, setVisible

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vaadin.flow.component.AttachNotifier

addAttachListener

Methods inherited from interface com.vaadin.flow.component.DetachNotifier

addDetachListener

Methods inherited from interface com.vaadin.flow.component.HasStyle

addClassName, addClassNames, bindClassName, bindClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassName

Field Details

parametersFrameHolder

@ViewComponent
protected com.vaadin.flow.component.orderedlayout.HorizontalLayout parametersFrameHolder

reportForm

@ViewComponent
protected com.vaadin.flow.component.orderedlayout.HorizontalLayout reportForm

tablesVBoxLayout

@ViewComponent
protected com.vaadin.flow.component.orderedlayout.VerticalLayout tablesVBoxLayout

parametersBox

@ViewComponent
protected com.vaadin.flow.component.html.Div parametersBox

topActionsPanel

@ViewComponent
protected com.vaadin.flow.component.orderedlayout.HorizontalLayout topActionsPanel

openInViewBtn

@ViewComponent
protected JmixButton openInViewBtn

reportsDl

@ViewComponent
protected CollectionLoader<Report> reportsDl

uiComponents

@Autowired
protected UiComponents uiComponents

metadata

@Autowired
protected Metadata metadata

metadataTools

@Autowired
protected MetadataTools metadataTools

serialization

@Autowired
protected StandardSerialization serialization

viewValidation

@Autowired
protected ViewValidation viewValidation

actions

@Autowired
protected Actions actions

reportRunner

@Autowired
protected ReportRunner reportRunner

dataComponents

@Autowired
protected DataComponents dataComponents

datatypeRegistry

@Autowired
protected DatatypeRegistry datatypeRegistry

messages

@Autowired
protected Messages messages

notifications

@Autowired
protected Notifications notifications

reportExcelHelper

@Autowired(required=false)
protected ReportExcelHelper reportExcelHelper

reportRepository

@Autowired
protected ReportRepository reportRepository

currentUserSubstitution

@Autowired
protected CurrentUserSubstitution currentUserSubstitution

viewNavigators

@Autowired
protected ViewNavigators viewNavigators

openedDialogWindows

@Autowired
protected OpenedDialogWindows openedDialogWindows

templateCode

protected String templateCode

reportParameters

protected Map<String,Object> reportParameters

inputParametersFrame

protected InputParametersFragment inputParametersFrame

reportOutputDocument

protected ReportOutputDocument reportOutputDocument

tablesDrawn

protected boolean tablesDrawn

Constructor Details

ReportTableView

public ReportTableView()

Method Details

setTemplateCode

public void setTemplateCode(@Nullable String templateCode)

setReportParameters

public void setReportParameters(Map<String,Object> reportParameters)

setReportOutputDocument

public void setReportOutputDocument(ReportOutputDocument reportOutputDocument)

onReportEntityComboBoxComponentValueChange

@Subscribe("reportEntityComboBox")
public void onReportEntityComboBoxComponentValueChange(com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<EntityComboBox<Report>,Report> event)

onBeforeShow

@Subscribe
protected void onBeforeShow(View.BeforeShowEvent event)

onReady

@Subscribe
protected void onReady(View.ReadyEvent event)

loadReportContent

public void loadReportContent()

Renders the configured report output document into the view. Idempotent: subsequent invocations are no-ops, and the method does nothing until setReportOutputDocument(ReportOutputDocument) has been called. For the NAVIGATION open mode, where the document is set after the regular lifecycle events, this method must be invoked explicitly from withAfterNavigationHandler.

onOpenInViewBtnClick

@Subscribe("openInViewBtn")
protected void onOpenInViewBtnClick(com.vaadin.flow.component.ClickEvent<JmixButton> event)

closeOtherDialogs

protected void closeOtherDialogs(@Nullable com.vaadin.flow.component.UI ui)

Closes any other dialog views that remained open (e.g. the input parameters dialog stacked behind this view), so that the navigation target is shown without leftover modal layers.

reportsDlLoadDelegate

@Install(to="reportsDl",
         target=DATA_LOADER)
protected List<Report> reportsDlLoadDelegate(LoadContext<Report> ignored)

createFilter

protected ReportFilter createFilter()

onRunAction

@Subscribe("runAction")
public void onRunAction(ActionPerformedEvent event)

findTableCode

protected @Nullable String findTableCode(Report report)

drawTables

protected void drawTables(ReportOutputDocument document)

createContainer

protected KeyValueCollectionContainer createContainer(String dataSetName,
 List<KeyValueEntity> keyValueEntities,
 Map<String,Set<JmixTableData.ColumnInfo>> headerMap)

createTable

protected DataGrid<KeyValueEntity> createTable(String dataSetName,
 KeyValueCollectionContainer container,
 Map<String,Set<JmixTableData.ColumnInfo>> headerMap)

createColumns

protected void createColumns(KeyValueCollectionContainer collectionContainer,
 DataGrid<KeyValueEntity> table,
 Set<JmixTableData.ColumnInfo> headers)