Package io.jmix.datatoolsflowui.view.entityinspector

Class EntityInspectorDetailView

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.StandardDetailView<Object>

io.jmix.datatoolsflowui.view.entityinspector.EntityInspectorDetailView

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, ChangeTracker, DetailView<Object>, ReadOnlyAwareView, Serializable

@Route(value="datatl/entityinspector/:entityName/:entityId",
       layout=DefaultMainViewParent.class)
@ViewController("datatl_entityInspectorDetailView")
@ViewDescriptor("entity-inspector-detail-view.xml")
@DialogMode(width="50em",
            resizable=true)
public class EntityInspectorDetailView
extends StandardDetailView<Object>

See Also:

• Serialized Form

Nested Class Summary

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

StandardDetailView.AfterSaveEvent, StandardDetailView.BeforeSaveEvent, StandardDetailView.InitEntityEvent<E>, StandardDetailView.SetupLockEvent, StandardDetailView.ValidationEvent

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

Field Summary

Fields

Modifier and Type	Field	Description
protected AccessManager	accessManager
protected Actions	actions
protected static final String	BASE_SELECT_QUERY
static final String	BUTTONS_PANEL_STYLE_NAME
protected InstanceContainer	container
protected DataComponents	dataComponents
protected DataContext	dataContext
protected DataManager	dataManager
protected EntityStates	entityStates
protected Boolean	isNew
protected MessageBundle	messageBundle
protected MessageTools	messageTools
protected MetaClass	metaClass
protected Metadata	metadata
protected String	metadataClassName
protected String	metadataId
protected MetadataTools	metadataTools
protected CollectionContainer<Object>	parentDataContainer
protected DataContext	parentDataContext
protected String	parentProperty
static final String	ROUTE_PARAM_ID
static final String	ROUTE_PARAM_NAME
protected static final String	SINGLE_SELECT_QUERY
protected static final String	SOFT_DELETABLE_SELECT_QUERY
protected com.vaadin.flow.component.tabs.Tabs	tabs
protected HashMap<com.vaadin.flow.component.tabs.Tab,com.vaadin.flow.component.Component>	tabToContentMap
protected UiComponents	uiComponents
protected UrlParamSerializer	urlParamSerializer

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

DEFAULT_ROUTE_PARAM, LOCKED_BEFORE_REFRESH_ATTR_NAME, MODE_PARAM, MODE_READONLY, NEW_ENTITY_ID, READ_ONLY_BEFORE_REFRESH_ATTR_NAME, reloadSaved

Constructor Summary

Constructors

Constructor	Description
EntityInspectorDetailView()

Method Summary

Modifier and Type	Method	Description
protected JmixButton	addButton(DataGrid<?> dataGrid, MetaProperty metaProperty)
protected void	addComponentBeforeDetailActions(com.vaadin.flow.component.Component component)
protected void	addDataGrid(InstanceContainer parent, MetaProperty childMeta)	Creates a dataGrid for the entities in ONE_TO_MANY or MANY_TO_MANY relation with the current one
void	beforeEnter(com.vaadin.flow.router.BeforeEnterEvent event)
protected AddAction	createAddAction(DataGrid<?> dataGrid, MetaProperty metaProperty)
protected JmixButton	createButton(DataGrid<?> dataGrid, MetaProperty metaProperty)
protected com.vaadin.flow.component.orderedlayout.HorizontalLayout	createButtonsPanel(DataGrid<?> dataGrid, MetaProperty metaProperty, CollectionContainer dataGridContainer)
protected void	createContent()
protected CreateAction	createCreateAction(DataGrid<?> dataGrid, MetaProperty metaProperty)
protected CollectionContainer	createDataGridContainer(InstanceContainer parent, MetaProperty childMeta, MetaClass meta)
protected EditAction	createEditAction(DataGrid<?> dataGrid, MetaProperty metaProperty, CollectionContainer dataGridContainer)
protected void	createNewItemByMetaClass()
protected SecuredListDataComponentAction	createRemoveAction(DataGrid<?> dataGrid, MetaProperty metaProperty)	Creates either Remove or Exclude action depending on property type
protected JmixButton	editButton(DataGrid<?> dataGrid, MetaProperty metaProperty, CollectionContainer dataGridContainer)
protected InstanceContainer	getEditedEntityContainer()
String	getPageTitle()
protected String	getPropertyTitle(MetaClass metaClass, MetaProperty metaProperty)
protected String	getRouteParamName()
protected InstanceContainer	initMainContainer(Object entity)
protected void	onAfterSave(StandardDetailView.AfterSaveEvent event)
void	onBeforeShow(View.BeforeShowEvent event)
void	onInit(View.InitEvent event)
protected void	onSelectedTabChange(com.vaadin.flow.component.tabs.Tabs.SelectedChangeEvent selectedChangeEvent)
protected JmixButton	removeButton(DataGrid<?> dataGrid, MetaProperty metaProperty)
void	setMetadataClassName(String metadataClassName)
void	setMetadataId(String metadataId)
void	setParentDataContainer(CollectionContainer<Object> dataContainer)
void	setParentDataContext(DataContext parentDataContext)
void	setParentProperty(String parentProperty)
protected void	setupEntityToEdit(Object entityToEdit)	Invoked when the view is opened in dialog window or when the view is opened by navigation and StandardDetailView.setEntityToEdit(Object) method is called in AfterViewNavigationEvent handler.
protected void	setupEntityToEdit(String serializedEntityId)	Invoked when the view is opened by navigation.

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

