Package com.intellij.ide.projectView.impl

Class NestingTreeStructureProvider

java.lang.Object

com.intellij.ide.projectView.impl.NestingTreeStructureProvider

All Implemented Interfaces:

TreeStructureProvider, DumbAware

public class NestingTreeStructureProvider
extends java.lang.Object
implements TreeStructureProvider, DumbAware

NestingTreeStructureProvider moves some files in the Project View to be shown as children of another peer file. Standard use case is to improve folder contents presentation when it contains both source file and its compiled output. For example generated foo.min.js file will be shown as a child of foo.js file.
Nesting logic is based on file names only. Rules about files that should be nested are provided by com.intellij.projectViewNestingRulesProvider extensions.

See Also:

ProjectViewNestingRulesProvider, ProjectViewFileNestingService, FileNestingInProjectViewDialog

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NestingTreeStructureProvider.ChildFileInfo

Field Summary

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

EP, EP_NAME

Constructor Summary

Constructors

Constructor and Description
NestingTreeStructureProvider()

Method Summary

Modifier and Type	Method and Description
static java.util.Collection<NestingTreeStructureProvider.ChildFileInfo>	getFilesShownAsChildrenInProjectView(Project project, VirtualFile parentFile)
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

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

getData

Constructor Detail

NestingTreeStructureProvider

public NestingTreeStructureProvider()

Method Detail

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.

getFilesShownAsChildrenInProjectView

public static java.util.Collection<NestingTreeStructureProvider.ChildFileInfo> getFilesShownAsChildrenInProjectView(Project project,
                                                                                                                    VirtualFile parentFile)