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 DataManager	dataManager
protected DynamicAttributes	dynamicAttributes
protected Metadata	metadata
static java.lang.String	NAME
protected ReferenceToEntitySupport	referenceToEntitySupport
protected WindowConfig	windowConfig

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, CategoryAttribute attribute)
protected java.util.Set<java.lang.Class>	collectEntityClasses(View view, java.util.Set<View> visited)
protected java.util.Set<java.lang.Class>	collectEntityClassesWithDynamicAttributes(View view)
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(com.haulmont.chile.core.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.Set<CategoryAttribute>	getAttributesToShowOnTheScreen(com.haulmont.chile.core.model.MetaClass metaClass, java.lang.String screen, java.lang.String component) Get attributes which should be added automatically to the screen and component.
void	initDefaultAttributeValues(BaseGenericIdEntity item, com.haulmont.chile.core.model.MetaClass metaClass)
void	initEntityPickerField(PickerField pickerField, CategoryAttribute categoryAttribute) Initializes the pickerField for selecting the dynamic attribute value.
void	listenCategoryChanges(Datasource ds)
void	listenDynamicAttributesChanges(Datasource datasource) Enforce the datasource to change modified status if dynamic attribute is changed
void	reloadDynamicAttributes(BaseGenericIdEntity entity) Reload dynamic attributes on the entity
boolean	screenContainsDynamicAttributes(View mainDatasourceView, java.lang.String screenId) Method checks whether any class in the view hierarchy contains dynamic attributes that must be displayed on the current screen

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

dynamicAttributes

@Inject
protected DynamicAttributes dynamicAttributes

windowConfig

@Inject
protected WindowConfig windowConfig

metadata

@Inject
protected Metadata metadata

referenceToEntitySupport

@Inject
protected ReferenceToEntitySupport referenceToEntitySupport

dataManager

@Inject
protected DataManager dataManager

Constructor Detail

DynamicAttributesGuiTools

public DynamicAttributesGuiTools()

Method Detail

listenDynamicAttributesChanges

public void listenDynamicAttributesChanges(Datasource datasource)

Enforce the datasource to change modified status if dynamic attribute is changed

getAttributesToShowOnTheScreen

public java.util.Set<CategoryAttribute> getAttributesToShowOnTheScreen(com.haulmont.chile.core.model.MetaClass metaClass,
                                                                       java.lang.String screen,
                                                                       @Nullable
                                                                       java.lang.String component)

Get attributes which should be added automatically to the screen and component. Based on visibility settings from category attribute editor.

screenContainsDynamicAttributes

public boolean screenContainsDynamicAttributes(View mainDatasourceView,
                                               java.lang.String screenId)

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

collectEntityClassesWithDynamicAttributes

protected java.util.Set<java.lang.Class> collectEntityClassesWithDynamicAttributes(@Nullable
                                                                                   View view)

collectEntityClasses

protected java.util.Set<java.lang.Class> collectEntityClasses(View view,
                                                              java.util.Set<View> visited)

initDefaultAttributeValues

public void initDefaultAttributeValues(BaseGenericIdEntity item,
                                       com.haulmont.chile.core.model.MetaClass metaClass)

listenCategoryChanges

public void listenCategoryChanges(Datasource ds)

attributeShouldBeShownOnTheScreen

protected boolean attributeShouldBeShownOnTheScreen(java.lang.String screen,
                                                    java.lang.String component,
                                                    CategoryAttribute attribute)

initEntityPickerField

public void initEntityPickerField(PickerField pickerField,
                                  CategoryAttribute categoryAttribute)

Initializes the pickerField for selecting the dynamic attribute value. If the CategoryAttribute has "where" or "join" clauses then the data in lookup screens will be filtered with these clauses

Parameters:

pickerField - PickerField component whose lookup action must be initialized

categoryAttribute - CategoryAttribute that is represented by the pickerField

createOptionsDatasourceForLookup

public CollectionDatasource createOptionsDatasourceForLookup(com.haulmont.chile.core.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

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

reloadDynamicAttributes

public void reloadDynamicAttributes(BaseGenericIdEntity entity)

Reload dynamic attributes on the entity