com.haulmont.cuba.gui.dynamicattributes

Class DynamicAttributesGuiTools

java.lang.Object

com.haulmont.cuba.gui.dynamicattributes.DynamicAttributesGuiTools

@Component(value="cuba_DynamicAttributesGuiTools")
public class DynamicAttributesGuiTools
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected org.springframework.context.ApplicationContext	applicationContext
protected io.jmix.dynattrui.impl.AttributeValidators	attributeValidators
protected io.jmix.core.DataManager	dataManager
protected io.jmix.dynattr.DynAttrMetadata	dynAttrMetadata
protected io.jmix.core.FetchPlanRepository	fetchPlanRepository
protected io.jmix.core.FetchPlans	fetchPlans
protected Metadata	metadata
protected io.jmix.core.MetadataTools	metadataTools
static java.lang.String	NAME
protected io.jmix.core.ReferenceToEntitySupport	referenceToEntitySupport
protected Security	security

Constructor Summary

Constructors

Constructor and Description
DynamicAttributesGuiTools()

Method Summary

Modifier and Type	Method and Description
protected boolean	attributeShouldBeShownOnTheScreen(java.lang.String screen, java.lang.String component, io.jmix.dynattr.AttributeDefinition attribute)
protected boolean	checkUserPermissionForAttribute(io.jmix.dynattr.AttributeDefinition attribute)
protected java.util.Set<java.lang.Class>	collectEntityClasses(io.jmix.core.FetchPlan fetchPlan, java.util.Set<io.jmix.core.FetchPlan> visited)
protected java.util.Set<java.lang.Class>	collectEntityClassesWithDynamicAttributes(io.jmix.core.FetchPlan fetchPlan)
PickerField.LookupAction	createLookupAction(PickerField pickerField, java.lang.String joinClause, java.lang.String whereClause) Creates the lookup action that will open the lookup screen with the dynamic filter applied.
CollectionDatasource	createOptionsDatasourceForLookup(io.jmix.core.metamodel.model.MetaClass metaClass, java.lang.String joinClause, java.lang.String whereClause) Creates the collection datasource that is used for selecting the dynamic attribute value.
java.util.Collection<java.util.function.Consumer<?>>	createValidators(io.jmix.dynattr.AttributeDefinition attribute) Returns validators for a dynamic attribute
java.util.Set<io.jmix.dynattr.AttributeDefinition>	getAttributesToShowOnTheScreen(io.jmix.core.metamodel.model.MetaClass metaClass, java.lang.String windowId, java.lang.String componentId)
boolean	hasDynamicAttributes(io.jmix.core.Entity entity)
void	initDefaultAttributeValues(io.jmix.core.Entity item, io.jmix.core.metamodel.model.MetaClass metaClass)
void	listenCategoryChanges(Datasource ds)
void	listenDynamicAttributesChanges(Datasource datasource)
void	reloadDynamicAttributes(io.jmix.core.Entity entity) Reload dynamic attributes on the entity
boolean	screenContainsDynamicAttributes(io.jmix.core.FetchPlan fetchPlan, java.lang.String screenId) Method checks whether any class in the view hierarchy contains dynamic attributes that must be displayed on the current screen
protected void	setDefaultAttributeValue(io.jmix.core.Entity item, io.jmix.dynattr.AttributeDefinition attribute, boolean entityIsCategorized, java.time.ZonedDateTime currentTimestamp)

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

metadata

@Autowired
protected Metadata metadata

metadataTools

@Autowired
protected io.jmix.core.MetadataTools metadataTools

dynAttrMetadata

@Autowired
protected io.jmix.dynattr.DynAttrMetadata dynAttrMetadata

security

@Autowired
protected Security security

referenceToEntitySupport

@Autowired
protected io.jmix.core.ReferenceToEntitySupport referenceToEntitySupport

dataManager

@Autowired
protected io.jmix.core.DataManager dataManager

fetchPlanRepository

@Autowired
protected io.jmix.core.FetchPlanRepository fetchPlanRepository

attributeValidators

@Autowired
protected io.jmix.dynattrui.impl.AttributeValidators attributeValidators

applicationContext

@Autowired
protected org.springframework.context.ApplicationContext applicationContext

fetchPlans

@Autowired
protected io.jmix.core.FetchPlans fetchPlans

Constructor Detail

DynamicAttributesGuiTools

public DynamicAttributesGuiTools()

Method Detail

screenContainsDynamicAttributes

public boolean screenContainsDynamicAttributes(io.jmix.core.FetchPlan fetchPlan,
                                               java.lang.String screenId)

Method checks whether any class in the view hierarchy contains dynamic attributes that must be displayed on the current screen

initDefaultAttributeValues

public void initDefaultAttributeValues(io.jmix.core.Entity item,
                                       io.jmix.core.metamodel.model.MetaClass metaClass)

listenCategoryChanges

public void listenCategoryChanges(Datasource ds)

reloadDynamicAttributes

public void reloadDynamicAttributes(io.jmix.core.Entity entity)

Reload dynamic attributes on the entity

hasDynamicAttributes

public boolean hasDynamicAttributes(io.jmix.core.Entity entity)

getAttributesToShowOnTheScreen

public java.util.Set<io.jmix.dynattr.AttributeDefinition> getAttributesToShowOnTheScreen(io.jmix.core.metamodel.model.MetaClass metaClass,
                                                                                         java.lang.String windowId,
                                                                                         java.lang.String componentId)

createValidators

public java.util.Collection<java.util.function.Consumer<?>> createValidators(io.jmix.dynattr.AttributeDefinition attribute)

Returns validators for a dynamic attribute

Returns:

collection of validators

listenDynamicAttributesChanges

public void listenDynamicAttributesChanges(Datasource datasource)

collectEntityClassesWithDynamicAttributes

protected java.util.Set<java.lang.Class> collectEntityClassesWithDynamicAttributes(@Nullable
                                                                                   io.jmix.core.FetchPlan fetchPlan)

collectEntityClasses

protected java.util.Set<java.lang.Class> collectEntityClasses(io.jmix.core.FetchPlan fetchPlan,
                                                              java.util.Set<io.jmix.core.FetchPlan> visited)

attributeShouldBeShownOnTheScreen

protected boolean attributeShouldBeShownOnTheScreen(java.lang.String screen,
                                                    java.lang.String component,
                                                    io.jmix.dynattr.AttributeDefinition attribute)

checkUserPermissionForAttribute

protected boolean checkUserPermissionForAttribute(io.jmix.dynattr.AttributeDefinition attribute)

setDefaultAttributeValue

protected void setDefaultAttributeValue(io.jmix.core.Entity item,
                                        io.jmix.dynattr.AttributeDefinition attribute,
                                        boolean entityIsCategorized,
                                        java.time.ZonedDateTime currentTimestamp)

createLookupAction

public PickerField.LookupAction createLookupAction(PickerField pickerField,
                                                   java.lang.String joinClause,
                                                   java.lang.String whereClause)

Creates the lookup action that will open the lookup screen with the dynamic filter applied. This filter contains a condition with join and where clauses

createOptionsDatasourceForLookup

public CollectionDatasource createOptionsDatasourceForLookup(io.jmix.core.metamodel.model.MetaClass metaClass,
                                                             java.lang.String joinClause,
                                                             java.lang.String whereClause)

Creates the collection datasource that is used for selecting the dynamic attribute value. If the CategoryAttribute has "where" or "join" clauses then only items that satisfy these clauses will be presented in the options datasource