Package io.jmix.reportsflowui.view.template

Class ReportTemplateDetailView

java.lang.Object

com.vaadin.flow.component.Component

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

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

io.jmix.flowui.view.StandardView

io.jmix.flowui.view.StandardDetailView<ReportTemplate>

io.jmix.reportsflowui.view.template.ReportTemplateDetailView

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, FragmentOwner, ChangeTracker, DetailView<ReportTemplate>, ReadOnlyAwareView, Serializable

@Route(value="reports/templates/:id",
       layout=DefaultMainViewParent.class)
@ViewController("report_ReportTemplate.detail")
@ViewDescriptor("report-template-detail-view.xml")
@DialogMode(width="40em")
public class ReportTemplateDetailView
extends StandardDetailView<ReportTemplate>

See Also:

• Serialized Form

Nested Class Summary

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

StandardDetailView.AfterSaveEvent, StandardDetailView.BeforeSaveEvent, StandardDetailView.InitEntityEvent<E>, StandardDetailView.SetupLockEvent, StandardDetailView.ValidationEvent

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 JmixCheckbox	alterableField
static final String	CUSTOM_DEFINE_BY_PROPERTY
static final String	CUSTOM_PROPERTY
protected JmixSelect<CustomTemplateDefinedBy>	customDefinedByField
protected JmixCodeEditor	customDefinitionField
protected com.vaadin.flow.component.icon.Icon	customDefinitionHelpIcon
protected JmixCheckbox	customField
protected JmixCheckbox	defaultField
protected com.vaadin.flow.component.orderedlayout.HorizontalLayout	descriptionEditBox
protected Dialogs	dialogs
protected JmixRadioButtonGroup<Boolean>	isGroovyRadioButtonGroup
protected MessageBundle	messageBundle
protected Metadata	metadata
protected Notifications	notifications
protected TypedTextField<String>	outputNamePatternField
protected JmixComboBox<ReportOutputType>	outputTypeField
protected PolicyStore	policyStore
protected com.vaadin.flow.component.orderedlayout.VerticalLayout	previewBox
static final String	REPORT_CONTENT_PROPERTY
static final String	REPORT_OUTPUT_TYPE_PROPERTY
protected ReportScriptEditor	reportScriptEditor
protected InstanceContainer<ReportTemplate>	reportTemplateDc
protected SecureOperations	secureOperations
protected TableEditFragment	tableEditComposite
protected JmixCodeEditor	templateFileEditor
protected FileUploadField	templateUploadField
protected UiComponents	uiComponents

Fields inherited from class io.jmix.flowui.view.StandardDetailView

DEFAULT_ROUTE_PARAM, LOCKED_BEFORE_REFRESH_ATTR_NAME, MODE_PARAM, MODE_READONLY, NEW_ENTITY_ID, READ_ONLY_BEFORE_REFRESH_ATTR_NAME, reloadSaved

Constructor Summary

Constructors

Constructor	Description
ReportTemplateDetailView()

Method Summary

Modifier and Type	Method	Description
protected CodeEditorMode	getCodeEditorMode(ReportTemplate reportTemplate)
protected Collection<AbstractDescriptionEditFragment<?>>	getDescriptionEditors()
protected boolean	hasHtmlCsvTemplateOutput(ReportOutputType reportOutputType)
protected boolean	hasScriptCustomDefinedBy(CustomTemplateDefinedBy customTemplateDefinedBy)
protected boolean	hasSupportedFileExtension(ReportOutputType reportOutputType)
protected boolean	hasTemplateOutput(ReportOutputType reportOutputType)
protected void	initCustomDefinitionHelpIcon()
protected void	initDefaultField(ReportTemplate currentTemplate)
protected void	initDescriptionComposites()
protected void	initOutputNamePatternField()
protected void	initOutputTypeList()
protected void	initTemplateEditor(ReportTemplate reportTemplate)
protected void	initUploadField(ReportTemplate reportTemplate)
protected boolean	isContentAttributeUpdatePermitted(ReportTemplate reportTemplate)
void	onBeforeSave(StandardDetailView.BeforeSaveEvent event)
void	onBeforeShow(View.BeforeShowEvent event)
void	onCustomDefinitionFullScreenBtnClick(com.vaadin.flow.component.ClickEvent<com.vaadin.flow.component.button.Button> event)
protected void	onCustomDefinitionHelpIconClick(com.vaadin.flow.component.ClickEvent<com.vaadin.flow.component.icon.Icon> event)
void	onInit(View.InitEvent event)
void	onInitEntity(StandardDetailView.InitEntityEvent<ReportTemplate> event)
protected void	onOutputNamePatternHelpIconClick(com.vaadin.flow.component.ClickEvent<com.vaadin.flow.component.icon.Icon> event)
protected void	onReportTemplateDcItemPropertyChange(InstanceContainer.ItemPropertyChangeEvent<ReportTemplate> event)
void	onTemplateFileEditorFullScreenBtnClick(com.vaadin.flow.component.ClickEvent<com.vaadin.flow.component.button.Button> event)
void	onTemplateUploadFieldFileUploadFailed(FileUploadFailedEvent<FileUploadField> event)
void	onTemplateUploadFieldFileUploadStarted(FileUploadStartedEvent<FileUploadField> event)
void	onTemplateUploadFieldFileUploadSucceeded(FileUploadSucceededEvent<FileUploadField> event)
protected void	openCustomDefinitionHelpDialog()
protected void	setupTemplateTypeVisibility(boolean visibility)
protected void	setupVisibility(boolean customEnabled, ReportOutputType reportOutputType)
protected void	setupVisibilityDescriptionEdit(boolean customEnabled, ReportOutputType reportOutputType)
protected void	updateOutputNamePattern(ReportOutputType value, ReportOutputType prevValue)
protected void	updateOutputType()
protected boolean	validateInputOutputFormats()
protected boolean	validateTemplateFile()
protected void	visibleTemplateEditor(ReportOutputType outputType)

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

