com.haulmont.cuba.gui.app.core.bulk

Class BulkEditorWindow

java.lang.Object

com.haulmont.cuba.gui.screen.Screen

com.haulmont.cuba.gui.components.AbstractWindow

com.haulmont.cuba.gui.app.core.bulk.BulkEditorWindow

All Implemented Interfaces:

ActionsHolder, Component, Component.BelongToFrame, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.Wrapper, ComponentContainer, ExpandingLayout, Frame, Frame.Wrapper, HasMargin, HasSpacing, HasSubParts, HasWindowManager, OrderedContainer, SecuredActionsHolder, SupportsExpandRatio, Window, Window.Wrapper, ChangeTracker, LegacyFrame, FrameOwner

public class BulkEditorWindow
extends AbstractWindow

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	BulkEditorWindow.ManagedField

Nested classes/interfaces inherited from class com.haulmont.cuba.gui.screen.Screen

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

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.Window

Window.BeforeCloseEvent, Window.BeforeCloseWithCloseButtonEvent, Window.BeforeCloseWithShortcutEvent, Window.CloseListener, Window.CloseOrigin, Window.CloseWithCommitListener, Window.Committable, Window.ContentSwitchMode, Window.Editor<T extends Entity>, Window.HasFoldersPane, Window.HasUserIndicator, Window.HasWorkArea, Window.Lookup<T extends Entity>, Window.TopLevelWindow, Window.Wrapper

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.Frame

Frame.MessageMode, Frame.MessageType, Frame.NotificationType

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.ExpandingLayout

ExpandingLayout.ExpandDirection

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.Component

Component.Alignment, Component.BelongToFrame, Component.Disposable, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.OptionsStyleProvider

Field Summary

Fields

Modifier and Type	Field and Description
protected Button	applyButton
protected BulkEditorDataService	bulkEditorDataService
static java.lang.String	COLUMN_COUNT_STYLENAME
protected ColumnsMode	columnsMode
protected java.util.Map<java.lang.String,Field>	dataFields
protected Datasource<Entity>	datasource
protected java.util.Map<java.lang.String,Datasource<Entity>>	datasources
protected DataSupplier	dataSupplier
protected DeviceInfoProvider	deviceInfoProvider
protected DsContextImpl	dsContext
protected DynamicAttributes	dynamicAttributes
protected java.lang.String	exclude
protected java.util.regex.Pattern	excludeRegex
protected BulkEditors.FieldSorter	fieldSorter
protected ScrollBoxLayout	fieldsScrollBox
protected java.util.Map<java.lang.String,java.util.function.Consumer>	fieldValidators
protected java.util.List<java.lang.String>	includeProperties
protected Label<java.lang.String>	infoLabel
protected java.util.List<Entity>	items
protected boolean	loadDynamicAttributes
protected java.util.List<java.lang.String>	managedEmbeddedProperties
protected java.util.Map<java.lang.String,BulkEditorWindow.ManagedField>	managedFields
protected MessageTools	messageTools
protected MetaClass	metaClass
protected Metadata	metadata
protected MetadataTools	metadataTools
protected java.util.List<java.util.function.Consumer>	modelValidators
protected Security	security
protected java.util.Set<Entity>	selected
protected ThemeConstants	themeConstants
protected UiComponents	uiComponents
protected boolean	useConfirmDialog
protected ViewRepository	viewRepository

Fields inherited from class com.haulmont.cuba.gui.components.AbstractWindow

frame, messages, UNKNOWN_CLOSE_ACTION_ID

Fields inherited from interface com.haulmont.cuba.gui.components.Window

BROWSE_WINDOW_SUFFIX, CLOSE_ACTION_ID, COMMIT_ACTION_ID, CREATE_WINDOW_SUFFIX, EDITOR_WINDOW_SUFFIX, LOOKUP_WINDOW_SUFFIX, NAME, SELECT_ACTION_ID

Fields inherited from interface com.haulmont.cuba.gui.components.Component

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE, UNITS_PERCENTAGE, UNITS_PIXELS

Fields inherited from interface com.haulmont.cuba.gui.screen.FrameOwner

NO_OPTIONS, WINDOW_CLOSE_ACTION, WINDOW_COMMIT_AND_CLOSE_ACTION, WINDOW_DISCARD_AND_CLOSE_ACTION

