Package io.jmix.flowui.view.template.impl

Class ViewTemplateDefinitions

java.lang.Object

io.jmix.flowui.view.template.impl.ViewTemplateDefinitions

@Component("flowui_ViewTemplateDefinitions")
public class ViewTemplateDefinitions
extends Object

Loads and caches template-generated view definitions discovered in entity metadata.

Field Summary

Fields

Modifier and Type	Field	Description
protected ComponentXmlFactory	componentXmlFactory
protected ViewTemplateControllerClassFactory	controllerClassFactory
protected List<ViewTemplateDefinition>	definitions
protected ViewTemplateDescriptorRegistry	descriptorRegistry
protected static final String	EDITED_ENTITY_CONTAINER_ID
protected freemarker.template.Configuration	freemarkerConfiguration
protected com.google.gson.Gson	gson
protected static final String	LOOKUP_COMPONENT_ID
protected Metadata	metadata
protected Resources	resources
protected static final Type	TEMPLATE_PARAMS_TYPE
protected ViewTemplateHelper	templateHelper

Constructor Summary

Constructors

Constructor	Description
ViewTemplateDefinitions()

Method Summary

Modifier and Type	Method	Description
protected void	addDefinition(List<ViewTemplateDefinition> definitions, Set<String> viewIds, ViewTemplateDefinition definition)
protected ViewTemplateDefinition	createDefinition(String viewId, ViewTemplateType type, MetaClass metaClass, Map<String,Object> attributes, String title)
protected ViewTemplateDefinition	createDetailDefinition(MetaClass metaClass, Map<String,Object> attributes)
protected ViewTemplateDefinition	createListDefinition(MetaClass metaClass, Map<String,Object> attributes)
List<ViewTemplateDefinition>	getDefinitions()	Returns cached template view definitions, loading them lazily on the first call.
protected String	getStringAttribute(Map<String,Object> attributes, String name)
protected Optional<Map<String,Object>>	getTemplateAttributes(MetaClass metaClass, Class<?> annotationClass)
protected void	init()
protected List<ViewTemplateDefinition>	loadDefinitions()
protected Map<String,Object>	parseTemplateParams(String templateParams)
void	refresh()	Re-renders all template view descriptors from current metadata and updates the descriptor registry.
protected String	renderTemplate(MetaClass metaClass, String templatePath, String title, Map<String,Object> templateParams)
protected String	resolveControllerIdAttribute(Map<String,Object> attributes, String attributeName, String defaultValue)
protected String	resolveEditedEntityContainerId(Map<String,Object> attributes)
protected String	resolveLookupComponentId(Map<String,Object> attributes)
protected String	resolveRoutePath(String viewId, ViewTemplateType type, Map<String,Object> attributes)
protected String	resolveTitleMessageReference(MetaClass metaClass, String title)	Normalizes a viewTitle defined as a message reference so that it is resolved through the Messages bean by the framework.

Methods inherited from class java.lang.Object

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

Field Details

TEMPLATE_PARAMS_TYPE

protected static final Type TEMPLATE_PARAMS_TYPE

LOOKUP_COMPONENT_ID

protected static final String LOOKUP_COMPONENT_ID

See Also:

• Constant Field Values

EDITED_ENTITY_CONTAINER_ID

protected static final String EDITED_ENTITY_CONTAINER_ID

See Also:

• Constant Field Values

metadata

@Autowired
protected Metadata metadata

resources

@Autowired
protected Resources resources

componentXmlFactory

@Autowired
protected ComponentXmlFactory componentXmlFactory

templateHelper

@Autowired
protected ViewTemplateHelper templateHelper

descriptorRegistry

@Autowired
protected ViewTemplateDescriptorRegistry descriptorRegistry

controllerClassFactory

@Autowired
protected ViewTemplateControllerClassFactory controllerClassFactory

gson

protected com.google.gson.Gson gson

freemarkerConfiguration

protected freemarker.template.Configuration freemarkerConfiguration

definitions

protected volatile List<ViewTemplateDefinition> definitions

Constructor Details

ViewTemplateDefinitions

public ViewTemplateDefinitions()

Method Details

init

@PostConstruct
protected void init()

getDefinitions

public List<ViewTemplateDefinition> getDefinitions()

Returns cached template view definitions, loading them lazily on the first call.

Returns:

immutable list of template view definitions

refresh

public void refresh()

Re-renders all template view descriptors from current metadata and updates the descriptor registry. Used when runtime metadata changes after startup so that template-generated views reflect the current entity properties.

loadDefinitions

protected List<ViewTemplateDefinition> loadDefinitions()

getTemplateAttributes

protected Optional<Map<String,Object>> getTemplateAttributes(MetaClass metaClass,
 Class<?> annotationClass)

addDefinition

protected void addDefinition(List<ViewTemplateDefinition> definitions,
 Set<String> viewIds,
 ViewTemplateDefinition definition)

createListDefinition

protected ViewTemplateDefinition createListDefinition(MetaClass metaClass,
 Map<String,Object> attributes)

createDetailDefinition

protected ViewTemplateDefinition createDetailDefinition(MetaClass metaClass,
 Map<String,Object> attributes)

createDefinition

protected ViewTemplateDefinition createDefinition(String viewId,
 ViewTemplateType type,
 MetaClass metaClass,
 Map<String,Object> attributes,
 String title)

resolveRoutePath

protected String resolveRoutePath(String viewId,
 ViewTemplateType type,
 Map<String,Object> attributes)

renderTemplate

protected String renderTemplate(MetaClass metaClass,
 String templatePath,
 String title,
 Map<String,Object> templateParams)

parseTemplateParams

protected Map<String,Object> parseTemplateParams(String templateParams)

resolveLookupComponentId

protected String resolveLookupComponentId(Map<String,Object> attributes)

resolveEditedEntityContainerId

protected String resolveEditedEntityContainerId(Map<String,Object> attributes)

resolveControllerIdAttribute

protected String resolveControllerIdAttribute(Map<String,Object> attributes,
 String attributeName,
 String defaultValue)

resolveTitleMessageReference

protected String resolveTitleMessageReference(MetaClass metaClass,
 String title)

Normalizes a viewTitle defined as a message reference so that it is resolved through the Messages bean by the framework. A brief reference msg://message_id is expanded to the full form msg://group/message_id using the entity package as the message group. The reference itself is kept intact so the title is resolved per locale later.

getStringAttribute

protected String getStringAttribute(Map<String,Object> attributes,
 String name)