Package io.jmix.reportsui.screen.template.edit

Class TemplateEditor

java.lang.Object

io.jmix.ui.screen.Screen

io.jmix.ui.screen.StandardEditor<ReportTemplate>

io.jmix.reportsui.screen.template.edit.TemplateEditor

All Implemented Interfaces:

ChangeTracker, EditorScreen<ReportTemplate>, FrameOwner, ReadOnlyAwareScreen

@UiController("report_ReportTemplate.edit")
@UiDescriptor("template-edit.xml")
public class TemplateEditor
extends StandardEditor<ReportTemplate>

Nested Class Summary

Nested classes/interfaces inherited from class io.jmix.ui.screen.StandardEditor

StandardEditor.AfterCommitChangesEvent, StandardEditor.BeforeCommitChangesEvent, StandardEditor.InitEntityEvent<E>, StandardEditor.ValidationEvent

Nested classes/interfaces inherited from class io.jmix.ui.screen.Screen

Screen.AfterCloseEvent, Screen.AfterDetachEvent, Screen.AfterInitEvent, Screen.AfterShowEvent, Screen.BeforeCloseEvent, Screen.BeforeShowEvent, Screen.InitEvent

Field Summary

Fields

Modifier and Type	Field	Description
protected CheckBox	alterableField
protected Label<String>	alterableLabel
protected ChartEditFragment	chartEditFragment
static final String	CUSTOM
static final String	CUSTOM_DEFINE_BY
protected ComboBox<CustomTemplateDefinedBy>	customDefinedByField
protected Label<String>	customDefinedByLabel
protected TextArea<String>	customDefinitionField
protected LinkButton	customDefinitionHelpLinkButton
protected Label<String>	customDefinitionLabel
protected CheckBox	customField
protected BoxLayout	descriptionEditBox
protected Dialogs	dialogs
protected LinkButton	fullScreenLinkButton
protected Label<String>	isCustomLabel
protected Label<String>	isGroovyLabel
protected RadioButtonGroup<Boolean>	isGroovyRadioButtonGroup
protected MessageBundle	messageBundle
protected Messages	messages
protected Metadata	metadata
protected Notifications	notifications
protected TextField<String>	outputNamePatternField
protected Label<String>	outputNamePatternLabel
protected ComboBox<ReportOutputType>	outputTypeField
protected PivotTableEditFragment	pivotTableEditFragment
protected PolicyStore	policyStore
protected BoxLayout	previewBox
static final String	REPORT_OUTPUT_TYPE
protected ScreenBuilders	screenBuilders
protected SecureOperations	secureOperations
protected TableEditFragment	tableEditFragment
protected InstanceContainer<ReportTemplate>	templateDc
protected SourceCodeEditor	templateFileEditor
protected Label<String>	templateFileLabel
protected TemporaryStorage	temporaryStorage
protected WindowConfig	windowConfig

Fields inherited from class io.jmix.ui.screen.StandardEditor

commitActionPerformed, showEnableEditingBtn, showSaveNotification

Fields inherited from interface io.jmix.ui.screen.EditorScreen

ENABLE_EDITING, WINDOW_CLOSE, WINDOW_COMMIT, WINDOW_COMMIT_AND_CLOSE

Fields inherited from interface io.jmix.ui.screen.FrameOwner

NO_OPTIONS, WINDOW_CLOSE_ACTION, WINDOW_COMMIT_AND_CLOSE_ACTION, WINDOW_DISCARD_AND_CLOSE_ACTION

Constructor Summary

Constructors

Constructor	Description
TemplateEditor()

Method Summary

