IntelliJ Platform Plugin SDK Help

Modifying Project View Structure

This tutorial is meant to illustrate how the project tree structure view appearance can be modified programmatically.

This topic describes the treeStructureProvider sample plugin.

The steps below show how to filter out and keep visible only text files and directories in the Project View Panel.

Other use cases include:

Register Custom TreeStructure Provider

Add new com.intellij.treeStructureProvider extension to the plugin.xml

<extensions defaultExtensionNs="com.intellij"> <treeStructureProvider implementation="org.intellij.sdk.treeStructureProvider.TextOnlyTreeStructureProvider"/> </extensions>

Implement Custom TreeStructureProvider

To provide custom Structure View behaviour, implement TreeStructureProvider with the nodes filtering logic in modify() method. The example below shows how to filter out all the Project View nodes except those which correspond to text files and directories.

// Copyright 2000-2022 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file. package org.intellij.sdk.treeStructureProvider; import com.intellij.ide.projectView.TreeStructureProvider; import com.intellij.ide.projectView.ViewSettings; import com.intellij.ide.projectView.impl.nodes.PsiFileNode; import com.intellij.ide.util.treeView.AbstractTreeNode; import com.intellij.openapi.fileTypes.PlainTextFileType; import com.intellij.openapi.vfs.VirtualFile; import org.jetbrains.annotations.NotNull; import java.util.ArrayList; import java.util.Collection; public class TextOnlyTreeStructureProvider implements TreeStructureProvider { @NotNull @Override public Collection<AbstractTreeNode<?>> modify(@NotNull AbstractTreeNode<?> parent, @NotNull Collection<AbstractTreeNode<?>> children, ViewSettings settings) { ArrayList<AbstractTreeNode<?>> nodes = new ArrayList<>(); for (AbstractTreeNode<?> child : children) { if (child instanceof PsiFileNode) { VirtualFile file = ((PsiFileNode) child).getVirtualFile(); if (file != null && !file.isDirectory() && !(file.getFileType() instanceof PlainTextFileType)) { continue; } } nodes.add(child); } return nodes; } }

Compile and Run the Plugin

See Code Samples on how to set up and run the plugin.

After going through the steps described above, you can see only text files and directories belonging to a project in the Project View.

Text Files
Last modified: 15 August 2022