com.intellij.ide.actions.ViewStructureAction.java Source code

Introduction

Here is the source code for com.intellij.ide.actions.ViewStructureAction.java

Source

/*
 * Copyright 2000-2011 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.actions;

import com.intellij.featureStatistics.FeatureUsageTracker;
import com.intellij.ide.structureView.StructureView;
import com.intellij.ide.structureView.StructureViewBuilder;
import com.intellij.ide.structureView.StructureViewModel;
import com.intellij.ide.util.FileStructureDialog;
import com.intellij.ide.util.FileStructurePopup;
import com.intellij.openapi.Disposable;
import com.intellij.openapi.actionSystem.AnAction;
import com.intellij.openapi.actionSystem.AnActionEvent;
import com.intellij.openapi.actionSystem.CommonDataKeys;
import com.intellij.openapi.actionSystem.PlatformDataKeys;
import com.intellij.openapi.editor.Editor;
import com.intellij.openapi.fileEditor.FileEditor;
import com.intellij.openapi.project.Project;
import com.intellij.openapi.ui.DialogWrapper;
import com.intellij.openapi.util.registry.Registry;
import com.intellij.openapi.vfs.VirtualFile;
import com.intellij.pom.Navigatable;
import com.intellij.psi.PsiDocumentManager;
import com.intellij.psi.PsiFile;
import com.intellij.ui.PlaceHolder;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

public class ViewStructureAction extends AnAction {
    private static final String PLACE = "StructureViewPopup";

    public ViewStructureAction() {
        setEnabledInModalContext(true);
    }

    @Override
    public void actionPerformed(AnActionEvent e) {
        Project project = e.getData(CommonDataKeys.PROJECT);
        if (project == null)
            return;
        final FileEditor fileEditor = e.getData(PlatformDataKeys.FILE_EDITOR);
        if (fileEditor == null)
            return;
        final VirtualFile virtualFile;

        final Editor editor = e.getData(CommonDataKeys.EDITOR);
        if (editor != null) {
            PsiDocumentManager.getInstance(project).commitDocument(editor.getDocument());
            PsiFile psiFile = PsiDocumentManager.getInstance(project).getPsiFile(editor.getDocument());
            if (psiFile == null)
                return;

            virtualFile = psiFile.getVirtualFile();
        } else {
            virtualFile = e.getData(CommonDataKeys.VIRTUAL_FILE);
        }
        String title = virtualFile == null ? fileEditor.getName() : virtualFile.getName();

        FeatureUsageTracker.getInstance().triggerFeatureUsed("navigation.popup.file.structure");

        Navigatable navigatable = e.getData(CommonDataKeys.NAVIGATABLE);
        if (Registry.is("file.structure.tree.mode")) {
            FileStructurePopup popup = createPopup(project, fileEditor);
            if (popup == null)
                return;

            popup.setTitle(title);
            popup.show();
        } else {
            DialogWrapper dialog = createDialog(editor, project, navigatable, fileEditor);
            if (dialog == null)
                return;

            dialog.setTitle(title);
            dialog.show();
        }
    }

    @Nullable
    private static DialogWrapper createDialog(@Nullable Editor editor, @NotNull Project project,
            @Nullable Navigatable navigatable, @NotNull FileEditor fileEditor) {
        final StructureViewBuilder structureViewBuilder = fileEditor.getStructureViewBuilder();
        if (structureViewBuilder == null)
            return null;
        StructureView structureView = structureViewBuilder.createStructureView(fileEditor, project);
        return createStructureViewBasedDialog(structureView.getTreeModel(), editor, project, navigatable,
                structureView);
    }

    @Nullable
    public static FileStructurePopup createPopup(@NotNull Project project, @NotNull FileEditor fileEditor) {
        StructureViewBuilder structureViewBuilder = fileEditor.getStructureViewBuilder();
        if (structureViewBuilder == null)
            return null;
        StructureView structureView = structureViewBuilder.createStructureView(fileEditor, project);
        StructureViewModel model = structureView.getTreeModel();
        if (model instanceof PlaceHolder) {
            //noinspection unchecked
            ((PlaceHolder) model).setPlace(PLACE);
        }
        return createStructureViewPopup(project, fileEditor, structureView);
    }

    public static boolean isInStructureViewPopup(@NotNull PlaceHolder<String> model) {
        return PLACE.equals(model.getPlace());
    }

    private static FileStructureDialog createStructureViewBasedDialog(StructureViewModel structureViewModel,
            Editor editor, Project project, Navigatable navigatable, @NotNull Disposable alternativeDisposable) {
        return new FileStructureDialog(structureViewModel, editor, project, navigatable, alternativeDisposable,
                true);
    }

    private static FileStructurePopup createStructureViewPopup(Project project, FileEditor fileEditor,
            StructureView structureView) {
        return new FileStructurePopup(project, fileEditor, structureView, true);
    }

    @Override
    public void update(AnActionEvent e) {
        Project project = e.getData(CommonDataKeys.PROJECT);
        if (project == null) {
            e.getPresentation().setEnabled(false);
            return;
        }

        FileEditor fileEditor = e.getData(PlatformDataKeys.FILE_EDITOR);
        e.getPresentation().setEnabled(fileEditor != null && fileEditor.getStructureViewBuilder() != null);
    }
}