Package io.jmix.datatoolsflowui.view.entityinspector

Class EntityInspectorListView

java.lang.Object

com.vaadin.flow.component.Component

com.vaadin.flow.component.Composite<T>

io.jmix.flowui.view.View<ViewLayout>

io.jmix.flowui.view.StandardView

io.jmix.flowui.view.StandardListView<Object>

io.jmix.datatoolsflowui.view.entityinspector.EntityInspectorListView

All Implemented Interfaces:

com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasStyle, com.vaadin.flow.router.AfterNavigationObserver, com.vaadin.flow.router.BeforeEnterObserver, com.vaadin.flow.router.BeforeLeaveObserver, com.vaadin.flow.router.HasDynamicTitle, com.vaadin.flow.router.internal.AfterNavigationHandler, com.vaadin.flow.router.internal.BeforeEnterHandler, com.vaadin.flow.router.internal.BeforeLeaveHandler, FragmentOwner, LookupView<Object>, MultiSelectLookupView, Serializable

@Route(value="datatl/entityinspector",
       layout=DefaultMainViewParent.class)
@ViewController("datatl_entityInspectorListView")
@ViewDescriptor("entity-inspector-list-view.xml")
@DialogMode(width="50em")
public class EntityInspectorListView
extends StandardListView<Object>

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static interface	EntityInspectorListView.DialogConsumer<T,U>
protected class	EntityInspectorListView.ExportAction

Nested classes/interfaces inherited from class io.jmix.flowui.view.View

View.AfterCloseEvent, View.BeforeCloseEvent, View.BeforeShowEvent, View.InitEvent, View.PostReadyEvent, View.QueryParametersChangeEvent, View.ReadyEvent, View.RestoreComponentsStateEvent

Nested classes/interfaces inherited from interface io.jmix.flowui.view.LookupView

LookupView.ValidationContext<E>

Field Summary

Fields

Modifier and Type	Field	Description
protected AccessManager	accessManager
protected Actions	actions
protected static final String	BASE_SELECT_QUERY
protected com.vaadin.flow.component.orderedlayout.HorizontalLayout	buttonsPanel
protected CoreProperties	coreProperties
protected DataComponents	dataComponents
protected DataManager	dataManager
protected DatatoolsUiProperties	datatoolsProperties
protected static final String	DELETED_ONLY_SELECT_QUERY
protected Dialogs	dialogs
protected Downloader	downloader
protected DataGrid<Object>	entitiesDataGrid
protected CollectionContainer	entitiesDc
protected CollectionLoader	entitiesDl
protected GenericFilter	entitiesGenericFilter
protected JmixComboBox<MetaClass>	entitiesLookup
protected EntityImportExport	entityImportExport
protected EntityImportPlans	entityImportPlans
protected String	entityName
protected EntityRestore	entityRestore
protected static final Set<String>	EXCLUDED_META_CLASS_NAMES
protected InspectorExportHelper	exportHelper
protected FetchPlanRepository	fetchPlanRepository
protected FetchPlans	fetchPlans
protected Pair<UrlQueryParametersFacet.Binder,com.vaadin.flow.shared.Registration>	filterQueryParametersChange
protected EntityImportPlanJsonBuilder	importPlanJsonBuilder
protected com.vaadin.flow.router.QueryParameters	initialParameters
protected boolean	isDialogMode
protected com.vaadin.flow.component.formlayout.FormLayout	lookupBox
protected MessageBundle	messageBundle
protected Messages	messages
protected MessageTools	messageTools
protected Metadata	metadata
protected MetadataTools	metadataTools
protected Notifications	notifications
protected Pair<UrlQueryParametersFacet.Binder,com.vaadin.flow.shared.Registration>	paginationQueryParametersChange
protected static final String	QUERY_PARAM_ENTITY
protected static final String	QUERY_PARAM_MODE
protected static final String	RESTORE_ACTION_ID
protected RouteSupport	routeSupport
protected JmixButton	selectButton
protected MetaClass	selectedMeta
protected com.vaadin.flow.component.select.Select<ShowMode>	showMode
protected UiComponents	uiComponents
protected UiProperties	uiProperties
protected UrlParamSerializer	urlParamSerializer
protected static final String	WIPE_OUT_ACTION_ID

