Component
org.nuxeo.ecm.platform.treeManager

plugin

Plugin extension point for the tree manager service.

Enables registration of plugins that will control document filter and
sorting.

Example of a plugin registration:

        <treeManagerPlugin name="navigation">
          <excludedFacets>
            <facet name="HiddenInNavigation" />
          </excludedFacets>
          <includedFacets>
            <facet name="Folderish" />
          </includedFacets>
          <excludedTypes>
            <type>Section</type>
          </excludedTypes>
          <sortPropertyPath>dc:title</sortPropertyPath>
          <filterClass>org.example.com.MyFilterClass</filterClass>
          <leafFilterClass>org.example.com.MyLeafFilterClass</leafFilterClass>
          <sorterClass>org.example.com.MySorterClass</sorterClass>
        </treeManagerPlugin>

• 
  excludedFacets: list of facets used to filter documents that should
  not appear in the tree
  


• 
  includedFacets: list of facets used to filter documents that should
  appear in the tree
  


• 
  excludedTypes: list of types used to filter documents that should not
  appear in the tree
  


• 
  sortPropertyPath: property path used to sort tree node children when
  using the default sorter
  


• 
  filterClass: the filter class has to implement the
  org.nuxeo.ecm.core.api.Filter interface. If it implements the
  org.nuxeo.ecm.webapp.tree.DocumentTreeFilter interface, the above
  filter properties will be set on it. Defaults to
  org.nuxeo.ecm.webapp.tree.DefaultDocumentTreeFilter class if not set.
  


• 
  leafFilterClass: filter that can decide that a document is shown
  with no children. The leaf filter class has to implement the
  org.nuxeo.ecm.core.api.Filter interface.
  


• 
  sorterClass: the sorter class has to implement the
  org.nuxeo.ecm.core.api.Sorter interface. If it implements the
  org.nuxeo.ecm.webapp.tree.DocumentTreeSorter interface, the above sort
  property will be set on it. Defaults to
  org.nuxeo.ecm.webapp.tree.DefaultDocumentTreeSorter class if not set.
  


• 
  queryModel: the query model (with one free parameter) to use to list
  the children of a document in the tree. When not defined, a core query
  using the filterClass and sorterClass is used.
  

• Object org.nuxeo.ecm.webapp.tree.TreeManagerPluginDescriptor