io.jmix.ui

Class WindowConfig

java.lang.Object

io.jmix.ui.WindowConfig

@Component(value="ui_WindowConfig")
public class WindowConfig
extends java.lang.Object

GenericUI class holding information about all registered in screens.xml screens.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WindowConfig.ResolvedWindowInfo

Field Summary

Fields

Modifier and Type	Field and Description
protected org.springframework.context.ApplicationContext	applicationContext
protected io.jmix.core.ClassManager	classManager
protected java.util.List<UiControllersConfiguration>	configurations
static java.util.regex.Pattern	ENTITY_SCREEN_PATTERN
protected org.springframework.core.env.Environment	environment
protected io.jmix.core.ExtendedEntities	extendedEntities
protected boolean	initialized
protected java.util.concurrent.locks.ReadWriteLock	lock
protected static java.util.List<java.lang.String>	LOGIN_SCREEN_IDS
protected static java.util.List<java.lang.String>	MAIN_SCREEN_IDS
protected io.jmix.core.Metadata	metadata
protected io.jmix.core.impl.scanning.AnnotationScanMetadataReaderFactory	metadataReaderFactory
protected io.jmix.core.JmixModules	modules
protected java.util.Map<java.lang.Class,WindowInfo>	primaryEditors
protected java.util.Map<java.lang.Class,WindowInfo>	primaryLookups
protected io.jmix.core.Resources	resources
protected com.google.common.collect.BiMap<java.lang.String,java.lang.String>	routes
protected java.util.Map<java.lang.String,WindowInfo>	screens
protected ScreenXmlLoader	screenXmlLoader
protected UiProperties	uiProperties
static java.lang.String	WINDOW_CONFIG_XML_PROP
protected WindowAttributesProvider	windowAttributesProvider

Constructor Summary

Constructors

Constructor and Description
WindowConfig()

Method Summary

Modifier and Type	Method and Description
protected void	checkInitialized()
protected WindowInfo.Type	extractWindowInfoType(WindowInfo windowInfo, java.lang.Class<? extends FrameOwner> controllerClass)
java.lang.String	findRoute(java.lang.String id) Find route by screen id.
WindowInfo	findWindowInfo(java.lang.String id) Get screen information by screen ID.
WindowInfo	findWindowInfoByRoute(java.lang.String route) Get screen information by route.
java.lang.String	getAvailableLookupScreenId(io.jmix.core.metamodel.model.MetaClass metaClass)
java.lang.String	getBrowseScreenId(io.jmix.core.metamodel.model.MetaClass metaClass)
WindowInfo	getEditorScreen(java.lang.Object entity)
java.lang.String	getEditorScreenId(io.jmix.core.metamodel.model.MetaClass metaClass)
WindowInfo	getLookupScreen(java.lang.Class<?> entityClass) Get available lookup screen by class of entity
java.lang.String	getLookupScreenId(io.jmix.core.metamodel.model.MetaClass metaClass)
java.lang.String	getMetaClassScreenId(io.jmix.core.metamodel.model.MetaClass metaClass, java.lang.String suffix)
protected org.springframework.core.type.classreading.MetadataReaderFactory	getMetadataReaderFactory()
protected org.springframework.core.io.ResourceLoader	getResourceLoader()
WindowInfo	getWindowInfo(java.lang.String id) Get screen information by screen ID.
java.util.Collection<WindowInfo>	getWindows() All registered screens
boolean	hasWindow(java.lang.String id)
protected void	init()
protected org.springframework.core.type.classreading.MetadataReader	loadClassMetadata(java.lang.String className)
protected void	loadConfig(org.dom4j.Element rootElem)
protected java.lang.Class<? extends FrameOwner>	loadDefinedScreenClass(java.lang.String className)
protected RouteDefinition	loadRouteDefinition(org.dom4j.Element screenElement)
protected void	loadScreenConfigurations()
protected void	loadScreensXml()
protected void	registerPrimaryEditor(WindowInfo windowInfo, org.springframework.core.type.AnnotationMetadata annotationMetadata)
protected void	registerPrimaryLookup(WindowInfo windowInfo, org.springframework.core.type.AnnotationMetadata annotationMetadata)
protected void	registerScreen(java.lang.String id, WindowInfo windowInfo)
protected void	registerScreenRoute(java.lang.String screenId, WindowInfo windowInfo)
void	reset() Make the config to reload screens on next request.
protected WindowInfo	resolveWindowInfo(WindowInfo windowInfo)
protected boolean	routeOverrideAllowed(java.lang.String newScreenId) Have to do this check due to Login/Main Screen are registered before legacy LoginWindow / AppMainWindow.

Methods inherited from class java.lang.Object

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

Field Detail

WINDOW_CONFIG_XML_PROP

public static final java.lang.String WINDOW_CONFIG_XML_PROP

See Also:

Constant Field Values

ENTITY_SCREEN_PATTERN

public static final java.util.regex.Pattern ENTITY_SCREEN_PATTERN

LOGIN_SCREEN_IDS

protected static final java.util.List<java.lang.String> LOGIN_SCREEN_IDS

MAIN_SCREEN_IDS

protected static final java.util.List<java.lang.String> MAIN_SCREEN_IDS

screens

protected java.util.Map<java.lang.String,WindowInfo> screens

routes

protected com.google.common.collect.BiMap<java.lang.String,java.lang.String> routes

primaryEditors

protected java.util.Map<java.lang.Class,WindowInfo> primaryEditors