Fields inherited from class io.jmix.flowui.view.StandardListView

DISCARD_ACTION_DEFAULT_ID, LOOKUP_ACTIONS_LAYOUT_DEFAULT_ID, SELECT_ACTION_DEFAULT_ID, selectionHandler, selectionValidator

Constructor Summary

Constructors

Constructor	Description
EntityInspectorListView()

Method Summary

Modifier and Type	Method	Description
void	beforeEnter(com.vaadin.flow.router.BeforeEnterEvent event)
void	beforeShow(View.BeforeShowEvent event)
protected void	collectFieldQueryParameters(Map<String,List<String>> parametersMap)
protected void	collectFilterQueryParameters(Map<String,List<String>> parametersMap, GenericFilterUrlQueryParametersBinder filterBinder)
protected void	collectPaginationQueryParameters(Map<String,List<String>> parametersMap, PaginationUrlQueryParametersBinder paginationBinder, SimplePagination pagination)
protected com.vaadin.flow.router.QueryParameters	collectQueryParameters(UrlQueryParametersFacet.Binder source)
protected CollectionContainer	createContainer(MetaClass meta)
protected CreateAction	createCreateAction(DataGrid<Object> dataGrid)
protected EditAction	createEditAction(DataGrid<Object> dataGrid)
protected void	createEntitiesDataGrid(MetaClass meta)
protected FetchPlan	createEntityExportPlan(MetaClass metaClass)
protected EntityImportPlan	createEntityImportPlan(MetaClass metaClass)
protected EntityImportPlan	createEntityImportPlan(String content, MetaClass metaClass)
protected GenericFilter	createGenericFilter()
protected LookupSelectAction	createLookupSelectAction(DataGrid<Object> dataGrid)
protected String	createMultiRowText(String text, int rowLength)
protected SimplePagination	createPagination()
protected UrlQueryParametersFacet.Binder	createQueryParametersBinder(Supplier<UrlQueryParametersFacet.Binder> binderFactory)
protected RefreshAction	createRefreshAction(DataGrid<Object> dataGrid)
protected RemoveAction	createRemoveAction(DataGrid<Object> dataGrid)
protected JmixButton	createRestoreButton(DataGrid<Object> dataGrid)
protected ShowEntityInfoAction	createShowEntityInfoAction(DataGrid<Object> dataGrid)
protected JmixButton	createWipeOutButton(DataGrid<?> dataGrid)
protected void	entitiesDataGridSelectionListener(com.vaadin.flow.data.selection.SelectionEvent<com.vaadin.flow.component.grid.Grid<Object>,Object> event)
protected void	entityChangeListener(com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.combobox.ComboBox<MetaClass>,MetaClass> valueChangeEvent)
Optional<LookupComponent<Object>>	findLookupComponent()
protected Map<MetaClass,String>	getEntitiesLookupFieldOptions()
LookupComponent<Object>	getLookupComponent()
protected void	initExcelExportAction(DataGrid<Object> dataGrid, Consumer<com.vaadin.flow.component.Component> addMethod)
protected Pair<UrlQueryParametersFacet.Binder,com.vaadin.flow.shared.Registration>	initQueryParametersBinder(Pair<UrlQueryParametersFacet.Binder,com.vaadin.flow.shared.Registration> parameterChangeRegistration, Supplier<UrlQueryParametersFacet.Binder> binderFactory)
void	onInit(View.InitEvent event)
void	onReady(View.ReadyEvent event)
protected void	onUrlQueryParametersChange(UrlQueryParametersFacet.UrlQueryParametersChangeEvent event)
protected boolean	readPermitted(MetaClass metaClass)
protected void	restoreOkHandler(ActionPerformedEvent actionPerformedEvent, Set<Object> entityList)
void	setEntityName(String entityName)
protected void	setShowMode(String showModeParameter)
protected void	showEntities()
protected void	showModeChangeListener(com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.select.Select<ShowMode>,ShowMode> valueChangeEvent)
protected void	showNotification(String message)
protected void	showOptionDialog(String header, String text, EntityInspectorListView.DialogConsumer<ActionPerformedEvent,Set<Object>> okEvent, Consumer<ActionPerformedEvent> cancelEvent, Set<Object> entityList)
protected void	showRestoreDialog()
protected void	showWipeOutDialog()
protected void	standardCancelHandler(ActionPerformedEvent actionPerformedEvent)
protected void	updateButtonsPanel(DataGrid<Object> dataGrid)
protected void	updateSelectAction(DataGrid<Object> dataGrid)
protected void	wipeOutOkHandler(ActionPerformedEvent actionPerformedEvent, Set<Object> entityList)

