Package io.jmix.flowui.view.template

Interface ViewTemplateHelper

All Known Implementing Classes:

DefaultViewTemplateHelper

@NullMarked
public interface ViewTemplateHelper

Provides helper methods for view templates.

Method Summary

Modifier and Type	Method	Description
List<MetaProperty>	getCollectionProperties(MetaClass metaClass, List<String> excludeProperties)	Returns composition collection properties that should be rendered as tabs by a detail view template.
List<MetaProperty>	getProperties(MetaClass metaClass, List<String> includeProperties, List<String> excludeProperties)	Returns properties that should be used by a view template for the given entity.

Method Details

getProperties

List<MetaProperty> getProperties(MetaClass metaClass,
 List<String> includeProperties,
 List<String> excludeProperties)

Returns properties that should be used by a view template for the given entity.

Implementations may apply default filtering rules and then process explicit include and exclude lists.

Parameters:

metaClass - entity metadata

includeProperties - property names that must be included when supported by the implementation

excludeProperties - property names that must be excluded from the result

Returns:

filtered entity properties in metadata order

getCollectionProperties

List<MetaProperty> getCollectionProperties(MetaClass metaClass,
 List<String> excludeProperties)

Returns composition collection properties that should be rendered as tabs by a detail view template.

Implementations return direct composition *-to-many properties, applying default filtering rules and then removing properties listed in excludeProperties. Association collections, datatype collections, and single-value properties are not returned.

Parameters:

metaClass - entity metadata

excludeProperties - property names that must be excluded from the result

Returns:

filtered composition collection properties in metadata order