lang-api
[idea/community.git] / platform / lang-api / src / com / intellij / ide / IdeView.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
17 package com.intellij.ide;
18
19 import com.intellij.psi.PsiDirectory;
20 import com.intellij.psi.PsiElement;
21 import org.jetbrains.annotations.Nullable;
22
23 /**
24  * Common interface for IDE views where files can be selected (project view, packages view,
25  * favorites or commander).
26  *
27  * @since 5.1
28  * @see com.intellij.openapi.actionSystem.DataConstants#IDE_VIEW
29  */
30 public interface IdeView {
31   /**
32    * Selects the specified element in the view.
33    *
34    * @param element the element to select.
35    */
36   void selectElement(PsiElement element);
37
38   /**
39    * Returns the list of directories corresponding to the element currently selected in the view.
40    * Can return a list of multiple elements if a package is selected.
41    *
42    * @return the list of directories, or an empty array if nothing is selected.
43    */
44   PsiDirectory[] getDirectories();
45
46   /**
47    * Returns the directory for the element currently selected in the view. If multiple directories
48    * correspond to the selected element, shows a popup allowing the user to choose one of them.
49    *
50    * @return the selected directory, or null if there is no selection or the popup was cancelled.
51    */
52   @Nullable
53   PsiDirectory getOrChooseDirectory();
54 }