org.nuxeo.ecm.webengine.ui.tree.document
Class DocumentContentProvider

java.lang.Object
  org.nuxeo.ecm.webengine.ui.tree.document.DocumentContentProvider

All Implemented Interfaces:

java.io.Serializable, ContentProvider

Direct Known Subclasses:

SiteContentProvider

public class DocumentContentProvider
extends java.lang.Object
implements ContentProvider

Author:

Bogdan Stefanescu

See Also:

Serialized Form

Constructor Summary

DocumentContentProvider(CoreSession session)

Method Summary

java.lang.Object[]	getChildren(java.lang.Object obj) Gets the children for the given object.
java.lang.Object[]	getElements(java.lang.Object input) Gets the top level items.
java.lang.String[]	getFacets(java.lang.Object object) Gets the object facets.
java.lang.String	getLabel(java.lang.Object obj) Gets the label to be used when displaying the given object.
java.lang.String	getName(java.lang.Object obj) Gets the name of the object.
CoreSession	getSession()
boolean	isContainer(java.lang.Object obj) Whether the given object may have children (e.g it's a container).
void	setSession(CoreSession session)

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentContentProvider

public DocumentContentProvider(CoreSession session)

Method Detail

setSession

public void setSession(CoreSession session)

getSession

public CoreSession getSession()

getElements

public java.lang.Object[] getElements(java.lang.Object input)

Description copied from interface: ContentProvider

Gets the top level items.

The items will be shown on the top level of the tree. These items are computed from the tree input that will be considered the tree root. The tree root is not visible.

Specified by:

getElements in interface ContentProvider

Parameters:

input - the tree view input

Returns:

the top level items

getChildren

public java.lang.Object[] getChildren(java.lang.Object obj)

Description copied from interface: ContentProvider

Gets the children for the given object.

This method is used to populate the nested branches of the tree.

Specified by:

getChildren in interface ContentProvider

Parameters:

obj - the object

Returns:

the children or null if no children are supported

isContainer

public boolean isContainer(java.lang.Object obj)

Description copied from interface: ContentProvider

Whether the given object may have children (e.g it's a container).

Specified by:

isContainer in interface ContentProvider

Parameters:

obj - the object to test

Returns:

true if it may have children, false otherwise

getLabel

public java.lang.String getLabel(java.lang.Object obj)

Description copied from interface: ContentProvider

Gets the label to be used when displaying the given object.

Specified by:

getLabel in interface ContentProvider

Parameters:

obj - the object

Returns:

the label

getFacets

public java.lang.String[] getFacets(java.lang.Object object)

Description copied from interface: ContentProvider

Gets the object facets.

Facets are arbitrary strings that should describe object capabilities and can be used to decorate later the item.

In a web environment they may be translated to CSS classes.

Specified by:

getFacets in interface ContentProvider

Returns:

item facets

getName

public java.lang.String getName(java.lang.Object obj)

Description copied from interface: ContentProvider

Gets the name of the object.

The name must be an unique identifier relative to the parent item. It will be used as node names in the tree so that they will construct the item path.

Specified by:

getName in interface ContentProvider

Parameters:

obj - the object

Returns:

the name