Constructor Summary

Constructors

Constructor and Description
BulkEditorWindow()

Method Summary

Modifier and Type	Method and Description
void	applyChanges()
void	cancelChanges()
protected void	commitBulkChanges()
protected void	createDataComponents()
protected void	createEmbeddedFields(MetaClass metaClass, Entity item, java.lang.String fqnPrefix) Recursively instantiates the embedded properties.
protected View	createEmbeddedView(MetaClass meta, java.lang.String fqnPrefix)
protected void	createNestedEmbeddedDatasources(Datasource masterDs, MetaClass metaClass, java.lang.String fqnPrefix)
protected View	createView(MetaClass meta) Creates a view, loading only necessary properties.
protected void	ensureEmbeddedPropertyCreated(Entity item, java.lang.String propertyPath)
protected BulkEditorFieldFactory	getFieldFactory()
protected int	getFieldsCountForColumn(int remainFields, int remainColumns)
protected java.util.List<BulkEditorWindow.ManagedField>	getManagedFields(MetaClass metaClass)
protected java.util.List<BulkEditorWindow.ManagedField>	getManagedFields(MetaProperty embeddedProperty, java.lang.String fqnPrefix, java.lang.String localePrefix)
protected boolean	hasChanges()
void	init(java.util.Map<java.lang.String,java.lang.Object> params) Called by the framework after creation of all components and before showing the screen.
protected boolean	isByteArray(MetaProperty metaProperty)
protected boolean	isFieldChanged(Field field)
protected boolean	isManagedAttribute(MetaClass metaClass, MetaProperty metaProperty)
protected boolean	isManagedDynamicAttribute(MetaClass metaClass, MetaProperty metaProperty)
protected boolean	isPermitted(MetaClass metaClass, MetaProperty metaProperty)
protected boolean	isPickerFieldWrapperNeeded(Field field, DeviceInfo deviceInfo)
protected boolean	isRangeClassPermitted(MetaProperty metaProperty)
protected boolean	isUuid(MetaProperty metaProperty)
protected java.util.List<Entity>	loadItems(View view)
protected boolean	preClose(java.lang.String actionId) Hook to be implemented in subclasses.
protected void	showConfirmDialogOrCommit(java.util.List<java.lang.String> fields)

Methods inherited from class com.haulmont.cuba.gui.components.AbstractWindow

add, add, addAction, addAction, addBeforeWindowCloseListener, addFacet, addStyleName, addTimer, afterShow, applySettings, beforeClose, closeWithDiscard, deleteSettings, expand, expand, formatMessage, getAction, getActions, getActionsPermissions, getAlignment, getCaption, getCompanion, getComponent, getComponent, getComponent, getComponents, getComposition, getContentSwitchMode, getContext, getDescription, getDialogOptions, getDsContext, getExpandDirection, getExpandRatio, getFacet, getFacets, getFocusComponent, getFrame, getFrameOwner, getHeight, getHeightSizeUnit, getIcon, getMargin, getMaxHeight, getMaxWidth, getMessage, getMessagesPack, getMinHeight, getMinWidth, getOwnComponent, getOwnComponents, getOwnComponentsStream, getParent, getScreenHashCode, getSettings, getSpacing, getStyleName, getTimer, getWidth, getWidthSizeUnit, getWindowManager, getWrappedFrame, getWrappedWindow, getXmlDescriptor, handleValidationErrors, hasUnsavedChanges, indexOf, init, initEnableEditingActionStub, isAttributeAccessControlEnabled, isCloseable, isEnabled, isEnabledRecursive, isExpanded, isResponsive, isSameScreen, isValid, isVisible, isVisibleRecursive, postValidate, ready, remove, removeAction, removeAction, removeAll, removeAllActions, removeBeforeWindowCloseListener, removeFacet, removeStyleName, resetExpanded, saveSettings, setAlignment, setCaption, setCloseable, setCompanion, setContentSwitchMode, setDescription, setDsContext, setEnabled, setExpandRatio, setFocusComponent, setFrame, setHeight, setIcon, setIconFromSet, setId, setMargin, setMaxHeight, setMaxWidth, setMessagesPack, setMinHeight, setMinWidth, setParent, setResponsive, setSpacing, setStyleName, setVisible, setWidth, setWindow, setXmlDescriptor, showValidationErrors, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, validate, validate, validateAdditionalRules, validateAll, withUnwrapped, withUnwrappedComposition

