Package com.intellij.ide.projectView.impl

Class CompoundTreeStructureProvider

java.lang.Object

com.intellij.ide.projectView.impl.CompoundTreeStructureProvider

All Implemented Interfaces:

TreeStructureProvider

public final class CompoundTreeStructureProvider
extends java.lang.Object
implements TreeStructureProvider

This class is intended to combine all providers for batch usages.

Field Summary

Fields inherited from interface com.intellij.ide.projectView.TreeStructureProvider

EP, EP_NAME

Constructor Summary

Constructors

Constructor and Description
CompoundTreeStructureProvider(Project project)

Method Summary

Modifier and Type	Method and Description
static TreeStructureProvider	get(Project project)
java.lang.Object	getData(java.util.Collection<AbstractTreeNode<?>> selection, java.lang.String dataId) Returns a user data object of the specified type for the specified selection in the project view.
java.util.Collection<AbstractTreeNode<?>>	modify(AbstractTreeNode<?> parent, java.util.Collection<AbstractTreeNode<?>> children, ViewSettings settings) Allows a plugin to modify the list of children displayed for the specified node in the project view.

Methods inherited from class java.lang.Object

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

Constructor Detail

CompoundTreeStructureProvider

public CompoundTreeStructureProvider(Project project)

Method Detail

get

public static TreeStructureProvider get(Project project)

Returns:

a shared instance for the specified project

modify

public java.util.Collection<AbstractTreeNode<?>> modify(AbstractTreeNode<?> parent,
                                                        java.util.Collection<AbstractTreeNode<?>> children,
                                                        ViewSettings settings)

Description copied from interface: TreeStructureProvider

Allows a plugin to modify the list of children displayed for the specified node in the project view.

Specified by:

modify in interface TreeStructureProvider

Parameters:

parent - the parent node.

children - the list of child nodes according to the default project structure. Elements of the collection are of type ProjectViewNode.

settings - the current project view settings.

Returns:

the modified collection of child nodes, or children if no modifications are required.

getData

public java.lang.Object getData(java.util.Collection<AbstractTreeNode<?>> selection,
                                java.lang.String dataId)

Description copied from interface: TreeStructureProvider

Returns a user data object of the specified type for the specified selection in the project view.

Specified by:

getData in interface TreeStructureProvider

Parameters:

selection - the list of nodes currently selected in the project view.

dataId - the identifier of the requested data object (for example, as defined in PlatformDataKeys)

Returns:

the data object, or null if no data object can be returned by this provider.

See Also:

DataProvider