Package com.intellij.ide.projectView

Interface TreeStructureProvider

All Known Subinterfaces:

SelectableTreeStructureProvider

All Known Implementing Classes:

ClassesTreeStructureProvider, CompoundTreeStructureProvider, FormMergerTreeStructureProvider, NestingTreeStructureProvider, ProjectConfigurationDirectoryConcealer, PyTreeStructureProvider, ResourceBundleGrouper, ScratchProjectViewPane.MyStructureProvider, XsltTreeStructureProvider

public interface TreeStructureProvider

Allows a plugin to modify the structure of a project as displayed in the project view.

Field Summary

Fields

Modifier and Type	Field and Description
static ProjectExtensionPointName<TreeStructureProvider>	EP
static ExtensionPointName<TreeStructureProvider>	EP_NAME Deprecated. Use EP

Method Summary

Modifier and Type	Method and Description
default java.lang.Object	getData(java.util.Collection<AbstractTreeNode<?>> selected, 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.

Field Detail

EP

static final ProjectExtensionPointName<TreeStructureProvider> EP

EP_NAME

@Deprecated
static final ExtensionPointName<TreeStructureProvider> EP_NAME

Deprecated. Use EP

Method Detail

modify

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.

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

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

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

Parameters:

selected - 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