primaryLookups

protected java.util.Map<java.lang.Class,WindowInfo> primaryLookups

configurations

@Autowired(required=false)
protected java.util.List<UiControllersConfiguration> configurations

resources

@Autowired
protected io.jmix.core.Resources resources

classManager

@Autowired
protected io.jmix.core.ClassManager classManager

metadata

@Autowired
protected io.jmix.core.Metadata metadata

extendedEntities

@Autowired
protected io.jmix.core.ExtendedEntities extendedEntities

screenXmlLoader

@Autowired
protected ScreenXmlLoader screenXmlLoader

uiProperties

@Autowired
protected UiProperties uiProperties

environment

@Autowired
protected org.springframework.core.env.Environment environment

applicationContext

@Autowired
protected org.springframework.context.ApplicationContext applicationContext

metadataReaderFactory

@Autowired
protected io.jmix.core.impl.scanning.AnnotationScanMetadataReaderFactory metadataReaderFactory

modules

@Autowired
protected io.jmix.core.JmixModules modules

initialized

protected volatile boolean initialized

lock

protected java.util.concurrent.locks.ReadWriteLock lock

windowAttributesProvider

protected WindowAttributesProvider windowAttributesProvider

Constructor Detail

WindowConfig

public WindowConfig()

Method Detail

resolveWindowInfo

protected WindowInfo resolveWindowInfo(WindowInfo windowInfo)

getMetadataReaderFactory

protected org.springframework.core.type.classreading.MetadataReaderFactory getMetadataReaderFactory()

getResourceLoader

protected org.springframework.core.io.ResourceLoader getResourceLoader()

extractWindowInfoType

protected WindowInfo.Type extractWindowInfoType(WindowInfo windowInfo,
                                                java.lang.Class<? extends FrameOwner> controllerClass)

loadDefinedScreenClass

protected java.lang.Class<? extends FrameOwner> loadDefinedScreenClass(java.lang.String className)

checkInitialized

protected void checkInitialized()

init

protected void init()

loadScreenConfigurations

protected void loadScreenConfigurations()

loadScreensXml

protected void loadScreensXml()

loadConfig

protected void loadConfig(org.dom4j.Element rootElem)

loadRouteDefinition

@Nullable
protected RouteDefinition loadRouteDefinition(org.dom4j.Element screenElement)

registerScreen

protected void registerScreen(java.lang.String id,
                              WindowInfo windowInfo)

registerScreenRoute

protected void registerScreenRoute(java.lang.String screenId,
                                   WindowInfo windowInfo)

routeOverrideAllowed

protected boolean routeOverrideAllowed(java.lang.String newScreenId)

Have to do this check due to Login/Main Screen are registered before legacy LoginWindow / AppMainWindow.

registerPrimaryEditor

protected void registerPrimaryEditor(WindowInfo windowInfo,
                                     org.springframework.core.type.AnnotationMetadata annotationMetadata)

registerPrimaryLookup

protected void registerPrimaryLookup(WindowInfo windowInfo,
                                     org.springframework.core.type.AnnotationMetadata annotationMetadata)

loadClassMetadata

protected org.springframework.core.type.classreading.MetadataReader loadClassMetadata(java.lang.String className)

reset

public void reset()

Make the config to reload screens on next request.

findWindowInfo

@Nullable
public WindowInfo findWindowInfo(java.lang.String id)

Get screen information by screen ID.

Parameters:

id - screen ID as set up in screens.xml

Returns:

screen's registration information or null if not found

getWindowInfo

public WindowInfo getWindowInfo(java.lang.String id)

Get screen information by screen ID.

Parameters:

id - screen ID as set up in screens.xml

Returns:

screen's registration information

Throws:

NoSuchScreenException - if the screen with specified ID is not registered

findWindowInfoByRoute

@Nullable
public WindowInfo findWindowInfoByRoute(java.lang.String route)

Get screen information by route.

Parameters:

route - route

Returns:

screen's registration information or null if not found

findRoute

@Nullable
public java.lang.String findRoute(java.lang.String id)

Find route by screen id.

Parameters:

id - screen id

Returns:

registered route or null if no route for screen

hasWindow

public boolean hasWindow(java.lang.String id)

Returns:

true if the configuration contains a screen with provided ID

getWindows

public java.util.Collection<WindowInfo> getWindows()

All registered screens

getMetaClassScreenId

public java.lang.String getMetaClassScreenId(io.jmix.core.metamodel.model.MetaClass metaClass,
                                             java.lang.String suffix)

getBrowseScreenId

public java.lang.String getBrowseScreenId(io.jmix.core.metamodel.model.MetaClass metaClass)

getLookupScreenId

public java.lang.String getLookupScreenId(io.jmix.core.metamodel.model.MetaClass metaClass)

getEditorScreenId

public java.lang.String getEditorScreenId(io.jmix.core.metamodel.model.MetaClass metaClass)

getEditorScreen

public WindowInfo getEditorScreen(java.lang.Object entity)

getLookupScreen

public WindowInfo getLookupScreen(java.lang.Class<?> entityClass)

Get available lookup screen by class of entity

Parameters:

entityClass - entity class

Returns:

id of lookup screen

Throws:

NoSuchScreenException - if the screen with specified ID is not registered

getAvailableLookupScreenId

public java.lang.String getAvailableLookupScreenId(io.jmix.core.metamodel.model.MetaClass metaClass)