addAfterSaveListener, addBeforeSaveListener, addInitEntityListener, addValidationEventListener, clearChanges, closeWithDiscard, closeWithSave, findEntityId, getEditedEntity, getEditedEntityLoader, getEditedEntityOrNull, getLockStatus, getSaveNotificationText, hasUnsavedChanges, initExistingEntity, initNewEntity, isCrossFieldValidationEnabled, isReadOnly, isReloadEdited, isReloadSaved, isSaveActionPerformed, isShowSaveNotification, isShowValidationErrors, onDetachInternal, save, setCrossFieldValidationEnabled, setEntityToEdit, setReadOnly, setReloadEdited, setReloadSaved, setShowSaveNotification, setShowValidationErrors, setupEntityToEdit, validateView

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, getReturnParameters, getViewActions, getViewAttributes, getViewData, getViewFacets, getViewSupport, isPreventBrowserTabClosing, onAttach, onDetach, 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

SOFT_DELETABLE_SELECT_QUERY

protected static final String SOFT_DELETABLE_SELECT_QUERY

See Also:

• Constant Field Values

SINGLE_SELECT_QUERY

protected static final String SINGLE_SELECT_QUERY

See Also:

• Constant Field Values

ROUTE_PARAM_NAME

public static final String ROUTE_PARAM_NAME

See Also:

• Constant Field Values

ROUTE_PARAM_ID

public static final String ROUTE_PARAM_ID

See Also:

• Constant Field Values

BUTTONS_PANEL_STYLE_NAME

public static final String BUTTONS_PANEL_STYLE_NAME

See Also:

• Constant Field Values

metadata

@Autowired
protected Metadata metadata

messageTools

@Autowired
protected MessageTools messageTools

uiComponents

@Autowired
protected UiComponents uiComponents

dataComponents

@Autowired
protected DataComponents dataComponents

accessManager

@Autowired
protected AccessManager accessManager

metadataTools

@Autowired
protected MetadataTools metadataTools

actions

@Autowired
protected Actions actions

entityStates

@Autowired
protected EntityStates entityStates

dataManager

@Autowired
protected DataManager dataManager

messageBundle

@Autowired
protected MessageBundle messageBundle

urlParamSerializer

@Autowired
protected UrlParamSerializer urlParamSerializer

tabs

protected com.vaadin.flow.component.tabs.Tabs tabs

parentDataContext

@Nullable
protected DataContext parentDataContext

parentProperty

protected String parentProperty

dataContext

protected DataContext dataContext

parentDataContainer

protected CollectionContainer<Object> parentDataContainer

tabToContentMap

protected HashMap<com.vaadin.flow.component.tabs.Tab,com.vaadin.flow.component.Component> tabToContentMap

isNew

protected Boolean isNew

container

protected InstanceContainer container

metadataClassName

protected String metadataClassName

metadataId

protected String metadataId

metaClass

protected MetaClass metaClass

Constructor Details

EntityInspectorDetailView

