Package io.jmix.ui.app.bulk

Class BulkEditorWindow<E>

java.lang.Object

io.jmix.ui.screen.Screen

io.jmix.ui.app.bulk.BulkEditorWindow<E>

All Implemented Interfaces:

BulkEditorController<E>, FrameOwner

@UiController("bulkEditorWindow")
@UiDescriptor("bulk-editor-window.xml")
public class BulkEditorWindow<E>
extends Screen
implements BulkEditorController<E>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	BulkEditorWindow.ManagedField

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

Nested classes/interfaces inherited from interface io.jmix.ui.app.bulk.BulkEditorController

BulkEditorController.BulkEditorContext<V>

Field Summary

Fields

Modifier and Type	Field	Description
protected AccessManager	accessManager
protected Button	applyButton
protected Action	applyChanges
protected BulkEditorDataService	bulkEditorDataService
protected static final String	COLUMN_COUNT_STYLENAME
protected boolean	commitPerformed
protected BulkEditorController.BulkEditorContext<E>	context
protected DataComponents	dataComponents
protected Map<String,Field<?>>	dataFields
protected DataManager	dataManager
protected static final ColumnsMode	DEFAULT_COLUMNS_MODE
protected DeviceInfoProvider	deviceInfoProvider
protected Dialogs	dialogs
protected Pattern	excludeRegex
protected FetchPlanRepository	fetchPlanRepository
protected FetchPlans	fetchPlans
protected ScrollBoxLayout	fieldsScrollBox
protected Label<String>	infoLabel
protected InstanceContainer<E>	instanceContainer
protected List<E>	items
protected List<String>	managedEmbeddedProperties
protected Map<String,BulkEditorWindow.ManagedField>	managedFields
protected MessageBundle	messageBundle
protected Messages	messages
protected MessageTools	messageTools
protected Metadata	metadata
protected MetadataTools	metadataTools
protected Notifications	notifications
protected ScreenValidation	screenValidation
protected UiComponents	uiComponents
protected UiComponentsGenerator	uiComponentsGenerator

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

Method Summary

Modifier and Type	Method	Description
protected void	addFetchPlanProperties(FetchPlanBuilder builder, MetaProperty metaProperty, String fqn)
protected void	applyModelValidators(ValidationErrors errors)
void	closeWithCommit()
OperationResult	closeWithDiscard()
protected void	commitBulkChanges()
protected Button	createClearButton()
protected Consumer<Button.ClickEvent>	createClearButtonClickListener(Field<?> editField)
protected ComponentContainer	createColumnLayout()
protected void	createDataComponents()
protected FetchPlan	createEmbeddedFetchPlan(MetaClass metaClass, String fqnPrefix)
protected void	createEmbeddedFields(MetaClass metaClass, Object item, String fqnPrefix)
protected FetchPlan	createFetchPlan(MetaClass metaClass)
protected Field<?>	createField(MetaProperty metaProperty, InstanceContainer<?> fieldDc)
protected ComponentContainer	createFieldsLayout()
protected Label<String>	createLabel(BulkEditorWindow.ManagedField field)
protected Comparator<BulkEditorWindow.ManagedField>	createManagedFieldComparator(List<BulkEditorWindow.ManagedField> editFields)
protected void	createNestedDataContainers(MetaClass metaClass, InstanceContainer<?> parent, String fqnPrefix)
protected ComponentContainer	createRow(List<BulkEditorWindow.ManagedField> editFields, int fieldIndex)
protected ComponentContainer	createRowLayout()
protected void	ensureEmbeddedPropertyCreated(E item, String propertyPath)
protected void	focusFirstPossibleField(Map<String,Field<?>> dataFields)
protected String	generateFqn(MetaProperty metaProperty, String fqnPrefix)
protected String	generatePropertyCaption(MetaClass metaClass, MetaProperty metaProperty, String localePrefix)
protected ColumnsMode	getColumnsMode()
protected int	getFieldsCountForColumn(int remainFields, int remainColumns)
protected List<BulkEditorWindow.ManagedField>	getManagedFields()
protected List<BulkEditorWindow.ManagedField>	getManagedFields(MetaClass metaClass, String fqnPrefix, String localePrefix)
protected List<BulkEditorWindow.ManagedField>	getManagedFields(MetaProperty embeddedProperty, String fqnPrefix, String localePrefix)
protected boolean	hasChanges()
protected boolean	isByteArray(MetaProperty metaProperty)
protected boolean	isCrossDataStoreReference(MetaProperty metaProperty)
protected boolean	isEntityAttributeModifyPermitted(MetaClass metaClass, MetaProperty metaProperty)
protected boolean	isEntityPickerWrapperNeeded(Field<?> field)
protected boolean	isFieldChanged(Field<?> field)
protected boolean	isManagedAttribute(MetaClass metaClass, MetaProperty metaProperty)
protected boolean	isRangeClassPermitted(MetaProperty metaProperty)
protected boolean	isTenantMetaProperty(MetaProperty metaProperty)
protected boolean	isUuid(MetaProperty metaProperty)
protected List<E>	loadItems(FetchPlan fetchPlan)
protected void	onApplyChanges(Action.ActionPerformedEvent event)
protected void	onBeforeClose(Screen.BeforeCloseEvent event)
protected void	onCancelChanges(Action.ActionPerformedEvent event)
protected void	preventUnsavedChanges(Screen.BeforeCloseEvent event)
void	setBulkEditorContext(BulkEditorController.BulkEditorContext<E> context)
protected void	showConfirmDialogOrCommit(List<String> fields)
protected void	updateItemValues(Map.Entry<String,Field<?>> fieldEntry, Object value)
protected ValidationErrors	validateScreen()
protected ValidationErrors	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, isScreenAction, 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

