io.jmix.ui.sys

Class ScreensHelper

java.lang.Object

io.jmix.ui.sys.ScreensHelper

@Component(value="ui_ScreensHelper")
public class ScreensHelper
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	ScreensHelper.ScreenType

Field Summary

Fields

Modifier and Type	Field and Description
protected io.jmix.core.AccessManager	accessManager
protected org.springframework.context.ApplicationContext	applicationContext
protected java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>	availableScreensCache
protected java.util.Map<java.lang.String,java.lang.String>	captionCache
protected io.jmix.core.security.CurrentAuthentication	currentAuthentication
protected io.jmix.core.common.xmlparsing.Dom4jTools	dom4JTools
protected LayoutLoaderConfig	layoutLoaderConfig
protected io.jmix.core.MessageTools	messageTools
protected io.jmix.core.Metadata	metadata
protected io.jmix.core.MetadataTools	metadataTools
protected io.jmix.core.Resources	resources
protected WindowConfig	windowConfig

Constructor Summary

Constructors

Constructor and Description
ScreensHelper()

Method Summary

Modifier and Type	Method and Description
protected void	cacheCaption(java.lang.String key, java.lang.String value)
protected void	cacheScreens(java.lang.String key, java.util.Map<java.lang.String,java.lang.String> value)
protected boolean	checkWindowType(java.lang.Class<? extends FrameOwner> controllerClass, ScreensHelper.ScreenType filterScreenType)
void	clearCache()
protected org.dom4j.Element	elementByID(org.dom4j.Element root, java.lang.String elementId)
protected java.lang.String	findLookupElementDataAttributeId(org.dom4j.Element lookupElement, java.lang.String dataAttribute)
java.util.Map<java.lang.String,java.lang.String>	getAvailableBrowserScreens(java.lang.Class entityClass)
java.util.Map<java.lang.String,java.lang.String>	getAvailableScreens(java.lang.Class entityClass)
java.util.Map<java.lang.String,java.lang.String>	getAvailableScreens(java.lang.Class entityClass, boolean useComplexSearch) Method returns a map of the screens that use the provided entity class in a data element (data container or datasource)
java.util.Map<java.lang.String,java.lang.String>	getAvailableScreens(java.lang.Class entityClass, java.util.List<java.lang.String> facets, boolean useComplexSearch) Method returns a map of the screens that use the provided entity class in a data element (data container or datasource) and contain specific facets
protected java.util.Map<java.lang.String,java.lang.String>	getAvailableScreensMap(java.lang.Class entityClass, ScreensHelper.ScreenType filterScreenType, java.util.List<java.lang.String> facets, boolean useComplexSearch)
protected java.lang.String	getCaptionCacheKey(java.lang.String src, java.util.Locale locale)
protected java.util.List<java.lang.String>	getCompositionAndAssociationFieldNames(io.jmix.core.metamodel.model.MetaClass editedEntityClass, io.jmix.core.metamodel.model.MetaClass targetEntityClass)
protected java.lang.String	getDataContainerId(org.dom4j.Element window, java.lang.Class<? extends FrameOwner> controllerClass, ScreensHelper.ScreenType filterScreenType)
protected java.util.List<java.lang.String>	getDataElementsIdForComposition(org.dom4j.Element data, java.lang.Class entityClass, java.lang.String editedEntityDeId)
protected java.lang.String	getDatasourceId(org.dom4j.Element window, ScreensHelper.ScreenType filterScreenType)
WindowInfo	getDefaultBrowseScreen(io.jmix.core.metamodel.model.MetaClass metaClass)
protected java.lang.String	getDetailedScreenCaption(java.lang.String caption, java.lang.String windowId)
java.lang.String	getDetailedScreenCaption(WindowInfo windowInfo)
java.lang.String	getDetailedScreenCaption(WindowInfo windowInfo, java.util.Locale locale)
protected org.dom4j.Element	getRootLayoutElement(java.lang.String src)
protected java.lang.String	getScreenCaption(org.dom4j.Element window, java.lang.String src)
protected java.lang.String	getScreenCaption(org.dom4j.Element window, java.lang.String src, java.util.Locale locale)
java.lang.String	getScreenCaption(WindowInfo windowInfo)
java.lang.String	getScreenCaption(WindowInfo windowInfo, java.util.Locale locale)
protected java.lang.String	getScreensCacheKey(java.lang.String className, java.util.Locale locale, ScreensHelper.ScreenType filterScreenType, java.util.List<java.lang.String> facets, boolean useComplexSearch)
protected org.dom4j.Element	getWindowElement(java.lang.String src)
protected boolean	isEntityAvailable(org.dom4j.Element window, java.lang.Class<? extends FrameOwner> controllerClass, java.lang.Class entityClass, ScreensHelper.ScreenType filterScreenType, boolean useComplexSearch)
protected boolean	isEntityAvailableForClass(java.lang.Class entityClass, java.lang.String className)
protected boolean	isEntityAvailableInDataElement(java.lang.Class entityClass, org.dom4j.Element dataContainer)
protected boolean	isEntityAvailableInDataElement(java.lang.Class entityClass, org.dom4j.Element dataElement, java.lang.String datasourceId)
protected boolean	isFacetAvailable(org.dom4j.Element window, java.util.List<java.lang.String> facetNames)
protected java.lang.String	packageFromFilePath(java.lang.String path)
protected java.lang.String	resolveEditedEntityContainerId(java.lang.Class<? extends FrameOwner> controllerClass)
protected java.lang.String	resolveLookupComponentId(java.lang.Class<? extends FrameOwner> controllerClass)
protected java.lang.String	resolveLookupDataContainer(org.dom4j.Element window, java.lang.Class<? extends FrameOwner> controllerClass)
protected java.lang.String	resolveLookupDatasource(org.dom4j.Element window)
void	sortWindowInfos(java.util.List<WindowInfo> windowInfoCollection) Sorts window infos alphabetically, takes into account $ mark.

