| /* |
| * Copyright 2000-2014 JetBrains s.r.o. |
| * |
| * Licensed under the Apache License, Version 2.0 (the "License"); |
| * you may not use this file except in compliance with the License. |
| * You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, software |
| * distributed under the License is distributed on an "AS IS" BASIS, |
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| * See the License for the specific language governing permissions and |
| * limitations under the License. |
| */ |
| package com.intellij.ide.structureView; |
| |
| import com.intellij.openapi.Disposable; |
| import com.intellij.openapi.editor.Editor; |
| import com.intellij.openapi.fileEditor.FileEditor; |
| import com.intellij.openapi.fileEditor.TextEditor; |
| import com.intellij.openapi.project.Project; |
| import com.intellij.openapi.util.Disposer; |
| import org.jetbrains.annotations.NotNull; |
| import org.jetbrains.annotations.Nullable; |
| |
| /** |
| * Default implementation of the {@link StructureViewBuilder} interface which uses the |
| * standard IDEA implementation of the {@link StructureView} component and allows to |
| * customize the data displayed in the structure view. |
| * |
| * @see StructureViewModel |
| * @see TextEditorBasedStructureViewModel |
| * @see com.intellij.lang.LanguageStructureViewBuilder#getStructureViewBuilder(com.intellij.psi.PsiFile) |
| */ |
| public abstract class TreeBasedStructureViewBuilder implements StructureViewBuilder { |
| /** |
| * @deprecated Use createStructureViewModel(Editor editor) |
| */ |
| @NotNull |
| @Deprecated |
| public StructureViewModel createStructureViewModel() { |
| throw new AbstractMethodError(); |
| } |
| |
| /** |
| * Returns the structure view model defining the data displayed in the structure view |
| * for a specific file. |
| * |
| * todo This method must be abstract, but due to compatibility reasons we wait IDEA 13 release |
| * |
| * @return the structure view model instance. |
| * @see TextEditorBasedStructureViewModel |
| */ |
| @NotNull |
| public StructureViewModel createStructureViewModel(@Nullable Editor editor) { |
| return createStructureViewModel(); |
| } |
| |
| @Override |
| @NotNull |
| public StructureView createStructureView(FileEditor fileEditor, @NotNull Project project) { |
| final StructureViewModel model = createStructureViewModel(fileEditor instanceof TextEditor ? ((TextEditor)fileEditor).getEditor() : null); |
| StructureView view = StructureViewFactory.getInstance(project).createStructureView(fileEditor, model, project, isRootNodeShown()); |
| Disposer.register(view, new Disposable() { |
| @Override |
| public void dispose() { |
| model.dispose(); |
| } |
| }); |
| return view; |
| } |
| |
| /** |
| * Override returning <code>false</code> if root node created by {@link #createStructureViewModel(Editor editor)} shall not be visible |
| * @return <code>false</code> if root node shall not be visible in structure tree. |
| */ |
| public boolean isRootNodeShown() { |
| return true; |
| } |
| } |