replaced <code></code> with more concise {@code}
[idea/community.git] / platform / external-system-impl / src / com / intellij / openapi / externalSystem / util / ExternalSystemSettingsControl.java
1 /*
2  * Copyright 2000-2013 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.openapi.externalSystem.util;
17
18 import com.intellij.openapi.options.ConfigurationException;
19 import org.jetbrains.annotations.NotNull;
20
21 import java.awt.*;
22
23 /**
24  * Defines contract for a component which knows how to manage particular settings.
25  * 
26  * @author Denis Zhdanov
27  * @since 4/28/13 12:15 AM
28  * @param <S>  settings type
29  */
30 public interface ExternalSystemSettingsControl<S> {
31
32   /**
33    * Adds current control-specific UI controls to the given canvas.
34    * <p/>
35    * <b>Note:</b> given canvas component is expected to be managed by a {@link GridBagLayout}. That is the reason on why we use
36    * this method instead of a method like 'JComponent getComponent()' - there is a possible case that given canvas has components
37    * from more than one control and we might want them to be aligned.
38    * 
39    * @param canvas        container to use as a holder for UI components specific to the current control
40    * @param indentLevel   a hint on how much UI components added by the current control should be indented
41    */
42   void fillUi(@NotNull PaintAwarePanel canvas, int indentLevel);
43
44   /**
45    * Asks current control to reset its state to the initial one.
46    */
47   void reset();
48
49   /**
50    * @return    {@code true} if settings exposed by the current control have been modified; {@code false} otherwise
51    */
52   boolean isModified();
53
54   /**
55    * Asks current control to fill given settings with the current user-defined values.
56    * 
57    * @param settings  settings holder
58    */
59   void apply(@NotNull S settings);
60
61   /**
62    * Asks current control to validate given settings with the current user-defined values.
63    *
64    * @param settings  settings holder
65    */
66   boolean validate(@NotNull S settings) throws ConfigurationException;
67
68   void disposeUIResources();
69
70   /**
71    * Hides/shows {@link #fillUi(PaintAwarePanel, int) components added by the current control}.
72    * 
73    * @param show  flag which indicates if current control' components should be visible
74    */
75   void showUi(boolean show);
76 }