addAfterSaveListener, addBeforeSaveListener, addInitEntityListener, addValidationEventListener, beforeEnter, clearChanges, closeWithDiscard, closeWithSave, findEntityId, getEditedEntity, getEditedEntityContainer, getEditedEntityLoader, getEditedEntityOrNull, getLockStatus, getRouteParamName, getSaveNotificationText, hasUnsavedChanges, initExistingEntity, initNewEntity, isCrossFieldValidationEnabled, isReadOnly, isReloadEdited, isReloadSaved, isSaveActionPerformed, isShowSaveNotification, isShowValidationErrors, onDetachInternal, preventUnsavedChanges, processBeforeEnterInternal, save, setCrossFieldValidationEnabled, setEntityToEdit, setReadOnly, setReloadEdited, setReloadSaved, setShowSaveNotification, setShowValidationErrors, setupEntityToEdit, setupEntityToEdit, setupEntityToEdit, validateView

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

initContent

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

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

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

getChildren, getContent, getElement

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

addListener, findAncestor, fireEvent, from, get, getListeners, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onEnabledStateChanged, removeFromParent, scrollIntoView, scrollIntoView, set, setElement, 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, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassName

Field Details

CUSTOM_DEFINE_BY_PROPERTY

public static final String CUSTOM_DEFINE_BY_PROPERTY

See Also:

• Constant Field Values

REPORT_CONTENT_PROPERTY

public static final String REPORT_CONTENT_PROPERTY

See Also:

• Constant Field Values

CUSTOM_PROPERTY

public static final String CUSTOM_PROPERTY

See Also:

• Constant Field Values

REPORT_OUTPUT_TYPE_PROPERTY

public static final String REPORT_OUTPUT_TYPE_PROPERTY

See Also:

• Constant Field Values

isGroovyRadioButtonGroup

@ViewComponent
protected JmixRadioButtonGroup<Boolean> isGroovyRadioButtonGroup

customField

@ViewComponent
protected JmixCheckbox customField

defaultField

@ViewComponent
protected JmixCheckbox defaultField

customDefinedByField

@ViewComponent
protected JmixSelect<CustomTemplateDefinedBy> customDefinedByField

customDefinitionField

@ViewComponent
protected JmixCodeEditor customDefinitionField

alterableField

@ViewComponent
protected JmixCheckbox alterableField

templateUploadField

@ViewComponent
protected FileUploadField templateUploadField

outputNamePatternField

@ViewComponent
protected TypedTextField<String> outputNamePatternField

templateFileEditor

@ViewComponent
protected JmixCodeEditor templateFileEditor

outputTypeField

@ViewComponent
protected JmixComboBox<ReportOutputType> outputTypeField

descriptionEditBox

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

previewBox

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

reportTemplateDc

@ViewComponent
protected InstanceContainer<ReportTemplate> reportTemplateDc

messageBundle

@Autowired
protected MessageBundle messageBundle

dialogs

@Autowired
protected Dialogs dialogs

secureOperations

@Autowired
protected SecureOperations secureOperations

metadata

@Autowired
protected Metadata metadata

policyStore

@Autowired
protected PolicyStore policyStore

notifications

@Autowired
protected Notifications notifications

uiComponents

@Autowired
protected UiComponents uiComponents

reportScriptEditor

@Autowired
protected ReportScriptEditor reportScriptEditor