COLUMN_COUNT_STYLENAME

protected static final String COLUMN_COUNT_STYLENAME

See Also:

• Constant Field Values

DEFAULT_COLUMNS_MODE

protected static final ColumnsMode DEFAULT_COLUMNS_MODE

applyButton

@Autowired
protected Button applyButton

applyChanges

@Autowired
protected Action applyChanges

infoLabel

@Autowired
protected Label<String> infoLabel

fieldsScrollBox

@Autowired
protected ScrollBoxLayout fieldsScrollBox

accessManager

@Autowired
protected AccessManager accessManager

bulkEditorDataService

@Autowired
protected BulkEditorDataService bulkEditorDataService

dataComponents

@Autowired
protected DataComponents dataComponents

dataManager

@Autowired
protected DataManager dataManager

deviceInfoProvider

@Autowired
protected DeviceInfoProvider deviceInfoProvider

dialogs

@Autowired
protected Dialogs dialogs

fetchPlans

@Autowired
protected FetchPlans fetchPlans

fetchPlanRepository

@Autowired
protected FetchPlanRepository fetchPlanRepository

messages

@Autowired
protected Messages messages

messageTools

@Autowired
protected MessageTools messageTools

messageBundle

@Autowired
protected MessageBundle messageBundle

metadata

@Autowired
protected Metadata metadata

metadataTools

@Autowired
protected MetadataTools metadataTools

notifications

@Autowired
protected Notifications notifications

screenValidation

@Autowired
protected ScreenValidation screenValidation

uiComponents

@Autowired
protected UiComponents uiComponents

uiComponentsGenerator

@Autowired
protected UiComponentsGenerator uiComponentsGenerator

context

protected BulkEditorController.BulkEditorContext<E> context

excludeRegex

protected Pattern excludeRegex

managedFields

protected Map<String,BulkEditorWindow.ManagedField> managedFields

managedEmbeddedProperties

protected List<String> managedEmbeddedProperties

dataFields

protected Map<String,Field<?>> dataFields

instanceContainer

protected InstanceContainer<E> instanceContainer

items

protected List<E> items

commitPerformed

protected boolean commitPerformed

Constructor Details

BulkEditorWindow

public BulkEditorWindow()

Method Details

setBulkEditorContext

public void setBulkEditorContext(BulkEditorController.BulkEditorContext<E> context)

Specified by:

setBulkEditorContext in interface BulkEditorController<E>

createDataComponents

protected void createDataComponents()

createRow

protected ComponentContainer createRow(List<BulkEditorWindow.ManagedField> editFields,
 int fieldIndex)

createClearButtonClickListener

protected Consumer<Button.ClickEvent> createClearButtonClickListener(Field<?> editField)

createClearButton

protected Button createClearButton()

createField

protected Field<?> createField(MetaProperty metaProperty,
 InstanceContainer<?> fieldDc)

createLabel

protected Label<String> createLabel(BulkEditorWindow.ManagedField field)

