DirectoryTreeDescriptor (Nuxeo ECM Projects 8.10-SNAPSHOT API)

java.lang.Object
- org.nuxeo.ecm.webapp.directory.DirectoryTreeDescriptor

public class DirectoryTreeDescriptor
extends Object

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ACTION_ID_PREFIX`
`protected String`	`contentView` Content view to be updated on node selection
`static String`	`DIR_ACTION_CATEGORY`
`protected String[]`	`directories` List of directories ids used to build the classification tree.
`protected Boolean`	`enabled`
`protected String`	`fieldName` Name of the QueryModel field that will be used updated on node selection.
`protected boolean`	`isNavigationTree`
`protected String`	`label` Label to be displayed as the root of the tree (description field).
`protected Boolean`	`multiselect` Allows the selection of several nodes of the tree.
`protected String`	`name`
`static String`	`NAV_ACTION_CATEGORY`
`protected Integer`	`order`
`protected String`	`outcome` Id of the faces navigation case to return on node selection.
`protected String`	`schemaName` Name of the QueryModel schema for the field that will be used updated on node selection.
`static String`	`VOCABULARY_SCHEMA` Deprecated. since 5.6, supports other schemas than 'vocabulary' and 'xvocabulary'.
`static String`	`XVOCABULARY_SCHEMA` Deprecated. since 5.6, supports other schemas than 'vocabulary' and 'xvocabulary'.

Constructor Summary

Constructors
Constructor and Description

DirectoryTreeDescriptor()

Constructors
Constructor and Description
`DirectoryTreeDescriptor()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DirectoryTreeDescriptor`	`clone()`
`protected Action`	`getAction()` Helper to register a simple action based on the given descriptor
`String`	`getContentView()`
`String[]`	`getDirectories()`
`Boolean`	`getEnabled()`
`String`	`getFieldName()`
`String`	`getLabel()`
`String`	`getName()`
`Integer`	`getOrder()`
`String`	`getOutcome()`
`String`	`getSchemaName()`
`boolean`	`hasContentViewSupport()`
`boolean`	`isMultiselect()`
`boolean`	`isNavigationTree()`
`void`	`merge(DirectoryTreeDescriptor other)`
`void`	`setDirectories(String[] directories)`

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - ACTION_ID_PREFIX
```
public static final String ACTION_ID_PREFIX
```
    Since:
    
    6.0
    
    See Also:
    
    Constant Field Values
  - NAV_ACTION_CATEGORY
```
public static final String NAV_ACTION_CATEGORY
```
    Since:
    
    6.0
    
    See Also:
    
    Constant Field Values
  - DIR_ACTION_CATEGORY
```
public static final String DIR_ACTION_CATEGORY
```
    Since:
    
    6.0
    
    See Also:
    
    Constant Field Values
  - VOCABULARY_SCHEMA
```
@Deprecated
public static final String VOCABULARY_SCHEMA
```
    Deprecated. since 5.6, supports other schemas than 'vocabulary' and 'xvocabulary'.
    
    See Also:
    
    Constant Field Values
  - XVOCABULARY_SCHEMA
```
@Deprecated
public static final String XVOCABULARY_SCHEMA
```
    Deprecated. since 5.6, supports other schemas than 'vocabulary' and 'xvocabulary'.
    
    See Also:
    
    Constant Field Values
  - name
```
protected String name
```
  - enabled
```
protected Boolean enabled
```
  - isNavigationTree
```
protected boolean isNavigationTree
```
  - label
```
protected String label
```
    Label to be displayed as the root of the tree (description field).
  - contentView
```
protected String contentView
```
    Content view to be updated on node selection
  - fieldName
```
protected String fieldName
```
    Name of the QueryModel field that will be used updated on node selection.
  - schemaName
```
protected String schemaName
```
    Name of the QueryModel schema for the field that will be used updated on node selection.
  - outcome
```
protected String outcome
```
    Id of the faces navigation case to return on node selection.
  - multiselect
```
protected Boolean multiselect
```
    Allows the selection of several nodes of the tree.
  - directories
```
protected String[] directories
```
    List of directories ids used to build the classification tree.
  - order
```
protected Integer order
```
    Since:
    
    6.0
- Constructor Detail
  - DirectoryTreeDescriptor
```
public DirectoryTreeDescriptor()
```
- Method Detail
  - setDirectories
```
public void setDirectories(String[] directories)
                    throws DirectoryException
```
    Throws:
    
    DirectoryException
  - getFieldName
```
public String getFieldName()
```
  - getName
```
public String getName()
```
  - getDirectories
```
public String[] getDirectories()
```
  - getLabel
```
public String getLabel()
```
  - isMultiselect
```
public boolean isMultiselect()
```
  - getOutcome
```
public String getOutcome()
```
  - getContentView
```
public String getContentView()
```
  - getSchemaName
```
public String getSchemaName()
```
  - getEnabled
```
public Boolean getEnabled()
```
  - isNavigationTree
```
public boolean isNavigationTree()
```
  - hasContentViewSupport
```
public boolean hasContentViewSupport()
```
  - getOrder
```
public Integer getOrder()
```
    Since:
    
    6.0
  - merge
```
public void merge(DirectoryTreeDescriptor other)
```
  - clone
```
public DirectoryTreeDescriptor clone()
```
    Overrides:
    
    clone in class Object
  - getAction
```
protected Action getAction()
```
    Helper to register a simple action based on the given descriptor
    
    Since:
    
    6.0

Class DirectoryTreeDescriptor

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ACTION_ID_PREFIX

NAV_ACTION_CATEGORY

DIR_ACTION_CATEGORY

VOCABULARY_SCHEMA

XVOCABULARY_SCHEMA

name

enabled

isNavigationTree

label

contentView

fieldName

schemaName

outcome

multiselect

directories

order

Constructor Detail

DirectoryTreeDescriptor

Method Detail

setDirectories

getFieldName

getName

getDirectories

getLabel

isMultiselect

getOutcome

getContentView

getSchemaName

getEnabled

isNavigationTree

hasContentViewSupport

getOrder

merge

clone

getAction