customDefinitionHelpIcon

protected com.vaadin.flow.component.icon.Icon customDefinitionHelpIcon

tableEditComposite

protected TableEditFragment tableEditComposite

Constructor Details

ReportTemplateDetailView

public ReportTemplateDetailView()

Method Details

onInit

@Subscribe
public void onInit(View.InitEvent event)

onInitEntity

@Subscribe
public void onInitEntity(StandardDetailView.InitEntityEvent<ReportTemplate> event)

onBeforeShow

@Subscribe
public void onBeforeShow(View.BeforeShowEvent event)

onBeforeSave

@Subscribe
public void onBeforeSave(StandardDetailView.BeforeSaveEvent event)

onTemplateUploadFieldFileUploadStarted

@Subscribe("templateUploadField")
public void onTemplateUploadFieldFileUploadStarted(FileUploadStartedEvent<FileUploadField> event)

onTemplateUploadFieldFileUploadFailed

@Subscribe("templateUploadField")
public void onTemplateUploadFieldFileUploadFailed(FileUploadFailedEvent<FileUploadField> event)

onTemplateUploadFieldFileUploadSucceeded

@Subscribe("templateUploadField")
public void onTemplateUploadFieldFileUploadSucceeded(FileUploadSucceededEvent<FileUploadField> event)

initDefaultField

protected void initDefaultField(ReportTemplate currentTemplate)

initCustomDefinitionHelpIcon

protected void initCustomDefinitionHelpIcon()

initDescriptionComposites

protected void initDescriptionComposites()

onCustomDefinitionHelpIconClick

protected void onCustomDefinitionHelpIconClick(com.vaadin.flow.component.ClickEvent<com.vaadin.flow.component.icon.Icon> event)

openCustomDefinitionHelpDialog

protected void openCustomDefinitionHelpDialog()

initOutputNamePatternField

protected void initOutputNamePatternField()

onOutputNamePatternHelpIconClick

protected void onOutputNamePatternHelpIconClick(com.vaadin.flow.component.ClickEvent<com.vaadin.flow.component.icon.Icon> event)

onCustomDefinitionFullScreenBtnClick

@Subscribe("customDefinitionFullScreenBtn")
public void onCustomDefinitionFullScreenBtnClick(com.vaadin.flow.component.ClickEvent<com.vaadin.flow.component.button.Button> event)

initUploadField

protected void initUploadField(ReportTemplate reportTemplate)

onReportTemplateDcItemPropertyChange

protected void onReportTemplateDcItemPropertyChange(InstanceContainer.ItemPropertyChangeEvent<ReportTemplate> event)

getDescriptionEditors

protected Collection<AbstractDescriptionEditFragment<?>> getDescriptionEditors()

initOutputTypeList

protected void initOutputTypeList()

initTemplateEditor

protected void initTemplateEditor(ReportTemplate reportTemplate)

getCodeEditorMode

protected CodeEditorMode getCodeEditorMode(ReportTemplate reportTemplate)

visibleTemplateEditor

protected void visibleTemplateEditor(@Nullable
 ReportOutputType outputType)

onTemplateFileEditorFullScreenBtnClick

@Subscribe("templateFileEditorFullScreenBtn")
public void onTemplateFileEditorFullScreenBtnClick(com.vaadin.flow.component.ClickEvent<com.vaadin.flow.component.button.Button> event)

setupVisibility

protected void setupVisibility(boolean customEnabled,
 ReportOutputType reportOutputType)

setupTemplateTypeVisibility

protected void setupTemplateTypeVisibility(boolean visibility)

setupVisibilityDescriptionEdit

protected void setupVisibilityDescriptionEdit(boolean customEnabled,
 ReportOutputType reportOutputType)

validateTemplateFile

protected boolean validateTemplateFile()

validateInputOutputFormats

protected boolean validateInputOutputFormats()

updateOutputType

protected void updateOutputType()

updateOutputNamePattern

protected void updateOutputNamePattern(ReportOutputType value,
 ReportOutputType prevValue)

hasSupportedFileExtension

protected boolean hasSupportedFileExtension(ReportOutputType reportOutputType)

hasTemplateOutput

protected boolean hasTemplateOutput(ReportOutputType reportOutputType)

hasScriptCustomDefinedBy

protected boolean hasScriptCustomDefinedBy(CustomTemplateDefinedBy customTemplateDefinedBy)

hasHtmlCsvTemplateOutput

protected boolean hasHtmlCsvTemplateOutput(@Nullable
 ReportOutputType reportOutputType)

isContentAttributeUpdatePermitted

protected boolean isContentAttributeUpdatePermitted(ReportTemplate reportTemplate)