Package ch.tocco.nice2.netui.api.tree.entity

Interface EntityTreeViewProvider

All Known Implementing Classes:

AbstractContentTreeViewProvider, AbstractDmsTreeViewProvider, CmsTreeViewProvider, DmsTreeViewProvider, EntityDocTreeViewProvider, FolderTreeViewProvider, NewsletterTreeViewProvider, PersonalFolderTreeViewProvider, PublicDmsTreeViewProvider

public interface EntityTreeViewProvider

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	EntityTreeViewProvider.EntityTreeViewProviderDescriptor
static class	EntityTreeViewProvider.Icon
static class	EntityTreeViewProvider.NotInTreeException

Method Summary

Modifier and Type	Method	Description
List<EntityTreeNode>	getChildren(Entity entity)
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()
List<Entity>	getPath(Entity entity)	Load all parents of the passed entity into a list
@Nullable EntityTreeNode	getRoot()
List<EntityTreeNode>	getRootChildren(TreeContext treeContext)
List<Entity>	getSearchResult(Entity entity)	Remote method for click event on tree nodes which cannot be displayed in the current entity explorer
Map<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 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 getCreateRelationMap().
EntityTreeNode	getTreeNode(Entity entity)	Get a tree node for a specific entity.
void	moveAbove(Entity source, Entity target)
void	moveBelow(Entity source, Entity target)
void	moveInto(Entity source, Entity target)

Method Details

getDescriptor

EntityTreeViewProvider.EntityTreeViewProviderDescriptor getDescriptor()

getRoot

@Nullable
@Nullable EntityTreeNode getRoot()

Returns:

the root tree node, when opening the module

getChildren

List<EntityTreeNode> getChildren(Entity entity)
                          throws TreeModelException

Parameters:

entity - reference entity

Returns:

a list of EntityTreeNode representing the children for the passed entity

Throws:

TreeModelException

getRootChildren

List<EntityTreeNode> getRootChildren(TreeContext treeContext)
                              throws TreeModelException

Returns:

a list of EntityTreeNode representing the children for the root tree node

Throws:

TreeModelException

getPath

List<Entity> getPath(Entity entity)
              throws EntityTreeViewProvider.NotInTreeException

Load all parents of the passed entity into a list

Parameters:

entity - leaf entity

Returns:

a list of entities representing the path from the root entity to the entity itself

Throws:

EntityTreeViewProvider.NotInTreeException

getSearchResult

List<Entity> getSearchResult(Entity entity)
                      throws TreeModelException

Remote method for click event on tree nodes which cannot be displayed in the current entity explorer

Parameters:

entity - the entity contained in the tree node that fired the event

Returns:

a list of entities that should be displayed in the default list form (could be of any model, only displaying entities of the current module)

Throws:

TreeModelException

getTreeNode

EntityTreeNode getTreeNode(Entity entity)
                    throws TreeModelException

Get a tree node for a specific entity. This method is called, when new values may be available and the node needs to be reloaded

Parameters:

entity - the reference entity

Returns:

representing EntityTreeNode

Throws:

TreeModelException

getTreeConfig

Map<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 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 getCreateRelationMap().

Returns:

a map containing additional settings for the DwrTreePanel

getIconMap

Map<String,EntityTreeViewProvider.Icon> getIconMap()

getCreateRelationMap

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

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

moveInto

void moveInto(Entity source,
 Entity target)
       throws TreeModelException

Throws:

TreeModelException

moveAbove

void moveAbove(Entity source,
 Entity target)
        throws TreeModelException

Throws:

TreeModelException

moveBelow

void moveBelow(Entity source,
 Entity target)
        throws TreeModelException

Throws:

TreeModelException