Package io.jmix.reportsui.screen.definition.edit

Class BandDefinitionEditor

java.lang.Object

io.jmix.ui.screen.ScreenFragment

io.jmix.reportsui.screen.definition.edit.BandDefinitionEditor

All Implemented Interfaces:

Suggester, FrameOwner

@UiController("report_BandDefinitionEditor.fragment")
@UiDescriptor("band-definition-edit-fragment.xml")
public class BandDefinitionEditor
extends ScreenFragment
implements Suggester

Nested Class Summary

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

ScreenFragment.AfterInitEvent, ScreenFragment.AttachEvent, ScreenFragment.DetachEvent, ScreenFragment.InitEvent

Field Summary

Fields

Modifier and Type	Field	Description
protected Actions	actions
protected CollectionContainer<BandDefinition>	bandsDc
protected Label<String>	buttonEmptyElement
protected Label<String>	checkboxEmptyElement
protected GridLayout	commonEntityGrid
protected DataContext	dataContext
protected DataSetFactory	dataSetFactory
protected BoxLayout	dataSetScriptBox
protected SourceCodeEditor	dataSetScriptField
protected SourceCodeEditor.Mode	dataSetScriptFieldMode
protected CollectionContainer<DataSet>	dataSetsDc
protected Table<DataSet>	dataSetsTable
protected ComboBox	dataStoreField
protected Dialogs	dialogs
protected EditFetchPlanAction	editFetchPlanAction
protected BoxLayout	editPane
protected ComboBox<String>	entitiesParamField
protected Label<String>	entitiesParamLabel
protected ComboBox<String>	entityParamField
protected Label<String>	entityParamLabel
protected Button	fetchPlanEditButton
protected ComboBox<String>	fetchPlanNameField
protected Label<String>	fetchPlanNameLabel
protected FetchPlanRepository	fetchPlanRepository
protected CheckBox	isProcessTemplateField
protected CheckBox	isUseExistingFetchPlanField
protected JpqlUiSuggestionProvider	jpqlUiSuggestionProvider
protected VBoxLayout	jsonDataSetTypeVBox
protected SourceCodeEditor	jsonGroovyCodeEditor
protected Label<String>	jsonPathQueryLabel
protected TextArea<String>	jsonPathQueryTextAreaField
protected VBoxLayout	jsonSourceGroovyCodeVBox
protected VBoxLayout	jsonSourceParameterCodeVBox
protected ComboBox<JsonSourceType>	jsonSourceTypeField
protected VBoxLayout	jsonSourceURLVBox
protected MessageBundle	messageBundle
protected Metadata	metadata
protected MetadataTools	metadataTools
protected TextField<String>	nameField
protected ComboBox<Orientation>	orientationField
protected CollectionContainer<ReportInputParameter>	parametersDc
protected ComboBox<BandDefinition>	parentBandField
protected PolicyStore	policyStore
protected InstanceContainer<Report>	reportDc
protected ReportsClientProperties	reportsClientProperties
protected ReportsWizard	reportWizardService
protected ScreenBuilders	screenBuilders
protected SecureOperations	secureOperations
protected Label<String>	spacerLabel
protected Stores	stores
protected CrossTabTableDecorator	tabOrientationTableDecorator
protected HBoxLayout	textParamsBox

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
BandDefinitionEditor()

Method Summary

Modifier and Type	Method	Description
protected void	applyVisibilityRules(DataSet item)
protected void	applyVisibilityRulesForEntityType(DataSet item)
protected void	applyVisibilityRulesForType(DataSet dataSet)
protected boolean	dataSetsCreateEnabledRule()
protected String	findEmbeddedParameterMetaClassByAlias(String alias)
protected String	findParameterMetaClassByAlias(String alias)
InstanceContainer<BandDefinition>	getBandDefinitionDc()
protected String	getScriptEditorDialogCaption()
List<Suggestion>	getSuggestions(AutoCompleteSupport source, String text, int cursorPosition)
protected void	hideAllDataSetEditComponents()
protected void	initActions()
protected void	initDataSetListeners()
protected void	initDataStoreField()
protected void	initJsonDataSetOptions(DataSet dataSet)
protected void	initSourceCodeOptions()
protected boolean	isFetchPlanEditAllowed(DataSet dataSet)
protected boolean	isUpdatePermitted()
protected void	jsonGroovyCodeEditorContextHelpIconClickHandler(HasContextHelp.ContextHelpIconClickEvent contextHelpIconClickEvent)
protected void	jsonPathQueryTextAreaFieldContextHelpIconClickHandler(HasContextHelp.ContextHelpIconClickEvent contextHelpIconClickEvent)
protected void	onBandsDcItemChange(InstanceContainer.ItemChangeEvent<BandDefinition> event)
protected void	onBandsDcItemPropertyChange(InstanceContainer.ItemPropertyChangeEvent<BandDefinition> event)
protected void	onDataSetsCreate(Action.ActionPerformedEvent event)
protected void	onDataSetsDcItemChange(InstanceContainer.ItemChangeEvent<DataSet> event)
protected void	onDataSetsDcItemPropertyChange(InstanceContainer.ItemPropertyChangeEvent<DataSet> event)
protected void	onInit(ScreenFragment.InitEvent event)
protected void	onParametersDcCollectionChange(CollectionContainer.CollectionChangeEvent<ReportInputParameter> event)
protected void	refreshFetchPlanNames(String currentFetchPlanName, String paramName)
protected void	selectFirstDataSet()
protected void	setCommonEntityGridVisibility(boolean visibleEntityGrid, boolean visibleEntitiesGrid)
void	setEnabled(boolean enabled)
protected void	setFetchPlanEditVisibility(DataSet dataSet)
protected void	showDataSetScriptEditorDialog(Button.ClickEvent event)
protected void	showJsonScriptEditorDialog(Button.ClickEvent event)
protected void	updateRequiredIndicators(BandDefinition item)

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

