Package ch.tocco.nice2.optional.newsletter.impl.tree

Class NewsletterTreeViewProvider

java.lang.Object

ch.tocco.nice2.dms.spi.tree.ui.AbstractContentTreeViewProvider

ch.tocco.nice2.optional.newsletter.impl.tree.NewsletterTreeViewProvider

All Implemented Interfaces:

EntityTreeViewProvider

@Component
public class NewsletterTreeViewProvider
extends AbstractContentTreeViewProvider

Nested Class Summary

Nested classes/interfaces inherited from interface ch.tocco.nice2.netui.api.tree.entity.EntityTreeViewProvider

EntityTreeViewProvider.EntityTreeViewProviderDescriptor, EntityTreeViewProvider.Icon, EntityTreeViewProvider.NotInTreeException

Field Summary

Fields inherited from class ch.tocco.nice2.dms.spi.tree.ui.AbstractContentTreeViewProvider

contentTreeContext, contentTreeService, context, entityTreeNodeFactory, permissionEvaluatorService, queryBuilderFactory

Constructor Summary

Constructors

Constructor	Description
NewsletterTreeViewProvider(ContentTreeService contentTreeService, Context context, EntityTreeNodeFactory entityTreeNodeFactory, QueryBuilderFactory queryBuilderFactory, ContentTreeNodePermissionEvaluatorService permissionEvaluatorService)

Method Summary

Modifier and Type	Method	Description
Map<String,Map<String,String>>	getCreateRelationMap()	Returns a table containing relations linking entities represented in the tree when creating new entities.
EntityTreeViewProvider.EntityTreeViewProviderDescriptor	getDescriptor()
Map<String,EntityTreeViewProvider.Icon>	getIconMap()
protected QueryBuilder	getRootChildrenQuery(TreeContext treeContext)
HashMap<String,Object>	getTreeConfig()	Allowed config properties are those of Ext.TreePanel and additionally the following: openAsRoot: [ true | false ] set opened entity as root of the tree dataRegistry: Map with dataregistry settings (optional): enabled: true / false entityModels: Array of Strings containing names of entity models to be tracked by dataregistry searchByRelation: the method EntityTreeViewProvider.getSearchResult(ch.tocco.nice2.persist.core.api.entity.Entity) is never used, it is rather searched by using related-by queries according to the relations between the involved entities as specified in EntityTreeViewProvider.getCreateRelationMap().

Methods inherited from class ch.tocco.nice2.dms.spi.tree.ui.AbstractContentTreeViewProvider

getChildren, getPath, getRoot, getRootChildren, getSearchResult, getTreeNode, moveAbove, moveBelow, moveInto

Methods inherited from class java.lang.Object

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

Constructor Details

NewsletterTreeViewProvider

public NewsletterTreeViewProvider(ContentTreeService contentTreeService,
 Context context,
 EntityTreeNodeFactory entityTreeNodeFactory,
 QueryBuilderFactory queryBuilderFactory,
 ContentTreeNodePermissionEvaluatorService permissionEvaluatorService)

Method Details

getIconMap

public Map<String,EntityTreeViewProvider.Icon> getIconMap()

getDescriptor

public EntityTreeViewProvider.EntityTreeViewProviderDescriptor getDescriptor()

getTreeConfig

public HashMap<String,Object> getTreeConfig()

Description copied from interface: EntityTreeViewProvider

Allowed config properties are those of Ext.TreePanel and additionally the following:

• openAsRoot: [ true | false ] set opened entity as root of the tree
• dataRegistry: Map with dataregistry settings (optional):
  • enabled: true / false
  • entityModels: Array of Strings containing names of entity models to be tracked by dataregistry
• searchByRelation: the method EntityTreeViewProvider.getSearchResult(ch.tocco.nice2.persist.core.api.entity.Entity) is never used, it is rather searched by using related-by queries according to the relations between the involved entities as specified in EntityTreeViewProvider.getCreateRelationMap().

Specified by:

getTreeConfig in interface EntityTreeViewProvider

Overrides:

getTreeConfig in class AbstractContentTreeViewProvider

Returns:

a map containing additional settings for the DwrTreePanel

getCreateRelationMap

public Map<String,Map<String,String>> getCreateRelationMap()

Description copied from interface: EntityTreeViewProvider

Returns a table containing relations linking entities represented in the tree when creating new entities.

     {entity_to_be_created: {
              entity_selected_in_tree: "relation from entity_selected_in_tree to entity_to_be_created"
         }
     }
 

If there's no entry in the table for a specific combination, there is no relation filled in the create form.

Returns:

create relation table

getRootChildrenQuery

protected QueryBuilder getRootChildrenQuery(TreeContext treeContext)
                                     throws PersistException

Overrides:

getRootChildrenQuery in class AbstractContentTreeViewProvider

Throws:

PersistException