[facets API] mark some interfaces in Facets API as NonExtendable
[idea/community.git] / platform / lang-api / src / com / intellij / facet / ui / MultipleFacetEditorHelper.java
1 /*
2  * Copyright 2000-2009 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.facet.ui;
18
19 import com.intellij.util.NotNullFunction;
20 import com.intellij.util.ui.ThreeStateCheckBox;
21 import org.jetbrains.annotations.ApiStatus;
22 import org.jetbrains.annotations.NotNull;
23
24 import javax.swing.*;
25
26 /**
27  * Use {@link com.intellij.facet.ui.FacetEditorsFactory#createMultipleFacetEditorHelper()} to create instance of this class.
28  *
29  * @author nik
30  */
31 @ApiStatus.NonExtendable
32 public interface MultipleFacetEditorHelper {
33
34   /**
35    * Binds {@code common} 3-state checkbox to checkboxes in facet editors in such a way that all changes in it will be propogated to
36    * target checkboxes.
37    * @param common checkbox
38    * @param editors editors
39    * @param fun maps a facet editor to checkbox inside one of its tabs
40    */
41   void bind(@NotNull ThreeStateCheckBox common, @NotNull FacetEditor[] editors, @NotNull NotNullFunction<? super FacetEditor, ? extends JCheckBox> fun);
42
43   void bind(@NotNull JTextField common, @NotNull FacetEditor[] editors, @NotNull NotNullFunction<? super FacetEditor, ? extends JTextField> fun);
44
45   void bind(@NotNull JComboBox common, @NotNull FacetEditor[] editors, @NotNull NotNullFunction<? super FacetEditor, ? extends JComboBox> fun);
46
47   /**
48    * Removes all bindings registered by this helper
49    */
50   void unbind();
51 }