addAfterInitListener, addAttachEventListener, addDetachEventListener, addInitListener, fireEvent, getApplicationContext, getEventHub, getExtensions, getFragment, getHostController, getHostScreen, getId, getScreenData, getUiEventListeners, init, setApplicationContext, setExtensions, setFragment, setHostController, setId, setScreenData, setUiEventListeners

Methods inherited from class java.lang.Object

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

Field Details

bandsDc

@Autowired
protected CollectionContainer<BandDefinition> bandsDc

dataSetsDc

@Autowired
protected CollectionContainer<DataSet> dataSetsDc

reportDc

@Autowired
protected InstanceContainer<Report> reportDc

parametersDc

@Autowired
protected CollectionContainer<ReportInputParameter> parametersDc

dataSetsTable

@Autowired
protected Table<DataSet> dataSetsTable

dataSetScriptField

@Autowired
protected SourceCodeEditor dataSetScriptField

jsonGroovyCodeEditor

@Autowired
protected SourceCodeEditor jsonGroovyCodeEditor

dataSetScriptBox

@Autowired
protected BoxLayout dataSetScriptBox

entitiesParamLabel

@Autowired
protected Label<String> entitiesParamLabel

entityParamLabel

@Autowired
protected Label<String> entityParamLabel

commonEntityGrid

@Autowired
protected GridLayout commonEntityGrid

jsonSourceTypeField

@Autowired
protected ComboBox<JsonSourceType> jsonSourceTypeField

jsonDataSetTypeVBox

@Autowired
protected VBoxLayout jsonDataSetTypeVBox

jsonPathQueryLabel

@Autowired
protected Label<String> jsonPathQueryLabel

jsonSourceGroovyCodeVBox

@Autowired
protected VBoxLayout jsonSourceGroovyCodeVBox

jsonSourceURLVBox

@Autowired
protected VBoxLayout jsonSourceURLVBox

jsonSourceParameterCodeVBox

@Autowired
protected VBoxLayout jsonSourceParameterCodeVBox

textParamsBox

@Autowired
protected HBoxLayout textParamsBox

fetchPlanNameLabel

@Autowired
protected Label<String> fetchPlanNameLabel

orientationField

@Autowired
protected ComboBox<Orientation> orientationField

parentBandField

@Autowired
protected ComboBox<BandDefinition> parentBandField

nameField

@Autowired
protected TextField<String> nameField

fetchPlanNameField

@Autowired
protected ComboBox<String> fetchPlanNameField

entitiesParamField

@Autowired
protected ComboBox<String> entitiesParamField

entityParamField

@Autowired
protected ComboBox<String> entityParamField

dataStoreField

@Autowired
protected ComboBox dataStoreField

isProcessTemplateField

@Autowired
protected CheckBox isProcessTemplateField

isUseExistingFetchPlanField

@Autowired
protected CheckBox isUseExistingFetchPlanField

fetchPlanEditButton

@Autowired
protected Button fetchPlanEditButton

buttonEmptyElement

@Autowired
protected Label<String> buttonEmptyElement

checkboxEmptyElement

@Autowired
protected Label<String> checkboxEmptyElement

spacerLabel

@Autowired
protected Label<String> spacerLabel

metadata

@Autowired
protected Metadata metadata

reportWizardService

@Autowired
protected ReportsWizard reportWizardService

editPane

@Autowired
protected BoxLayout editPane

dataSetFactory

@Autowired
protected DataSetFactory dataSetFactory

tabOrientationTableDecorator

@Autowired
protected CrossTabTableDecorator tabOrientationTableDecorator

fetchPlanRepository

@Autowired
protected FetchPlanRepository fetchPlanRepository

secureOperations

@Autowired
protected SecureOperations secureOperations

policyStore

@Autowired
protected PolicyStore policyStore

jsonPathQueryTextAreaField

@Autowired
protected TextArea<String> jsonPathQueryTextAreaField

jpqlUiSuggestionProvider

