replaced <code></code> with more concise {@code}
[idea/community.git] / platform / platform-api / src / com / intellij / ui / JBSplitter.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.ui;
17
18 import com.intellij.ide.util.PropertiesComponent;
19 import com.intellij.openapi.ui.Splitter;
20 import com.intellij.openapi.util.text.StringUtil;
21 import org.jetbrains.annotations.NotNull;
22 import org.jetbrains.annotations.Nullable;
23
24 /**
25  * Major difference between the parent class and {@code JBSplitter} is an ability to save proportion
26  *
27  * @author Konstantin Bulenkov
28  * @see Splitter
29  */
30 public class JBSplitter extends Splitter {
31   /**
32    * Used as a key to save and load proportion
33    */
34   @Nullable
35   private String mySplitterProportionKey = null;
36   private final float myDefaultProportion;
37
38   public JBSplitter() {
39     super();
40
41     myDefaultProportion = 0.5f;
42   }
43
44   public JBSplitter(@NotNull String proportionKey, float defaultProportion) {
45     this(false, proportionKey, defaultProportion);
46   }
47
48   public JBSplitter(boolean vertical, @NotNull String proportionKey, float defaultProportion) {
49     super(vertical, defaultProportion);
50
51     mySplitterProportionKey = proportionKey;
52     myDefaultProportion = defaultProportion;
53   }
54
55   public JBSplitter(boolean vertical) {
56     super(vertical);
57
58     myDefaultProportion = 0.5f;
59   }
60
61   public JBSplitter(boolean vertical, float proportion) {
62     super(vertical, proportion);
63
64     myDefaultProportion = proportion;
65   }
66
67   public JBSplitter(float proportion) {
68     super(false, proportion);
69
70     myDefaultProportion = proportion;
71   }
72
73   public JBSplitter(boolean vertical, float proportion, float minProp, float maxProp) {
74     super(vertical, proportion, minProp, maxProp);
75
76     myDefaultProportion = proportion;
77   }
78
79   /**
80    * Splitter proportion unique key
81    *
82    * @return non empty unique String or {@code null} if splitter does not require proportion saving
83    */
84   @Nullable
85   public final String getSplitterProportionKey() {
86     return mySplitterProportionKey;
87   }
88
89   /**
90    * Sets proportion key
91    *
92    * @param key non empty unique String or {@code null} if splitter does not require proportion saving
93    */
94   public final void setSplitterProportionKey(@Nullable String key) {
95     mySplitterProportionKey = key;
96   }
97
98   /**
99    * Sets proportion key and load from settings.
100    * @param key
101    */
102   public final void setAndLoadSplitterProportionKey(@NotNull String key) {
103     setSplitterProportionKey(key);
104     loadProportion();
105   }
106
107   @Override
108   public void addNotify() {
109     super.addNotify();
110     loadProportion();
111   }
112
113   @Override
114   public void setProportion(float proportion) {
115     super.setProportion(proportion);
116     saveProportion();
117   }
118
119   protected void loadProportion() {
120     if (!StringUtil.isEmpty(mySplitterProportionKey)) {
121       setProportion(PropertiesComponent.getInstance().getFloat(mySplitterProportionKey, myProportion));
122     }
123   }
124
125   protected void saveProportion() {
126     if (!StringUtil.isEmpty(mySplitterProportionKey)) {
127       PropertiesComponent.getInstance().setValue(mySplitterProportionKey, myProportion, myDefaultProportion);
128     }
129   }
130 }