Methods inherited from class com.haulmont.cuba.gui.screen.Screen

addAfterCloseListener, addAfterDetachListener, addAfterInitListener, addAfterShowListener, addBeforeCloseListener, addBeforeShowListener, addInitListener, addUrlParamsChangeListener, applyDataLoadingSettings, close, close, closeWithDefaultAction, fireEvent, getBeanLocator, getEventHub, getExtensions, getId, getScreenData, getUiEventListeners, getWindow, isMultipleOpen, isSaveScreenHistoryOnClose, isSaveSettingsOnClose, setBeanLocator, setExtensions, setScreenData, setUiEventListeners, show

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.haulmont.cuba.gui.components.Window

addBeforeCloseWithCloseButtonListener, addBeforeCloseWithShortcutListener, addCloseListener, addCloseWithCommitListener, addListener, close, close, closeAndRun, removeBeforeCloseWithCloseButtonListener, removeBeforeCloseWithShortcutListener, removeCloseListener, removeCloseWithCommitListener, removeListener

Methods inherited from interface com.haulmont.cuba.gui.components.Frame

getFacetNN

Methods inherited from interface com.haulmont.cuba.gui.components.OrderedContainer

getComponentNN

Methods inherited from interface com.haulmont.cuba.gui.components.ComponentContainer

add, focusFirstComponent, getComponentNN, remove

Methods inherited from interface com.haulmont.cuba.gui.components.Component

getHeightUnits, getId, getWidthUnits, isEnabledItself, isVisibleItself, requestFocus, setHeightAuto, setHeightFull, setSizeAuto, setSizeFull, setWidthAuto, setWidthFull

Methods inherited from interface com.haulmont.cuba.gui.components.HasMargin

setMargin, setMargin

Methods inherited from interface com.haulmont.cuba.gui.components.ActionsHolder

getActionNN, getSubPart

Methods inherited from interface com.haulmont.cuba.gui.components.HasWindowManager

openEditor, openEditor, openEditor, openEditor, openEditor, openEditor, openEditor, openFrame, openFrame, openLookup, openLookup, openLookup, openLookup, openWindow, openWindow, showMessageDialog, showNotification, showNotification, showNotification, showOptionDialog, showOptionDialog, showWebPage

Field Detail

COLUMN_COUNT_STYLENAME

public static final java.lang.String COLUMN_COUNT_STYLENAME

See Also:

Constant Field Values

viewRepository

@Inject
protected ViewRepository viewRepository

metadataTools

@Inject
protected MetadataTools metadataTools

messageTools

@Inject
protected MessageTools messageTools

metadata

@Inject
protected Metadata metadata

dataSupplier

@Inject
protected DataSupplier dataSupplier

uiComponents

@Inject
protected UiComponents uiComponents

security

@Inject
protected Security security

deviceInfoProvider

@Inject
protected DeviceInfoProvider deviceInfoProvider

bulkEditorDataService

@Inject
protected BulkEditorDataService bulkEditorDataService

dynamicAttributes

@Inject
protected DynamicAttributes dynamicAttributes

fieldsScrollBox

@Inject
protected ScrollBoxLayout fieldsScrollBox

infoLabel

@Inject
protected Label<java.lang.String> infoLabel

applyButton

@Inject
protected Button applyButton

themeConstants

@Inject
protected ThemeConstants themeConstants

metaClass

protected MetaClass metaClass

selected

protected java.util.Set<Entity> selected

exclude

protected java.lang.String exclude

includeProperties

protected java.util.List<java.lang.String> includeProperties

loadDynamicAttributes

protected boolean loadDynamicAttributes

useConfirmDialog

protected boolean useConfirmDialog

fieldValidators

protected java.util.Map<java.lang.String,java.util.function.Consumer> fieldValidators

modelValidators

protected java.util.List<java.util.function.Consumer> modelValidators

fieldSorter

protected BulkEditors.FieldSorter fieldSorter

columnsMode