Methods inherited from class io.jmix.flowui.view.StandardListView

closeWithDiscard, doSelect, getDiscardAction, getLookupActionsLayout, getSelectAction, getSelectionHandler, getSelectionValidator, handleSelection, lookupEnterPress, setLookupComponentMultiSelect, setSelectionHandler, setSelectionValidator, setupLookupComponent, setupSaveShortcut, validateSelectedItems

Methods inherited from class io.jmix.flowui.view.StandardView

initContent

Methods inherited from class io.jmix.flowui.view.View

addAfterCloseListener, addBeforeCloseListener, addBeforeShowListener, addInitListener, addQueryParametersChangeListener, addReadyListener, addRestoreComponentsStateEventListener, afterNavigation, beforeLeave, close, close, closeWithDefaultAction, getApplicationContext, getEventBus, getId, getPageTitle, getReturnParameters, getViewActions, getViewAttributes, getViewData, getViewFacets, getViewSupport, isPreventBrowserTabClosing, onAttach, onDetach, onDetachInternal, removeApplicationListeners, removeViewAttributes, setAfterNavigationHandler, setApplicationContext, setId, setMeterRegistry, setPreventBrowserTabClosing, setViewActions, setViewData, setViewFacets, unregisterBackNavigation

Methods inherited from class com.vaadin.flow.component.Composite

getChildren, getContent, getElement

Methods inherited from class com.vaadin.flow.component.Component

addListener, findAncestor, fireEvent, from, get, getListeners, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onEnabledStateChanged, removeFromParent, scrollIntoView, scrollIntoView, set, setElement, setVisible

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vaadin.flow.component.AttachNotifier

addAttachListener

Methods inherited from interface com.vaadin.flow.component.DetachNotifier

addDetachListener

Methods inherited from interface com.vaadin.flow.component.HasStyle

addClassName, addClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassName

Field Details

BASE_SELECT_QUERY

protected static final String BASE_SELECT_QUERY

See Also:

• Constant Field Values

DELETED_ONLY_SELECT_QUERY

protected static final String DELETED_ONLY_SELECT_QUERY

See Also:

• Constant Field Values

RESTORE_ACTION_ID

protected static final String RESTORE_ACTION_ID

See Also:

• Constant Field Values

WIPE_OUT_ACTION_ID

protected static final String WIPE_OUT_ACTION_ID

See Also:

• Constant Field Values

QUERY_PARAM_ENTITY

protected static final String QUERY_PARAM_ENTITY

See Also:

• Constant Field Values

QUERY_PARAM_MODE

protected static final String QUERY_PARAM_MODE

See Also:

• Constant Field Values

EXCLUDED_META_CLASS_NAMES

protected static final Set<String> EXCLUDED_META_CLASS_NAMES

lookupBox

@ViewComponent
protected com.vaadin.flow.component.formlayout.FormLayout lookupBox

entitiesLookup

@ViewComponent
protected JmixComboBox<MetaClass> entitiesLookup

buttonsPanel

@ViewComponent
protected com.vaadin.flow.component.orderedlayout.HorizontalLayout buttonsPanel

showMode

@ViewComponent
protected com.vaadin.flow.component.select.Select<ShowMode> showMode

selectButton

@ViewComponent
protected JmixButton selectButton

messages

@Autowired
protected Messages messages

messageBundle

@Autowired
protected MessageBundle messageBundle

metadata

@Autowired
protected Metadata metadata

metadataTools

