[tabs] PanelWithActionsAndCloseButton uses proper close method that disposes individu...
[idea/community.git] / platform / platform-impl / src / com / intellij / util / ContentUtilEx.java
1 /*
2  * Copyright 2000-2015 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.util;
17
18 import com.intellij.ide.util.PropertiesComponent;
19 import com.intellij.openapi.Disposable;
20 import com.intellij.openapi.util.*;
21 import com.intellij.ui.content.Content;
22 import com.intellij.ui.content.ContentFactory;
23 import com.intellij.ui.content.ContentManager;
24 import com.intellij.ui.content.TabbedContent;
25 import com.intellij.ui.content.impl.TabbedContentImpl;
26 import com.intellij.util.containers.ContainerUtil;
27 import org.jetbrains.annotations.NotNull;
28 import org.jetbrains.annotations.Nullable;
29
30 import javax.swing.*;
31 import java.util.ArrayList;
32 import java.util.List;
33
34 /**
35  * @author Konstantin Bulenkov
36  */
37 public class ContentUtilEx extends ContentsUtil {
38
39   public static void addTabbedContent(ContentManager manager, JComponent contentComponent, String groupPrefix, String tabName, boolean select) {
40     addTabbedContent(manager, contentComponent, groupPrefix, tabName, select, null);
41   }
42
43   public static void addTabbedContent(ContentManager manager, JComponent contentComponent, String groupPrefix, String tabName, boolean select, @Nullable Disposable childDisposable) {
44     if (PropertiesComponent.getInstance().getBoolean(TabbedContent.SPLIT_PROPERTY_PREFIX + groupPrefix)) {
45       final Content content = ContentFactory.SERVICE.getInstance().createContent(contentComponent, getFullName(groupPrefix, tabName), true);
46       content.putUserData(Content.TABBED_CONTENT_KEY, Boolean.TRUE);
47       content.putUserData(Content.TAB_GROUP_NAME_KEY, groupPrefix);
48
49       for (Content c : manager.getContents()) {
50         if (c.getComponent() == contentComponent) {
51           if (select) {
52             manager.setSelectedContent(c);
53           }
54           return;
55         }
56       }
57       addContent(manager, content, select);
58
59       registerDisposable(content, childDisposable, contentComponent);
60
61       return;
62     }
63
64     TabbedContent tabbedContent = findTabbedContent(manager, groupPrefix);
65
66     if (tabbedContent == null) {
67       final Disposable disposable = Disposer.newDisposable();
68       tabbedContent = new TabbedContentImpl(contentComponent, tabName, true, groupPrefix);
69       ContentsUtil.addOrReplaceContent(manager, tabbedContent, select);
70       Disposer.register(tabbedContent, disposable);
71     }
72     else {
73       for (Pair<String, JComponent> tab : new ArrayList<Pair<String, JComponent>>(tabbedContent.getTabs())) {
74         if (Comparing.equal(tab.second, contentComponent)) {
75           tabbedContent.removeContent(tab.second);
76         }
77       }
78       if (select) {
79         manager.setSelectedContent(tabbedContent, true, true);
80       }
81       tabbedContent.addContent(contentComponent, tabName, true);
82     }
83
84     registerDisposable(tabbedContent, childDisposable, contentComponent);
85   }
86
87   private static void registerDisposable(@NotNull Content content,
88                                          @Nullable Disposable childDisposable,
89                                          @NotNull JComponent contentComponent) {
90     if (childDisposable != null) {
91       Disposer.register(content, childDisposable);
92       assert contentComponent.getClientProperty(DISPOSABLE_KEY) == null;
93       contentComponent.putClientProperty(DISPOSABLE_KEY, childDisposable);
94       Disposer.register(childDisposable, () -> contentComponent.putClientProperty(DISPOSABLE_KEY, null));
95     }
96     else {
97       Object disposableByKey = contentComponent.getClientProperty(DISPOSABLE_KEY);
98       if (disposableByKey != null && disposableByKey instanceof Disposable) {
99         Disposer.register(content, (Disposable)disposableByKey);
100       }
101     }
102   }
103
104   @Nullable
105   public static TabbedContent findTabbedContent(@NotNull ContentManager manager, @NotNull String groupPrefix) {
106     TabbedContent tabbedContent = null;
107     for (Content content : manager.getContents()) {
108       if (content instanceof TabbedContent && content.getTabName().startsWith(getFullPrefix(groupPrefix))) {
109         tabbedContent = (TabbedContent)content;
110         break;
111       }
112     }
113     return tabbedContent;
114   }
115
116   public static boolean isContentTab(@NotNull Content content, @NotNull String groupPrefix) {
117     return (content instanceof TabbedContent && content.getTabName().startsWith(getFullPrefix(groupPrefix))) ||
118            groupPrefix.equals(content.getUserData(Content.TAB_GROUP_NAME_KEY));
119   }
120
121   @NotNull
122   public static String getFullName(@NotNull String groupPrefix, @NotNull String tabName) {
123     return getFullPrefix(groupPrefix) + tabName;
124   }
125
126   @NotNull
127   private static String getFullPrefix(@NotNull String groupPrefix) {
128     return groupPrefix + ": ";
129   }
130
131   /**
132    * Searches through all {@link Content simple} and {@link TabbedContent tabbed} contents of the given ContentManager,
133    * and selects the one which holds the specified {@code contentComponent}.
134    *
135    * @return true if the necessary content was found (and thus selected) among content components of the given ContentManager.
136    */
137   public static boolean selectContent(@NotNull ContentManager manager, @NotNull final JComponent contentComponent, boolean requestFocus) {
138     for (Content content : manager.getContents()) {
139       if (content instanceof TabbedContentImpl) {
140         boolean found = ((TabbedContentImpl)content).findAndSelectContent(contentComponent);
141         if (found) {
142           manager.setSelectedContent(content, requestFocus);
143           return true;
144         }
145       }
146       else if (Comparing.equal(content.getComponent(), contentComponent)) {
147         manager.setSelectedContent(content, requestFocus);
148         return true;
149       }
150     }
151     return false;
152   }
153
154   /**
155    * Searches through all {@link Content simple} and {@link TabbedContent tabbed} contents of the given ContentManager,
156    * trying to find the first one which matches the given condition.
157    */
158   @Nullable
159   public static JComponent findContentComponent(@NotNull ContentManager manager, @NotNull Condition<JComponent> condition) {
160     for (Content content : manager.getContents()) {
161       if (content instanceof TabbedContentImpl) {
162         List<Pair<String, JComponent>> tabs = ((TabbedContentImpl)content).getTabs();
163         for (Pair<String, JComponent> tab : tabs) {
164           if (condition.value(tab.second)) {
165             return tab.second;
166           }
167         }
168       }
169       else if (condition.value(content.getComponent())) {
170         return content.getComponent();
171       }
172     }
173     return null;
174   }
175
176   public static int getSelectedTab(@NotNull TabbedContent content) {
177     final JComponent current = content.getComponent();
178     int index = 0;
179     for (Pair<String, JComponent> tab : content.getTabs()) {
180       if (tab.second == current) {
181         return index;
182       }
183       index++;
184     }
185     return -1;
186   }
187 }