public EntityInspectorDetailView()

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 StandardDetailView<Object>

onBeforeShow

@Subscribe
public void onBeforeShow(View.BeforeShowEvent event)

onAfterSave

@Subscribe
protected void onAfterSave(StandardDetailView.AfterSaveEvent event)

setupEntityToEdit

protected void setupEntityToEdit(String serializedEntityId)

Description copied from class: StandardDetailView

Invoked when the view is opened by navigation.

Overrides:

setupEntityToEdit in class StandardDetailView<Object>

Parameters:

serializedEntityId - serialized id of the edited entity or StandardDetailView.NEW_ENTITY_ID when creating new entity

createNewItemByMetaClass

protected void createNewItemByMetaClass()

setupEntityToEdit

protected void setupEntityToEdit(Object entityToEdit)

Description copied from class: StandardDetailView

Invoked when the view is opened in dialog window or when the view is opened by navigation and StandardDetailView.setEntityToEdit(Object) method is called in AfterViewNavigationEvent handler.

Overrides:

setupEntityToEdit in class StandardDetailView<Object>

Parameters:

entityToEdit - entity instance to edit. Can be a new instance when the entity is being created, see EntityStates.isNew(Object).

initMainContainer

protected InstanceContainer initMainContainer(Object entity)

getRouteParamName

protected String getRouteParamName()

Overrides:

getRouteParamName in class StandardDetailView<Object>

getEditedEntityContainer

protected InstanceContainer getEditedEntityContainer()

Overrides:

getEditedEntityContainer in class StandardDetailView<Object>

getPageTitle

public String getPageTitle()

Specified by:

getPageTitle in interface com.vaadin.flow.router.HasDynamicTitle

Overrides:

getPageTitle in class View<ViewLayout>

createContent

protected void createContent()

onSelectedTabChange

protected void onSelectedTabChange(com.vaadin.flow.component.tabs.Tabs.SelectedChangeEvent selectedChangeEvent)

addDataGrid

protected void addDataGrid(InstanceContainer parent,
 MetaProperty childMeta)

Creates a dataGrid for the entities in ONE_TO_MANY or MANY_TO_MANY relation with the current one

createDataGridContainer

protected CollectionContainer createDataGridContainer(InstanceContainer parent,
 MetaProperty childMeta,
 MetaClass meta)

getPropertyTitle

protected String getPropertyTitle(MetaClass metaClass,
 MetaProperty metaProperty)

createButtonsPanel

protected com.vaadin.flow.component.orderedlayout.HorizontalLayout createButtonsPanel(DataGrid<?> dataGrid,
 MetaProperty metaProperty,
 CollectionContainer dataGridContainer)

addButton

protected JmixButton addButton(DataGrid<?> dataGrid,
 MetaProperty metaProperty)

createAddAction

protected AddAction createAddAction(DataGrid<?> dataGrid,
 MetaProperty metaProperty)

createButton

protected JmixButton createButton(DataGrid<?> dataGrid,
 MetaProperty metaProperty)

createCreateAction

protected CreateAction createCreateAction(DataGrid<?> dataGrid,
 MetaProperty metaProperty)

editButton

protected JmixButton editButton(DataGrid<?> dataGrid,
 MetaProperty metaProperty,
 CollectionContainer dataGridContainer)

createEditAction

protected EditAction createEditAction(DataGrid<?> dataGrid,
 MetaProperty metaProperty,
 CollectionContainer dataGridContainer)

removeButton

protected JmixButton removeButton(DataGrid<?> dataGrid,
 MetaProperty metaProperty)

createRemoveAction

protected SecuredListDataComponentAction createRemoveAction(DataGrid<?> dataGrid,
 MetaProperty metaProperty)

Creates either Remove or Exclude action depending on property type

addComponentBeforeDetailActions

protected void addComponentBeforeDetailActions(com.vaadin.flow.component.Component component)

setMetadataClassName

public void setMetadataClassName(String metadataClassName)

setMetadataId

public void setMetadataId(String metadataId)

setParentDataContext

public void setParentDataContext(@Nullable
 DataContext parentDataContext)

setParentProperty

public void setParentProperty(String parentProperty)

setParentDataContainer

public void setParentDataContainer(CollectionContainer<Object> dataContainer)