protected ColumnsMode columnsMode

excludeRegex

protected java.util.regex.Pattern excludeRegex

dsContext

protected DsContextImpl dsContext

datasource

protected Datasource<Entity> datasource

datasources

protected java.util.Map<java.lang.String,Datasource<Entity>> datasources

managedFields

protected java.util.Map<java.lang.String,BulkEditorWindow.ManagedField> managedFields

dataFields

protected java.util.Map<java.lang.String,Field> dataFields

items

protected java.util.List<Entity> items

managedEmbeddedProperties

protected java.util.List<java.lang.String> managedEmbeddedProperties

Constructor Detail

BulkEditorWindow

public BulkEditorWindow()

Method Detail

init

public void init(java.util.Map<java.lang.String,java.lang.Object> params)

Description copied from class: AbstractWindow

Called by the framework after creation of all components and before showing the screen.
Override this method and put initialization logic here.

Overrides:

init in class AbstractWindow

Parameters:

params - parameters passed from caller's code, usually from HasWindowManager.openWindow(String, WindowManager.OpenType) and similar methods, or set in screens.xml for this registered screen

createDataComponents

protected void createDataComponents()

getFieldsCountForColumn

protected int getFieldsCountForColumn(int remainFields,
                                      int remainColumns)

isPickerFieldWrapperNeeded

protected boolean isPickerFieldWrapperNeeded(Field field,
                                             DeviceInfo deviceInfo)

getFieldFactory

protected BulkEditorFieldFactory getFieldFactory()

isByteArray

protected boolean isByteArray(MetaProperty metaProperty)

isUuid

protected boolean isUuid(MetaProperty metaProperty)

createEmbeddedFields

protected void createEmbeddedFields(MetaClass metaClass,
                                    Entity item,
                                    java.lang.String fqnPrefix)

Recursively instantiates the embedded properties. E.g. embedded properties of the embedded property will also be instantiated.

Parameters:

metaClass - meta class of the entity

item - entity instance

createNestedEmbeddedDatasources

protected void createNestedEmbeddedDatasources(Datasource masterDs,
                                               MetaClass metaClass,
                                               java.lang.String fqnPrefix)

createView

protected View createView(MetaClass meta)

Creates a view, loading only necessary properties. Referenced entities will be loaded with a MINIMAL view.

Parameters:

meta - meta class

Returns:

View instance

createEmbeddedView

protected View createEmbeddedView(MetaClass meta,
                                  java.lang.String fqnPrefix)

isPermitted

protected boolean isPermitted(MetaClass metaClass,
                              MetaProperty metaProperty)

isRangeClassPermitted

protected boolean isRangeClassPermitted(MetaProperty metaProperty)

isManagedDynamicAttribute

protected boolean isManagedDynamicAttribute(MetaClass metaClass,
                                            MetaProperty metaProperty)

isManagedAttribute

protected boolean isManagedAttribute(MetaClass metaClass,
                                     MetaProperty metaProperty)

getManagedFields

protected java.util.List<BulkEditorWindow.ManagedField> getManagedFields(MetaClass metaClass)

getManagedFields

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

preClose

protected boolean preClose(java.lang.String actionId)

Description copied from class: AbstractWindow

Hook to be implemented in subclasses. Called by the framework before closing the screen.

Overrides:

preClose in class AbstractWindow

Parameters:

actionId - a string that is passed to one of Screen.close(com.haulmont.cuba.gui.screen.CloseAction) methods by calling code to identify itself. Can be an Action ID, or a constant like Window.COMMIT_ACTION_ID or Window.CLOSE_ACTION_ID.

Returns:

true to proceed with closing, false to interrupt and leave the screen open

cancelChanges

public void cancelChanges()

hasChanges

protected boolean hasChanges()

isFieldChanged

protected boolean isFieldChanged(Field field)

applyChanges

public void applyChanges()

showConfirmDialogOrCommit

protected void showConfirmDialogOrCommit(java.util.List<java.lang.String> fields)

loadItems

protected java.util.List<Entity> loadItems(View view)

commitBulkChanges

protected void commitBulkChanges()

ensureEmbeddedPropertyCreated

protected void ensureEmbeddedPropertyCreated(Entity item,
                                             java.lang.String propertyPath)