Modifier and Type	Method	Description
protected Collection<DescriptionEditFragment>	getDescriptionEditFragments()
protected boolean	hasChartTemplateOutput(ReportOutputType reportOutputType)
protected boolean	hasHtmlCsvTemplateOutput(ReportOutputType reportOutputType)
protected boolean	hasScriptCustomDefinedBy(CustomTemplateDefinedBy customTemplateDefinedBy)
protected boolean	hasTemplateOutput(ReportOutputType reportOutputType)
protected void	initNewItem(StandardEditor.InitEntityEvent<ReportTemplate> event)
protected void	initOutputTypeList()
protected void	initTemplateEditor(ReportTemplate reportTemplate)
protected void	initUploadField()
protected boolean	isUpdatePermitted(ReportTemplate reportTemplate)
protected void	onAfterInit(Screen.AfterInitEvent event)
protected void	onBeforeCommit(StandardEditor.BeforeCommitChangesEvent event)
protected void	onBeforeShow(Screen.BeforeShowEvent event)
void	onCustomDefinitionHelpLinkButtonClick(Button.ClickEvent event)
protected void	onInit(Screen.InitEvent event)
protected void	onTemplateUploadFieldFileUploadError(UploadField.FileUploadErrorEvent event)
protected void	onTemplateUploadFieldFileUploadStart(UploadField.FileUploadStartEvent event)
protected void	onTemplateUploadFieldFileUploadSucceed(SingleFileUploadField.FileUploadSucceedEvent event)
protected void	outputNamePatternLabelContextHelpIconClickHandler(HasContextHelp.ContextHelpIconClickEvent contextHelpIconClickEvent)
protected void	setupTemplateTypeVisibility(boolean visibility)
protected void	setupVisibility(boolean customEnabled, ReportOutputType reportOutputType)
protected void	setupVisibilityDescriptionEdit(boolean customEnabled, ReportOutputType reportOutputType)
protected void	showGroovyScriptEditorDialog(Button.ClickEvent event)
protected void	updateOutputType()
protected boolean	validateInputOutputFormats()
protected boolean	validateTemplateFile()
protected void	visibleTemplateEditor(ReportOutputType outputType)

Methods inherited from class io.jmix.ui.screen.StandardEditor

addAfterCommitChangesListener, addBeforeCommitChangesListener, addDefaultCloseAction, addDefaultCommitAction, addDefaultCommitAndCloseAction, addDefaultEnableEditingAction, addInitEntityListener, addValidationEventListener, cancel, closeWithCommit, closeWithDiscard, commit, commitAndClose, commitChanges, disableCommitActions, doNotReloadEditedEntity, enableEditing, getEditedEntity, getEditedEntityContainer, getEditedEntityLoader, getSaveNotificationCaption, getWindowActionOptional, hasUnsavedChanges, initActions, isCrossFieldValidate, isEntityModifiedInParentContext, isEntityModifiedRecursive, isLocked, isModifiedAfterOpen, isReadOnly, isReadOnlyDueToLock, isShowSaveNotification, onChangeEvent, onPostCommitEvent, preventUnsavedChanges, releaseLock, setCrossFieldValidate, setEntityToEdit, setModifiedAfterOpen, setReadOnly, setShowSaveNotification, setupEntityToEdit, setupLock, setupModifiedTracking, showSaveNotification, validateAdditionalRules, validateScreen, validateUiComponents

Methods inherited from class io.jmix.ui.screen.Screen

addAfterCloseListener, addAfterDetachListener, addAfterInitListener, addAfterShowListener, addBeforeCloseListener, addBeforeShowListener, addInitListener, addUrlParamsChangeListener, close, close, closeWithDefaultAction, fireEvent, getApplicationContext, getEventHub, getExtensions, getId, getScreenData, getUiEventListeners, getWindow, isMultipleOpen, isSameScreen, setApplicationContext, setExtensions, setId, setScreenData, setUiEventListeners, setWindow, show

Methods inherited from class java.lang.Object

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

Field Details

CUSTOM_DEFINE_BY

public static final String CUSTOM_DEFINE_BY

See Also:

• Constant Field Values

CUSTOM

public static final String CUSTOM

See Also:

• Constant Field Values

REPORT_OUTPUT_TYPE

public static final String REPORT_OUTPUT_TYPE

See Also:

• Constant Field Values

isCustomLabel

@Autowired
protected Label<String> isCustomLabel

customField

@Autowired
protected CheckBox customField

templateFileLabel

@Autowired
protected Label<String> templateFileLabel

isGroovyRadioButtonGroup

@Autowired
protected RadioButtonGroup<Boolean> isGroovyRadioButtonGroup

isGroovyLabel

@Autowired
protected Label<String> isGroovyLabel

customDefinitionField

@Autowired
protected TextArea<String> customDefinitionField

customDefinitionHelpLinkButton

@Autowired
protected LinkButton customDefinitionHelpLinkButton

fullScreenLinkButton

@Autowired
protected LinkButton fullScreenLinkButton

customDefinitionLabel

@Autowired
protected Label<String> customDefinitionLabel

customDefinedByField

@Autowired
protected ComboBox<CustomTemplateDefinedBy> customDefinedByField

customDefinedByLabel

@Autowired
protected Label<String> customDefinedByLabel

alterableField

@Autowired
protected CheckBox alterableField

alterableLabel

@Autowired
protected Label<String> alterableLabel

outputTypeField

@Autowired
protected ComboBox<ReportOutputType> outputTypeField

outputNamePatternField

@Autowired
protected TextField<String> outputNamePatternField

outputNamePatternLabel

@Autowired
protected Label<String> outputNamePatternLabel