createRowLayout

protected ComponentContainer createRowLayout()

createColumnLayout

protected ComponentContainer createColumnLayout()

getColumnsMode

protected ColumnsMode getColumnsMode()

createFieldsLayout

protected ComponentContainer createFieldsLayout()

focusFirstPossibleField

protected void focusFirstPossibleField(Map<String,Field<?>> dataFields)

createManagedFieldComparator

protected Comparator<BulkEditorWindow.ManagedField> createManagedFieldComparator(List<BulkEditorWindow.ManagedField> editFields)

getFieldsCountForColumn

protected int getFieldsCountForColumn(int remainFields,
 int remainColumns)

isEntityPickerWrapperNeeded

protected boolean isEntityPickerWrapperNeeded(Field<?> field)

createNestedDataContainers

protected void createNestedDataContainers(MetaClass metaClass,
 InstanceContainer<?> parent,
 @Nullable
 String fqnPrefix)

loadItems

protected List<E> loadItems(FetchPlan fetchPlan)

createFetchPlan

protected FetchPlan createFetchPlan(MetaClass metaClass)

createEmbeddedFetchPlan

protected FetchPlan createEmbeddedFetchPlan(MetaClass metaClass,
 String fqnPrefix)

addFetchPlanProperties

protected void addFetchPlanProperties(FetchPlanBuilder builder,
 MetaProperty metaProperty,
 String fqn)

createEmbeddedFields

protected void createEmbeddedFields(MetaClass metaClass,
 Object item,
 @Nullable
 String fqnPrefix)

generateFqn

protected String generateFqn(MetaProperty metaProperty,
 @Nullable
 String fqnPrefix)

getManagedFields

protected List<BulkEditorWindow.ManagedField> getManagedFields()

getManagedFields

protected List<BulkEditorWindow.ManagedField> getManagedFields(MetaProperty embeddedProperty,
 String fqnPrefix,
 String localePrefix)

getManagedFields

protected List<BulkEditorWindow.ManagedField> getManagedFields(MetaClass metaClass,
 @Nullable
 String fqnPrefix,
 @Nullable
 String localePrefix)

generatePropertyCaption

protected String generatePropertyCaption(MetaClass metaClass,
 MetaProperty metaProperty,
 @Nullable
 String localePrefix)

isManagedAttribute

protected boolean isManagedAttribute(MetaClass metaClass,
 MetaProperty metaProperty)

isCrossDataStoreReference

protected boolean isCrossDataStoreReference(MetaProperty metaProperty)

isEntityAttributeModifyPermitted

protected boolean isEntityAttributeModifyPermitted(MetaClass metaClass,
 MetaProperty metaProperty)

isRangeClassPermitted

protected boolean isRangeClassPermitted(MetaProperty metaProperty)

isByteArray

protected boolean isByteArray(MetaProperty metaProperty)

isUuid

protected boolean isUuid(MetaProperty metaProperty)

onCancelChanges

@Subscribe("cancelChanges")
protected void onCancelChanges(Action.ActionPerformedEvent event)

onBeforeClose

@Subscribe
protected void onBeforeClose(Screen.BeforeCloseEvent event)

preventUnsavedChanges

protected void preventUnsavedChanges(Screen.BeforeCloseEvent event)

hasChanges

protected boolean hasChanges()

closeWithDiscard

public OperationResult closeWithDiscard()

onApplyChanges

@Subscribe("applyChanges")
protected void onApplyChanges(Action.ActionPerformedEvent event)

closeWithCommit

public void closeWithCommit()

showConfirmDialogOrCommit

protected void showConfirmDialogOrCommit(List<String> fields)

commitBulkChanges

protected void commitBulkChanges()

updateItemValues

protected void updateItemValues(Map.Entry<String,Field<?>> fieldEntry,
 @Nullable
 Object value)

ensureEmbeddedPropertyCreated

protected void ensureEmbeddedPropertyCreated(E item,
 String propertyPath)

isFieldChanged

protected boolean isFieldChanged(Field<?> field)

validateScreen

protected ValidationErrors validateScreen()

validateUiComponents

protected ValidationErrors validateUiComponents()

applyModelValidators

protected void applyModelValidators(ValidationErrors errors)

isTenantMetaProperty

protected boolean isTenantMetaProperty(MetaProperty metaProperty)