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:

io.jmix.ui.screen.ChangeTracker, io.jmix.ui.screen.EditorScreen<ReportTemplate>, io.jmix.ui.screen.FrameOwner, io.jmix.ui.screen.ReadOnlyAwareScreen

@UiController(value="report_ReportTemplate.edit")
 @UiDescriptor(value="template-edit.xml")
public class TemplateEditor
extends io.jmix.ui.screen.StandardEditor<ReportTemplate>

Nested Class Summary

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

io.jmix.ui.screen.StandardEditor.AfterCommitChangesEvent, io.jmix.ui.screen.StandardEditor.BeforeCommitChangesEvent, io.jmix.ui.screen.StandardEditor.InitEntityEvent<E>, io.jmix.ui.screen.StandardEditor.ValidationEvent

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

io.jmix.ui.screen.Screen.AfterCloseEvent, io.jmix.ui.screen.Screen.AfterDetachEvent, io.jmix.ui.screen.Screen.AfterInitEvent, io.jmix.ui.screen.Screen.AfterShowEvent, io.jmix.ui.screen.Screen.BeforeCloseEvent, io.jmix.ui.screen.Screen.BeforeShowEvent, io.jmix.ui.screen.Screen.InitEvent

Field Summary

Fields

Modifier and Type	Field and Description
protected io.jmix.ui.component.CheckBox	alterableField
protected io.jmix.ui.component.Label<java.lang.String>	alterableLabel
protected ChartEditFragment	chartEditFragment
static java.lang.String	CUSTOM
static java.lang.String	CUSTOM_DEFINE_BY
protected io.jmix.ui.component.ComboBox<CustomTemplateDefinedBy>	customDefinedByField
protected io.jmix.ui.component.Label<java.lang.String>	customDefinedByLabel
protected io.jmix.ui.component.TextArea<java.lang.String>	customDefinitionField
protected io.jmix.ui.component.LinkButton	customDefinitionHelpLinkButton
protected io.jmix.ui.component.Label<java.lang.String>	customDefinitionLabel
protected io.jmix.ui.component.CheckBox	customField
protected io.jmix.ui.component.BoxLayout	descriptionEditBox
protected io.jmix.ui.Dialogs	dialogs
protected io.jmix.ui.component.LinkButton	fullScreenLinkButton
protected io.jmix.ui.component.Label<java.lang.String>	isCustomLabel
protected io.jmix.ui.component.Label<java.lang.String>	isGroovyLabel
protected io.jmix.ui.component.RadioButtonGroup<java.lang.Boolean>	isGroovyRadioButtonGroup
protected io.jmix.core.Messages	messages
protected io.jmix.core.Metadata	metadata
protected io.jmix.ui.Notifications	notifications
protected io.jmix.ui.component.TextField<java.lang.String>	outputNamePatternField
protected io.jmix.ui.component.Label<java.lang.String>	outputNamePatternLabel
protected io.jmix.ui.component.ComboBox<ReportOutputType>	outputTypeField
protected PivotTableEditFragment	pivotTableEditFragment
protected io.jmix.security.constraint.PolicyStore	policyStore
protected io.jmix.ui.component.BoxLayout	previewBox
static java.lang.String	REPORT_OUTPUT_TYPE
protected io.jmix.ui.ScreenBuilders	screenBuilders
protected io.jmix.security.constraint.SecureOperations	secureOperations
protected TableEditFragment	tableEditFragment
protected io.jmix.ui.model.InstanceContainer<ReportTemplate>	templateDc
protected io.jmix.ui.component.SourceCodeEditor	templateFileEditor
protected io.jmix.ui.component.Label<java.lang.String>	templateFileLabel
protected io.jmix.ui.upload.TemporaryStorage	temporaryStorage
protected io.jmix.ui.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 and Description
TemplateEditor()

Method Summary

