This tutorial is meant to illustrate how the project tree structure view appearance can be modified programmatically. If you need to know more about basic concepts of a project view in Consulo-based IDEs, please refer to the Exploring The Project Structure section of the Consulo documentation.

Series of step below show how to filter out and keep visible only text files and directories in the Project View Panel.

Pre-Requirements

Create an empty plugin project. See Creating a Plugin Project.

1. Implement Custom TreeStructureProvider

To provide custom Structure View behaviour you need to implement the TreeStructureProvider interface. In Consulo, TreeStructureProvider is annotated with @ExtensionAPI, so implementations are registered using the @ExtensionImpl annotation instead of XML.

@ExtensionImpl
public class TextOnlyTreeStructureProvider implements TreeStructureProvider {
    @NotNull
    @Override
    public Collection<AbstractTreeNode> modify(@NotNull AbstractTreeNode parent, @NotNull Collection<AbstractTreeNode> children, ViewSettings settings) {
        return null;
    }

    @Nullable
    @Override
    public Object getData(Collection<AbstractTreeNode> collection, String s) {
        return null;
    }
}

2. Override modify() Method

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

package org.consulo.sdk.treeStructureProvider;

import consulo.annotation.component.ExtensionImpl;
import consulo.project.ui.view.TreeStructureProvider;
import consulo.project.ui.view.ViewSettings;
import consulo.project.ui.view.internal.node.PsiFileNode;
import consulo.ui.ex.tree.AbstractTreeNode;
import consulo.language.plain.PlainTextFileType;
import consulo.virtualFileSystem.VirtualFile;

import jakarta.annotation.Nonnull;

import java.util.ArrayList;
import java.util.Collection;

@ExtensionImpl
final class TextOnlyTreeStructureProvider implements TreeStructureProvider {

  @Nonnull
  @Override
  public Collection<AbstractTreeNode<?>> modify(@Nonnull AbstractTreeNode<?> parent,
                                                @Nonnull 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;
  }

}

3. Compile and Run the Plugin

Compile and run the code sample from this tutorial. Refer to Running and Debugging a Plugin.

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

Build the project to see how TreeStructureView provider works in practice.