Methods inherited from class java.lang.Object

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

Field Detail

windowConfig

@Autowired
protected WindowConfig windowConfig

messageTools

@Autowired
protected io.jmix.core.MessageTools messageTools

resources

@Autowired
protected io.jmix.core.Resources resources

currentAuthentication

@Autowired
protected io.jmix.core.security.CurrentAuthentication currentAuthentication

metadataTools

@Autowired
protected io.jmix.core.MetadataTools metadataTools

metadata

@Autowired
protected io.jmix.core.Metadata metadata

layoutLoaderConfig

@Autowired
protected LayoutLoaderConfig layoutLoaderConfig

applicationContext

@Autowired
protected org.springframework.context.ApplicationContext applicationContext

dom4JTools

@Autowired
protected io.jmix.core.common.xmlparsing.Dom4jTools dom4JTools

accessManager

@Autowired
protected io.jmix.core.AccessManager accessManager

captionCache

protected java.util.Map<java.lang.String,java.lang.String> captionCache

availableScreensCache

protected java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> availableScreensCache

Constructor Detail

ScreensHelper

public ScreensHelper()

Method Detail

sortWindowInfos

public void sortWindowInfos(java.util.List<WindowInfo> windowInfoCollection)

Sorts window infos alphabetically, takes into account $ mark.

Parameters:

windowInfoCollection - mutable list of window infos

getDefaultBrowseScreen

@Nullable
public WindowInfo getDefaultBrowseScreen(io.jmix.core.metamodel.model.MetaClass metaClass)

getAvailableBrowserScreens

public java.util.Map<java.lang.String,java.lang.String> getAvailableBrowserScreens(java.lang.Class entityClass)

getAvailableScreens

public java.util.Map<java.lang.String,java.lang.String> getAvailableScreens(java.lang.Class entityClass)

getAvailableScreens

public java.util.Map<java.lang.String,java.lang.String> getAvailableScreens(java.lang.Class entityClass,
                                                                            boolean useComplexSearch)

Method returns a map of the screens that use the provided entity class in a data element (data container or datasource)

Parameters:

entityClass - entity class used to search

useComplexSearch - if the value is 'true', all screens that use provided entity class in some data element will be returned (including screens for entities that contain the provided class as a composition or association). if value equals 'false', only main screens (browser, lookup, editor) for the provided entity class will be returned.

getAvailableScreens

public java.util.Map<java.lang.String,java.lang.String> getAvailableScreens(java.lang.Class entityClass,
                                                                            java.util.List<java.lang.String> facets,
                                                                            boolean useComplexSearch)

Method returns a map of the screens that use the provided entity class in a data element (data container or datasource) and contain specific facets

Parameters:

entityClass - entity class used to search

facets - facet names used to search

useComplexSearch - if the value is 'true', all screens that use provided entity class in some data element will be returned (including screens for entities that contain the provided class as a composition or association). if value equals 'false', only main screens (browser, lookup, editor) for the provided entity class will be returned.

getAvailableScreensMap

protected java.util.Map<java.lang.String,java.lang.String> getAvailableScreensMap(java.lang.Class entityClass,
                                                                                  ScreensHelper.ScreenType filterScreenType,
                                                                                  java.util.List<java.lang.String> facets,
                                                                                  boolean useComplexSearch)

isEntityAvailable

protected boolean isEntityAvailable(org.dom4j.Element window,
                                    java.lang.Class<? extends FrameOwner> controllerClass,
                                    java.lang.Class entityClass,
                                    ScreensHelper.ScreenType filterScreenType,
                                    boolean useComplexSearch)

isFacetAvailable

protected boolean isFacetAvailable(org.dom4j.Element window,
                                   java.util.List<java.lang.String> facetNames)

getDataContainerId

@Nullable
protected java.lang.String getDataContainerId(org.dom4j.Element window,
                                                        java.lang.Class<? extends FrameOwner> controllerClass,
                                                        ScreensHelper.ScreenType filterScreenType)

