com.haulmont.cuba.gui.config

Class WindowConfig

java.lang.Object

com.haulmont.cuba.gui.config.WindowConfig

Direct Known Subclasses:

TestWindowConfig

@Component(value="cuba_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 java.util.List<UiControllersConfiguration>	configurations
protected Dom4jTools	dom4JTools
static java.util.regex.Pattern	ENTITY_SCREEN_PATTERN
protected boolean	initialized
protected java.util.concurrent.locks.ReadWriteLock	lock
protected static java.util.List<java.lang.String>	LOGIN_SCREEN_IDS
protected static java.lang.String	LOGIN_SCREEN_PROP
protected static java.util.List<java.lang.String>	MAIN_SCREEN_IDS
protected static java.lang.String	MAIN_SCREEN_PROP
protected Metadata	metadata
protected AnnotationScanMetadataReaderFactory	metadataReaderFactory
static java.lang.String	NAME
protected java.util.Map<java.lang.Class,WindowInfo>	primaryEditors
protected java.util.Map<java.lang.Class,WindowInfo>	primaryLookups
protected 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 Scripting	scripting
protected UiControllerMetaProvider	uiControllerMetaProvider
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(MetaClass metaClass)
java.lang.String	getBrowseScreenId(MetaClass metaClass)
WindowInfo	getEditorScreen(Entity entity)
java.lang.String	getEditorScreenId(MetaClass metaClass)
WindowInfo	getLookupScreen(java.lang.Class<? extends Entity> entityClass) Get available lookup screen by class of entity
java.lang.String	getLookupScreenId(MetaClass metaClass)
java.lang.String	getMetaClassScreenId(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)
void	loadScreenClass(java.lang.String className) Loads hot-deployed UiController screens and registers UiControllersConfiguration containing new UiControllerDefinition.
protected void	loadScreenConfigurations()
protected void	loadScreensXml()
protected void	registerPrimaryEditor(WindowInfo windowInfo, org.springframework.core.type.AnnotationMetadata annotationMetadata)
protected void	registerPrimaryEditor(WindowInfo windowInfo, java.util.Map<java.lang.String,java.lang.Object> primaryEditorAnnotation)
protected void	registerPrimaryEditor(WindowInfo windowInfo, UiControllerDefinition controllerDefinition)
protected void	registerPrimaryLookup(WindowInfo windowInfo, org.springframework.core.type.AnnotationMetadata annotationMetadata)
protected void	registerPrimaryLookup(WindowInfo windowInfo, java.util.Map<java.lang.String,java.lang.Object> primaryEditorAnnotation)
protected void	registerPrimaryLookup(WindowInfo windowInfo, UiControllerDefinition controllerDefinition)
protected void	registerScreen(java.lang.String id, WindowInfo windowInfo)
protected void	registerScreen(UiControllerDefinition controllerDefinition, 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

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

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

LOGIN_SCREEN_PROP

protected static final java.lang.String LOGIN_SCREEN_PROP

See Also:

Constant Field Values

MAIN_SCREEN_PROP

protected static final java.lang.String MAIN_SCREEN_PROP

See Also:

Constant Field Values

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

@Inject
protected Resources resources

scripting

@Inject
protected Scripting scripting

metadata

@Inject
protected Metadata metadata

screenXmlLoader

@Inject
protected ScreenXmlLoader screenXmlLoader

dom4JTools

@Inject
protected Dom4jTools dom4JTools

applicationContext

@Inject
protected org.springframework.context.ApplicationContext applicationContext

metadataReaderFactory

@Inject
protected AnnotationScanMetadataReaderFactory metadataReaderFactory

uiControllerMetaProvider

@Inject
protected UiControllerMetaProvider uiControllerMetaProvider

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

protected RouteDefinition loadRouteDefinition(org.dom4j.Element screenElement)

registerScreen

protected void registerScreen(UiControllerDefinition controllerDefinition,
                              WindowInfo windowInfo)

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)

registerPrimaryEditor

protected void registerPrimaryEditor(WindowInfo windowInfo,
                                     UiControllerDefinition controllerDefinition)

registerPrimaryEditor

protected void registerPrimaryEditor(WindowInfo windowInfo,
                                     @Nullable
                                     java.util.Map<java.lang.String,java.lang.Object> primaryEditorAnnotation)

registerPrimaryLookup

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

registerPrimaryLookup

protected void registerPrimaryLookup(WindowInfo windowInfo,
                                     UiControllerDefinition controllerDefinition)

registerPrimaryLookup

protected void registerPrimaryLookup(WindowInfo windowInfo,
                                     @Nullable
                                     java.util.Map<java.lang.String,java.lang.Object> primaryEditorAnnotation)

loadClassMetadata

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

loadScreenClass

public void loadScreenClass(java.lang.String className)

Loads hot-deployed UiController screens and registers UiControllersConfiguration containing new UiControllerDefinition.

Parameters:

className - the fully qualified name of the screen class to load

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(MetaClass metaClass,
                                             java.lang.String suffix)

getBrowseScreenId

public java.lang.String getBrowseScreenId(MetaClass metaClass)

getLookupScreenId

public java.lang.String getLookupScreenId(MetaClass metaClass)

getEditorScreenId

public java.lang.String getEditorScreenId(MetaClass metaClass)

getEditorScreen

public WindowInfo getEditorScreen(Entity entity)

getLookupScreen

public WindowInfo getLookupScreen(java.lang.Class<? extends Entity> 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(MetaClass metaClass)