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