chartEditFragment

@Autowired
protected ChartEditFragment chartEditFragment

pivotTableEditFragment

@Autowired
protected PivotTableEditFragment pivotTableEditFragment

tableEditFragment

@Autowired
protected TableEditFragment tableEditFragment

templateDc

@Autowired
protected InstanceContainer<ReportTemplate> templateDc

descriptionEditBox

@Autowired
protected BoxLayout descriptionEditBox

previewBox

@Autowired
protected BoxLayout previewBox

templateFileEditor

@Autowired
protected SourceCodeEditor templateFileEditor

windowConfig

@Autowired
protected WindowConfig windowConfig

metadata

@Autowired
protected Metadata metadata

secureOperations

@Autowired
protected SecureOperations secureOperations

policyStore

@Autowired
protected PolicyStore policyStore

temporaryStorage

@Autowired
protected TemporaryStorage temporaryStorage

screenBuilders

@Autowired
protected ScreenBuilders screenBuilders

dialogs

@Autowired
protected Dialogs dialogs

messages

@Autowired
protected Messages messages

messageBundle

@Autowired
protected MessageBundle messageBundle

notifications

@Autowired
protected Notifications notifications

Constructor Details

TemplateEditor

public TemplateEditor()

Method Details

onInit

@Subscribe
protected void onInit(Screen.InitEvent event)

outputNamePatternLabelContextHelpIconClickHandler

@Install(to="outputNamePatternLabel",
         subject="contextHelpIconClickHandler")
protected void outputNamePatternLabelContextHelpIconClickHandler(HasContextHelp.ContextHelpIconClickEvent contextHelpIconClickEvent)

initNewItem

@Subscribe
protected void initNewItem(StandardEditor.InitEntityEvent<ReportTemplate> event)

onAfterInit

@Subscribe
protected void onAfterInit(Screen.AfterInitEvent event)

hasScriptCustomDefinedBy

protected boolean hasScriptCustomDefinedBy(CustomTemplateDefinedBy customTemplateDefinedBy)

onBeforeShow

@Subscribe
protected void onBeforeShow(Screen.BeforeShowEvent event)

onTemplateUploadFieldFileUploadStart

@Subscribe("templateUploadField")
protected void onTemplateUploadFieldFileUploadStart(UploadField.FileUploadStartEvent event)

getDescriptionEditFragments

protected Collection<DescriptionEditFragment> getDescriptionEditFragments()

hasTemplateOutput

protected boolean hasTemplateOutput(ReportOutputType reportOutputType)

hasChartTemplateOutput

protected boolean hasChartTemplateOutput(ReportOutputType reportOutputType)

hasHtmlCsvTemplateOutput

protected boolean hasHtmlCsvTemplateOutput(@Nullable
 ReportOutputType reportOutputType)

setupVisibility

protected void setupVisibility(boolean customEnabled,
 ReportOutputType reportOutputType)

setupTemplateTypeVisibility

protected void setupTemplateTypeVisibility(boolean visibility)

setupVisibilityDescriptionEdit

protected void setupVisibilityDescriptionEdit(boolean customEnabled,
 ReportOutputType reportOutputType)

updateOutputType

protected void updateOutputType()

initOutputTypeList

protected void initOutputTypeList()

onTemplateUploadFieldFileUploadError

@Subscribe("templateUploadField")
protected void onTemplateUploadFieldFileUploadError(UploadField.FileUploadErrorEvent event)

onTemplateUploadFieldFileUploadSucceed

@Subscribe("templateUploadField")
protected void onTemplateUploadFieldFileUploadSucceed(SingleFileUploadField.FileUploadSucceedEvent event)

initUploadField

protected void initUploadField()

isUpdatePermitted

protected boolean isUpdatePermitted(ReportTemplate reportTemplate)

initTemplateEditor

protected void initTemplateEditor(ReportTemplate reportTemplate)

visibleTemplateEditor

protected void visibleTemplateEditor(@Nullable
 ReportOutputType outputType)

onBeforeCommit

@Subscribe
protected void onBeforeCommit(StandardEditor.BeforeCommitChangesEvent event)

validateInputOutputFormats

protected boolean validateInputOutputFormats()

validateTemplateFile

protected boolean validateTemplateFile()

showGroovyScriptEditorDialog

@Subscribe("fullScreenLinkButton")
protected void showGroovyScriptEditorDialog(Button.ClickEvent event)

onCustomDefinitionHelpLinkButtonClick

@Subscribe("customDefinitionHelpLinkButton")
public void onCustomDefinitionHelpLinkButtonClick(Button.ClickEvent event)