@Autowired
protected MetadataTools metadataTools

messageTools

@Autowired
protected MessageTools messageTools

accessManager

@Autowired
protected AccessManager accessManager

dataComponents

@Autowired
protected DataComponents dataComponents

fetchPlans

@Autowired
protected FetchPlans fetchPlans

fetchPlanRepository

@Autowired
protected FetchPlanRepository fetchPlanRepository

uiComponents

@Autowired
protected UiComponents uiComponents

uiProperties

@Autowired
protected UiProperties uiProperties

coreProperties

@Autowired
protected CoreProperties coreProperties

entityImportExport

@Autowired
protected EntityImportExport entityImportExport

importPlanJsonBuilder

@Autowired
protected EntityImportPlanJsonBuilder importPlanJsonBuilder

entityImportPlans

@Autowired
protected EntityImportPlans entityImportPlans

actions

@Autowired
protected Actions actions

dialogs

@Autowired
protected Dialogs dialogs

notifications

@Autowired
protected Notifications notifications

entityRestore

@Autowired
protected EntityRestore entityRestore

dataManager

@Autowired
protected DataManager dataManager

urlParamSerializer

@Autowired
protected UrlParamSerializer urlParamSerializer

routeSupport

@Autowired
protected RouteSupport routeSupport

downloader

@Autowired
protected Downloader downloader

datatoolsProperties

@Autowired
protected DatatoolsUiProperties datatoolsProperties

exportHelper

@Autowired(required=false)
protected InspectorExportHelper exportHelper

entitiesDataGrid

protected DataGrid<Object> entitiesDataGrid

entitiesGenericFilter

protected GenericFilter entitiesGenericFilter

filterQueryParametersChange

protected Pair<UrlQueryParametersFacet.Binder,com.vaadin.flow.shared.Registration> filterQueryParametersChange

paginationQueryParametersChange

protected Pair<UrlQueryParametersFacet.Binder,com.vaadin.flow.shared.Registration> paginationQueryParametersChange

initialParameters

protected com.vaadin.flow.router.QueryParameters initialParameters

selectedMeta

protected MetaClass selectedMeta

entitiesDl

protected CollectionLoader entitiesDl

entitiesDc

protected CollectionContainer entitiesDc

entityName

protected String entityName

isDialogMode

protected boolean isDialogMode

Constructor Details

EntityInspectorListView

public EntityInspectorListView()

Method Details

onInit

@Subscribe
public void onInit(View.InitEvent event)

beforeEnter

public void beforeEnter(com.vaadin.flow.router.BeforeEnterEvent event)

Specified by:

beforeEnter in interface com.vaadin.flow.router.internal.BeforeEnterHandler

Overrides:

beforeEnter in class View<ViewLayout>

beforeShow

@Subscribe
public void beforeShow(View.BeforeShowEvent event)

onReady

@Subscribe
public void onReady(View.ReadyEvent event)

getLookupComponent

public LookupComponent<Object> getLookupComponent()

Specified by:

getLookupComponent in interface LookupView<Object>

Overrides:

getLookupComponent in class StandardListView<Object>

Returns:

a component that is used to select entities of this view

findLookupComponent

public Optional<LookupComponent<Object>> findLookupComponent()

Specified by:

findLookupComponent in interface LookupView<Object>

Overrides:

findLookupComponent in class StandardListView<Object>

Returns:

an optional component that is used to select entities of this view

getEntitiesLookupFieldOptions

protected Map<MetaClass,String> getEntitiesLookupFieldOptions()

createEntitiesDataGrid

protected void createEntitiesDataGrid(MetaClass meta)

createGenericFilter

protected GenericFilter createGenericFilter()

createPagination

protected SimplePagination createPagination()

initQueryParametersBinder

protected Pair<UrlQueryParametersFacet.Binder,com.vaadin.flow.shared.Registration> initQueryParametersBinder(@Nullable
 Pair<UrlQueryParametersFacet.Binder,com.vaadin.flow.shared.Registration> parameterChangeRegistration,
 Supplier<UrlQueryParametersFacet.Binder> binderFactory)

createQueryParametersBinder