Modifier and Type	Method and Description
protected java.util.Collection<DescriptionEditFragment>	getDescriptionEditFragments()
protected boolean	hasChartTemplateOutput(ReportOutputType reportOutputType)
protected boolean	hasHtmlCsvTemplateOutput(ReportOutputType reportOutputType)
protected boolean	hasPdfTemplateOutput(ReportOutputType reportOutputType)
protected boolean	hasScriptCustomDefinedBy(CustomTemplateDefinedBy customTemplateDefinedBy)
protected boolean	hasTemplateOutput(ReportOutputType reportOutputType)
protected void	initNewItem(io.jmix.ui.screen.StandardEditor.InitEntityEvent<ReportTemplate> event)
protected void	initOutputTypeList()
protected void	initTemplateEditor(ReportTemplate reportTemplate)
protected void	initUploadField()
protected boolean	isUpdatePermitted(ReportTemplate reportTemplate)
protected void	onAfterInit(io.jmix.ui.screen.Screen.AfterInitEvent event)
protected void	onBeforeCommit(io.jmix.ui.screen.StandardEditor.BeforeCommitChangesEvent event)
protected void	onBeforeShow(io.jmix.ui.screen.Screen.BeforeShowEvent event)
void	onCustomDefinitionHelpLinkButtonClick(io.jmix.ui.component.Button.ClickEvent event)
protected void	onInit(io.jmix.ui.screen.Screen.InitEvent event)
protected void	onTemplateUploadFieldFileUploadError(io.jmix.ui.component.UploadField.FileUploadErrorEvent event)
protected void	onTemplateUploadFieldFileUploadStart(io.jmix.ui.component.UploadField.FileUploadStartEvent event)
protected void	onTemplateUploadFieldFileUploadSucceed(io.jmix.ui.component.SingleFileUploadField.FileUploadSucceedEvent event)
protected void	outputNamePatternLabelContextHelpIconClickHandler(io.jmix.ui.component.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(io.jmix.ui.component.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 Detail

CUSTOM_DEFINE_BY

public static final java.lang.String CUSTOM_DEFINE_BY

See Also:

Constant Field Values

CUSTOM

public static final java.lang.String CUSTOM

See Also:

Constant Field Values

REPORT_OUTPUT_TYPE

public static final java.lang.String REPORT_OUTPUT_TYPE

See Also:

Constant Field Values

isCustomLabel

@Autowired
protected io.jmix.ui.component.Label<java.lang.String> isCustomLabel

customField

@Autowired
protected io.jmix.ui.component.CheckBox customField

templateFileLabel

@Autowired
protected io.jmix.ui.component.Label<java.lang.String> templateFileLabel

isGroovyRadioButtonGroup

@Autowired
protected io.jmix.ui.component.RadioButtonGroup<java.lang.Boolean> isGroovyRadioButtonGroup

isGroovyLabel

@Autowired
protected io.jmix.ui.component.Label<java.lang.String> isGroovyLabel

customDefinitionField

@Autowired
protected io.jmix.ui.component.TextArea<java.lang.String> customDefinitionField

customDefinitionHelpLinkButton

@Autowired
protected io.jmix.ui.component.LinkButton customDefinitionHelpLinkButton

fullScreenLinkButton

@Autowired
protected io.jmix.ui.component.LinkButton fullScreenLinkButton

customDefinitionLabel

@Autowired
protected io.jmix.ui.component.Label<java.lang.String> customDefinitionLabel

customDefinedByField

@Autowired
protected io.jmix.ui.component.ComboBox<CustomTemplateDefinedBy> customDefinedByField

customDefinedByLabel

@Autowired
protected io.jmix.ui.component.Label<java.lang.String> customDefinedByLabel

alterableField

@Autowired
protected io.jmix.ui.component.CheckBox alterableField

alterableLabel

@Autowired
protected io.jmix.ui.component.Label<java.lang.String> alterableLabel

outputTypeField

@Autowired
protected io.jmix.ui.component.ComboBox<ReportOutputType> outputTypeField

outputNamePatternField

@Autowired
protected io.jmix.ui.component.TextField<java.lang.String> outputNamePatternField

outputNamePatternLabel

@Autowired
protected io.jmix.ui.component.Label<java.lang.String> outputNamePatternLabel

chartEditFragment

@Autowired
protected ChartEditFragment chartEditFragment

pivotTableEditFragment

@Autowired
protected PivotTableEditFragment pivotTableEditFragment

tableEditFragment

@Autowired
protected TableEditFragment tableEditFragment

templateDc

@Autowired
protected io.jmix.ui.model.InstanceContainer<ReportTemplate> templateDc

descriptionEditBox

@Autowired
protected io.jmix.ui.component.BoxLayout descriptionEditBox

previewBox

@Autowired
protected io.jmix.ui.component.BoxLayout previewBox

templateFileEditor

@Autowired
protected io.jmix.ui.component.SourceCodeEditor templateFileEditor

windowConfig

@Autowired
protected io.jmix.ui.WindowConfig windowConfig

metadata

@Autowired
protected io.jmix.core.Metadata metadata

secureOperations

@Autowired
protected io.jmix.security.constraint.SecureOperations secureOperations

policyStore

@Autowired
protected io.jmix.security.constraint.PolicyStore policyStore

temporaryStorage

@Autowired
protected io.jmix.ui.upload.TemporaryStorage temporaryStorage

screenBuilders

@Autowired
protected io.jmix.ui.ScreenBuilders screenBuilders

dialogs

@Autowired
protected io.jmix.ui.Dialogs dialogs

messages

@Autowired
protected io.jmix.core.Messages messages

notifications

@Autowired
protected io.jmix.ui.Notifications notifications

Constructor Detail

TemplateEditor

public TemplateEditor()

Method Detail

onInit

@Subscribe
protected void onInit(io.jmix.ui.screen.Screen.InitEvent event)

outputNamePatternLabelContextHelpIconClickHandler

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

initNewItem

@Subscribe
protected void initNewItem(io.jmix.ui.screen.StandardEditor.InitEntityEvent<ReportTemplate> event)

onAfterInit

@Subscribe
protected void onAfterInit(io.jmix.ui.screen.Screen.AfterInitEvent event)

hasScriptCustomDefinedBy

protected boolean hasScriptCustomDefinedBy(CustomTemplateDefinedBy customTemplateDefinedBy)

onBeforeShow

@Subscribe
protected void onBeforeShow(io.jmix.ui.screen.Screen.BeforeShowEvent event)

onTemplateUploadFieldFileUploadStart

@Subscribe(value="templateUploadField")
protected void onTemplateUploadFieldFileUploadStart(io.jmix.ui.component.UploadField.FileUploadStartEvent event)

getDescriptionEditFragments

protected java.util.Collection<DescriptionEditFragment> getDescriptionEditFragments()

hasTemplateOutput

protected boolean hasTemplateOutput(ReportOutputType reportOutputType)

hasChartTemplateOutput

protected boolean hasChartTemplateOutput(ReportOutputType reportOutputType)

hasPdfTemplateOutput

protected boolean hasPdfTemplateOutput(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(value="templateUploadField")
protected void onTemplateUploadFieldFileUploadError(io.jmix.ui.component.UploadField.FileUploadErrorEvent event)

onTemplateUploadFieldFileUploadSucceed

@Subscribe(value="templateUploadField")
protected void onTemplateUploadFieldFileUploadSucceed(io.jmix.ui.component.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(io.jmix.ui.screen.StandardEditor.BeforeCommitChangesEvent event)

validateInputOutputFormats

protected boolean validateInputOutputFormats()

validateTemplateFile

protected boolean validateTemplateFile()

showGroovyScriptEditorDialog

@Subscribe(value="fullScreenLinkButton")
protected void showGroovyScriptEditorDialog(io.jmix.ui.component.Button.ClickEvent event)

onCustomDefinitionHelpLinkButtonClick

@Subscribe(value="customDefinitionHelpLinkButton")
public void onCustomDefinitionHelpLinkButtonClick(io.jmix.ui.component.Button.ClickEvent event)