Package io.jmix.dynmodelflowui.impl

Class DynamicViewComponentIdProvider

java.lang.Object

io.jmix.dynmodelflowui.impl.DynamicViewComponentIdProvider

@Component("dynmod_DynamicViewComponentIdProvider")
public class DynamicViewComponentIdProvider
extends Object

Lists the components available in a dynamic view declaration, so the behavior handler editor can offer them instead of asking the user to type an id.

The components are read from up to three sources, unioned: the literal descriptor.source, the extended base view (for static entity extensions), and the rendered template (for dynamic entities). A template can only be rendered for an entity that exists in current metadata, so a dynamic entity that has never been applied contributes nothing — the editor combo accepts a typed value anyway.

Every id attribute in a source document is collected, except those in the parts of the view that hold no components: the data and facets sections and the actions declarations. A handler is attached by looking the id up in the view's component tree, so an id declared there could never be a target for any event.

This class does not consider trigger kinds. Narrowing the result to what a particular trigger can attach to is the editor's job, using ViewComponentTagCapabilities and the reported tag.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	DynamicViewComponentIdProvider.ComponentInfo	A component offered by the handler editor: its id and the XML tag it was declared with, such as button or textField.

Field Summary

Fields

Modifier and Type	Field	Description
protected BaseViewXmlProvider	baseViewXmlProvider
protected DynamicViewDeployer	dynamicViewDeployer
protected Metadata	metadata
protected DynamicModelDefinitionModelConverter	modelConverter
protected static final Set<String>	NON_COMPONENT_ELEMENTS	View XML elements whose subtrees declare no components.
protected DynamicModelStaticExtensionResolver	staticExtensionResolver

Constructor Summary

Constructors

Constructor	Description
DynamicViewComponentIdProvider()

Method Summary

Modifier and Type	Method	Description
protected void	collectComponents(org.dom4j.Element element, Map<String,String> tagsById)	Collects each element that carries an id into tagsById, keyed by the id and valued by the element's XML tag.
protected void	collectFromBaseView(DynamicViewModel view, @Nullable DynamicEntityModel entity, boolean staticExtension, Map<String,String> tagsById)
protected void	collectFromSource(DynamicViewModel view, Map<String,String> tagsById)
protected void	collectFromTemplate(DynamicViewModel view, @Nullable DynamicEntityModel entity, boolean staticExtension, Map<String,String> tagsById)	Renders the template behind a dynamic entity view and collects its ids.
protected @Nullable String	descriptorSource(DynamicViewModel view)
List<DynamicViewComponentIdProvider.ComponentInfo>	getComponentInfos(DynamicViewModel view, @Nullable DynamicEntityModel entity)	Returns the components of the given view declaration, distinct by id and sorted by id case-insensitively.
protected boolean	isStaticExtension(@Nullable DynamicEntityModel entity)	Resolves once whether the given entity is a static-entity extension, so both collectFromBaseView(io.jmix.dynmodelflowui.model.DynamicViewModel, io.jmix.dynmodelflowui.model.DynamicEntityModel, boolean, java.util.Map<java.lang.String, java.lang.String>) and collectFromTemplate(io.jmix.dynmodelflowui.model.DynamicViewModel, io.jmix.dynmodelflowui.model.DynamicEntityModel, boolean, java.util.Map<java.lang.String, java.lang.String>) branch on the same answer.

Methods inherited from class java.lang.Object

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

Field Details

NON_COMPONENT_ELEMENTS

protected static final Set<String> NON_COMPONENT_ELEMENTS

View XML elements whose subtrees declare no components. A handler target is resolved against the view's component tree, so an id declared inside one of these could never be found. The set is deliberately limited to fixed parts of the view schema, so it can never exclude a component.

metadata

@Autowired
protected Metadata metadata

baseViewXmlProvider

@Autowired
protected BaseViewXmlProvider baseViewXmlProvider

dynamicViewDeployer

@Autowired
protected DynamicViewDeployer dynamicViewDeployer

staticExtensionResolver

@Autowired
protected DynamicModelStaticExtensionResolver staticExtensionResolver

modelConverter

@Autowired
protected DynamicModelDefinitionModelConverter modelConverter

Constructor Details

DynamicViewComponentIdProvider

public DynamicViewComponentIdProvider()

Method Details

getComponentInfos

public List<DynamicViewComponentIdProvider.ComponentInfo> getComponentInfos(DynamicViewModel view,
 @Nullable DynamicEntityModel entity)

Returns the components of the given view declaration, distinct by id and sorted by id case-insensitively. Never throws: a source that cannot be read contributes nothing, so the worst case is an empty list.

When the same id appears in more than one source, the first occurrence keeps its tag. The sources are visited in declaration order, so the literal descriptor.source wins over the extended base view.

Parameters:

view - the view declaration being edited

entity - the entity that owns the view, null when unknown

isStaticExtension

protected boolean isStaticExtension(@Nullable DynamicEntityModel entity)

Resolves once whether the given entity is a static-entity extension, so both collectFromBaseView(io.jmix.dynmodelflowui.model.DynamicViewModel, io.jmix.dynmodelflowui.model.DynamicEntityModel, boolean, java.util.Map<java.lang.String, java.lang.String>) and collectFromTemplate(io.jmix.dynmodelflowui.model.DynamicViewModel, io.jmix.dynmodelflowui.model.DynamicEntityModel, boolean, java.util.Map<java.lang.String, java.lang.String>) branch on the same answer. A failing resolver contributes nothing rather than aborting the whole lookup: the entity is then treated as not a static extension, which only skips the base-view source.

collectFromSource

protected void collectFromSource(DynamicViewModel view,
 Map<String,String> tagsById)

collectFromBaseView

protected void collectFromBaseView(DynamicViewModel view,
 @Nullable DynamicEntityModel entity,
 boolean staticExtension,
 Map<String,String> tagsById)

collectFromTemplate

protected void collectFromTemplate(DynamicViewModel view,
 @Nullable DynamicEntityModel entity,
 boolean staticExtension,
 Map<String,String> tagsById)

Renders the template behind a dynamic entity view and collects its ids. Skipped for static extensions, for a declaration that already carries literal source, when the view type is not set, and when the entity has no metaclass yet.

descriptorSource

protected @Nullable String descriptorSource(DynamicViewModel view)

collectComponents

protected void collectComponents(org.dom4j.Element element,
 Map<String,String> tagsById)

Collects each element that carries an id into tagsById, keyed by the id and valued by the element's XML tag. An id already present keeps the tag it was first seen with. Subtrees listed in NON_COMPONENT_ELEMENTS are skipped whole.