resolveLookupComponentId

@Nullable
protected java.lang.String resolveLookupComponentId(java.lang.Class<? extends FrameOwner> controllerClass)

resolveLookupDataContainer

@Nullable
protected java.lang.String resolveLookupDataContainer(org.dom4j.Element window,
                                                                java.lang.Class<? extends FrameOwner> controllerClass)

checkWindowType

protected boolean checkWindowType(java.lang.Class<? extends FrameOwner> controllerClass,
                                  ScreensHelper.ScreenType filterScreenType)

getDataElementsIdForComposition

protected java.util.List<java.lang.String> getDataElementsIdForComposition(org.dom4j.Element data,
                                                                           java.lang.Class entityClass,
                                                                           java.lang.String editedEntityDeId)

getCompositionAndAssociationFieldNames

protected java.util.List<java.lang.String> getCompositionAndAssociationFieldNames(io.jmix.core.metamodel.model.MetaClass editedEntityClass,
                                                                                  io.jmix.core.metamodel.model.MetaClass targetEntityClass)

isEntityAvailableForClass

protected boolean isEntityAvailableForClass(java.lang.Class entityClass,
                                            java.lang.String className)

isEntityAvailableInDataElement

protected boolean isEntityAvailableInDataElement(java.lang.Class entityClass,
                                                 @Nullable
                                                 org.dom4j.Element dataContainer)

isEntityAvailableInDataElement

protected boolean isEntityAvailableInDataElement(java.lang.Class entityClass,
                                                 org.dom4j.Element dataElement,
                                                 java.lang.String datasourceId)

resolveEditedEntityContainerId

@Nullable
protected java.lang.String resolveEditedEntityContainerId(java.lang.Class<? extends FrameOwner> controllerClass)

getDatasourceId

@Nullable
protected java.lang.String getDatasourceId(org.dom4j.Element window,
                                                     ScreensHelper.ScreenType filterScreenType)

resolveLookupDatasource

@Nullable
protected java.lang.String resolveLookupDatasource(org.dom4j.Element window)

findLookupElementDataAttributeId

@Nullable
protected java.lang.String findLookupElementDataAttributeId(org.dom4j.Element lookupElement,
                                                                      java.lang.String dataAttribute)

elementByID

@Nullable
protected org.dom4j.Element elementByID(org.dom4j.Element root,
                                                  java.lang.String elementId)

getWindowElement

@Nullable
protected org.dom4j.Element getWindowElement(java.lang.String src)
                                                throws java.io.FileNotFoundException

Throws:

java.io.FileNotFoundException

getRootLayoutElement

@Nullable
protected org.dom4j.Element getRootLayoutElement(java.lang.String src)
                                                    throws java.io.FileNotFoundException

Throws:

java.io.FileNotFoundException

getScreenCaption

@Nullable
public java.lang.String getScreenCaption(WindowInfo windowInfo)
                                            throws java.io.FileNotFoundException

Throws:

java.io.FileNotFoundException

getScreenCaption

@Nullable
public java.lang.String getScreenCaption(WindowInfo windowInfo,
                                                   java.util.Locale locale)
                                            throws java.io.FileNotFoundException

Throws:

java.io.FileNotFoundException

getScreenCaption

protected java.lang.String getScreenCaption(org.dom4j.Element window,
                                            java.lang.String src)

getScreenCaption

protected java.lang.String getScreenCaption(org.dom4j.Element window,
                                            java.lang.String src,
                                            java.util.Locale locale)

getDetailedScreenCaption

public java.lang.String getDetailedScreenCaption(WindowInfo windowInfo)
                                          throws java.io.FileNotFoundException

Throws:

java.io.FileNotFoundException

getDetailedScreenCaption

public java.lang.String getDetailedScreenCaption(WindowInfo windowInfo,
                                                 java.util.Locale locale)
                                          throws java.io.FileNotFoundException

Throws:

java.io.FileNotFoundException

getDetailedScreenCaption

protected java.lang.String getDetailedScreenCaption(@Nullable
                                                    java.lang.String caption,
                                                    java.lang.String windowId)

packageFromFilePath

@Nullable
protected java.lang.String packageFromFilePath(java.lang.String path)

cacheCaption

protected void cacheCaption(java.lang.String key,
                            java.lang.String value)

cacheScreens

protected void cacheScreens(java.lang.String key,
                            java.util.Map<java.lang.String,java.lang.String> value)

getCaptionCacheKey

protected java.lang.String getCaptionCacheKey(java.lang.String src,
                                              java.util.Locale locale)

getScreensCacheKey

protected java.lang.String getScreensCacheKey(java.lang.String className,
                                              java.util.Locale locale,
                                              ScreensHelper.ScreenType filterScreenType,
                                              java.util.List<java.lang.String> facets,
                                              boolean useComplexSearch)

clearCache

public void clearCache()