@Autowired
protected JpqlUiSuggestionProvider jpqlUiSuggestionProvider

stores

@Autowired
protected Stores stores

reportsClientProperties

@Autowired
protected ReportsClientProperties reportsClientProperties

messageBundle

@Autowired
protected MessageBundle messageBundle

dialogs

@Autowired
protected Dialogs dialogs

screenBuilders

@Autowired
protected ScreenBuilders screenBuilders

actions

@Autowired
protected Actions actions

metadataTools

@Autowired
protected MetadataTools metadataTools

dataContext

@Autowired
protected DataContext dataContext

dataSetScriptFieldMode

protected SourceCodeEditor.Mode dataSetScriptFieldMode

editFetchPlanAction

protected EditFetchPlanAction editFetchPlanAction

Constructor Details

BandDefinitionEditor

public BandDefinitionEditor()

Method Details

showJsonScriptEditorDialog

@Subscribe("jsonSourceGroovyCodeLinkBtn")
protected void showJsonScriptEditorDialog(Button.ClickEvent event)

getScriptEditorDialogCaption

protected String getScriptEditorDialogCaption()

showDataSetScriptEditorDialog

@Subscribe("dataSetTextLinkBtn")
protected void showDataSetScriptEditorDialog(Button.ClickEvent event)

getBandDefinitionDc

public InstanceContainer<BandDefinition> getBandDefinitionDc()

setEnabled

public void setEnabled(boolean enabled)

getSuggestions

public List<Suggestion> getSuggestions(AutoCompleteSupport source,
 String text,
 int cursorPosition)

Specified by:

getSuggestions in interface Suggester

onInit

@Subscribe
protected void onInit(ScreenFragment.InitEvent event)

jsonGroovyCodeEditorContextHelpIconClickHandler

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

jsonPathQueryTextAreaFieldContextHelpIconClickHandler

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

initSourceCodeOptions

protected void initSourceCodeOptions()

initJsonDataSetOptions

protected void initJsonDataSetOptions(DataSet dataSet)

initDataStoreField

protected void initDataStoreField()

onDataSetsCreate

@Subscribe("dataSetsTable.create")
protected void onDataSetsCreate(Action.ActionPerformedEvent event)

dataSetsCreateEnabledRule

@Install(to="dataSetsTable.create",
         subject="enabledRule")
protected boolean dataSetsCreateEnabledRule()

initActions

protected void initActions()

onParametersDcCollectionChange

@Subscribe(id="parametersDc",
           target=DATA_CONTAINER)
protected void onParametersDcCollectionChange(CollectionContainer.CollectionChangeEvent<ReportInputParameter> event)

onBandsDcItemPropertyChange

@Subscribe(id="bandsDc",
           target=DATA_CONTAINER)
protected void onBandsDcItemPropertyChange(InstanceContainer.ItemPropertyChangeEvent<BandDefinition> event)

onBandsDcItemChange

@Subscribe(id="bandsDc",
           target=DATA_CONTAINER)
protected void onBandsDcItemChange(InstanceContainer.ItemChangeEvent<BandDefinition> event)

onDataSetsDcItemChange

@Subscribe(id="dataSetsDc",
           target=DATA_CONTAINER)
protected void onDataSetsDcItemChange(InstanceContainer.ItemChangeEvent<DataSet> event)

onDataSetsDcItemPropertyChange

@Subscribe(id="dataSetsDc",
           target=DATA_CONTAINER)
protected void onDataSetsDcItemPropertyChange(InstanceContainer.ItemPropertyChangeEvent<DataSet> event)

initDataSetListeners

protected void initDataSetListeners()

isUpdatePermitted

protected boolean isUpdatePermitted()

updateRequiredIndicators

protected void updateRequiredIndicators(@Nullable
 BandDefinition item)

findParameterMetaClassByAlias

@Nullable
protected String findParameterMetaClassByAlias(String alias)

findEmbeddedParameterMetaClassByAlias

@Nullable
protected String findEmbeddedParameterMetaClassByAlias(String alias)

refreshFetchPlanNames

protected void refreshFetchPlanNames(@Nullable
 String currentFetchPlanName,
 String paramName)

applyVisibilityRules

protected void applyVisibilityRules(DataSet item)

applyVisibilityRulesForType

protected void applyVisibilityRulesForType(DataSet dataSet)

applyVisibilityRulesForEntityType

protected void applyVisibilityRulesForEntityType(DataSet item)

hideAllDataSetEditComponents

protected void hideAllDataSetEditComponents()

selectFirstDataSet

protected void selectFirstDataSet()

setFetchPlanEditVisibility

protected void setFetchPlanEditVisibility(DataSet dataSet)

isFetchPlanEditAllowed

protected boolean isFetchPlanEditAllowed(DataSet dataSet)

setCommonEntityGridVisibility

protected void setCommonEntityGridVisibility(boolean visibleEntityGrid,
 boolean visibleEntitiesGrid)