protected UrlQueryParametersFacet.Binder createQueryParametersBinder(Supplier<UrlQueryParametersFacet.Binder> binderFactory)

onUrlQueryParametersChange

protected void onUrlQueryParametersChange(UrlQueryParametersFacet.UrlQueryParametersChangeEvent event)

showEntities

protected void showEntities()

entitiesDataGridSelectionListener

protected void entitiesDataGridSelectionListener(com.vaadin.flow.data.selection.SelectionEvent<com.vaadin.flow.component.grid.Grid<Object>,Object> event)

createContainer

protected CollectionContainer createContainer(MetaClass meta)

updateButtonsPanel

protected void updateButtonsPanel(DataGrid<Object> dataGrid)

createMultiRowText

protected String createMultiRowText(String text,
 int rowLength)

initExcelExportAction

protected void initExcelExportAction(DataGrid<Object> dataGrid,
 Consumer<com.vaadin.flow.component.Component> addMethod)

updateSelectAction

protected void updateSelectAction(DataGrid<Object> dataGrid)

createLookupSelectAction

protected LookupSelectAction createLookupSelectAction(DataGrid<Object> dataGrid)

createShowEntityInfoAction

protected ShowEntityInfoAction createShowEntityInfoAction(DataGrid<Object> dataGrid)

createRefreshAction

protected RefreshAction createRefreshAction(DataGrid<Object> dataGrid)

createRemoveAction

protected RemoveAction createRemoveAction(DataGrid<Object> dataGrid)

createCreateAction

protected CreateAction createCreateAction(DataGrid<Object> dataGrid)

createEditAction

protected EditAction createEditAction(DataGrid<Object> dataGrid)

createRestoreButton

protected JmixButton createRestoreButton(DataGrid<Object> dataGrid)

createWipeOutButton

protected JmixButton createWipeOutButton(DataGrid<?> dataGrid)

showWipeOutDialog

protected void showWipeOutDialog()

showRestoreDialog

protected void showRestoreDialog()

showOptionDialog

protected void showOptionDialog(String header,
 String text,
 EntityInspectorListView.DialogConsumer<ActionPerformedEvent,Set<Object>> okEvent,
 Consumer<ActionPerformedEvent> cancelEvent,
 Set<Object> entityList)

wipeOutOkHandler

protected void wipeOutOkHandler(ActionPerformedEvent actionPerformedEvent,
 Set<Object> entityList)

restoreOkHandler

protected void restoreOkHandler(ActionPerformedEvent actionPerformedEvent,
 Set<Object> entityList)

standardCancelHandler

protected void standardCancelHandler(ActionPerformedEvent actionPerformedEvent)

entityChangeListener

protected void entityChangeListener(com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.combobox.ComboBox<MetaClass>,MetaClass> valueChangeEvent)

showModeChangeListener

protected void showModeChangeListener(com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.select.Select<ShowMode>,ShowMode> valueChangeEvent)

collectQueryParameters

protected com.vaadin.flow.router.QueryParameters collectQueryParameters(UrlQueryParametersFacet.Binder source)

collectFieldQueryParameters

protected void collectFieldQueryParameters(Map<String,List<String>> parametersMap)

collectPaginationQueryParameters

protected void collectPaginationQueryParameters(Map<String,List<String>> parametersMap,
 PaginationUrlQueryParametersBinder paginationBinder,
 SimplePagination pagination)

collectFilterQueryParameters

protected void collectFilterQueryParameters(Map<String,List<String>> parametersMap,
 GenericFilterUrlQueryParametersBinder filterBinder)

showNotification

protected void showNotification(String message)

readPermitted

protected boolean readPermitted(MetaClass metaClass)

setShowMode

protected void setShowMode(String showModeParameter)

createEntityExportPlan

protected FetchPlan createEntityExportPlan(MetaClass metaClass)

createEntityImportPlan

protected EntityImportPlan createEntityImportPlan(String content,
 MetaClass metaClass)

createEntityImportPlan

protected EntityImportPlan createEntityImportPlan(MetaClass metaClass)

setEntityName

public void setEntityName(String entityName)