lvcs-impl
[idea/community.git] / lang-api / src / com / intellij / ide / structureView / TreeBasedStructureViewBuilder.java
1 /*
2  * Copyright 2000-2007 JetBrains s.r.o.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 package com.intellij.ide.structureView;
17
18 import com.intellij.openapi.fileEditor.FileEditor;
19 import com.intellij.openapi.project.Project;
20 import org.jetbrains.annotations.NotNull;
21
22
23 /**
24  * Default implementation of the {@link StructureViewBuilder} interface which uses the
25  * standard IDEA implementation of the {@link StructureView} component and allows to
26  * customize the data displayed in the structure view.
27  *
28  * @see StructureViewModel
29  * @see TextEditorBasedStructureViewModel
30  * @see com.intellij.lang.LanguageStructureViewBuilder#getStructureViewBuilder(com.intellij.psi.PsiFile)
31  */
32 public abstract class TreeBasedStructureViewBuilder implements StructureViewBuilder {
33   /**
34    * Returns the structure view model defining the data displayed in the structure view
35    * for a specific file.
36    *
37    * @return the structure view model instance.
38    * @see TextEditorBasedStructureViewModel
39    */
40   @NotNull
41   public abstract StructureViewModel createStructureViewModel();
42
43   @NotNull
44   public StructureView createStructureView(FileEditor fileEditor, Project project) {
45     return StructureViewFactory.getInstance(project).createStructureView(fileEditor, createStructureViewModel(), project, isRootNodeShown());
46   }
47
48   /**
49    * Override returning <code>false</code> if root node created by {@link #createStructureViewModel()} shall not be visible
50    * @return <code>false</code> if root node shall not be visible in structure tree.
51    */
52   public boolean isRootNodeShown() {
53     return true;
54   }
55 }