replaced <code></code> with more concise {@code}
[idea/community.git] / platform / platform-api / src / com / intellij / openapi / ui / DialogWrapperPeer.java
1 /*
2  * Copyright 2000-2014 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.ui;
17
18 import com.intellij.openapi.util.ActionCallback;
19 import com.intellij.util.ArrayUtil;
20 import org.jetbrains.annotations.NotNull;
21 import org.jetbrains.annotations.Nullable;
22
23 import javax.swing.*;
24 import java.awt.*;
25 import java.awt.event.KeyListener;
26 import java.awt.event.MouseListener;
27 import java.awt.event.MouseMotionListener;
28
29 public abstract class DialogWrapperPeer {
30   public static Object HAVE_INITIAL_SELECTION = new Object();
31
32   public abstract void setUndecorated(boolean undecorated);
33
34   /**
35    * @see java.awt.Component#addMouseListener
36    */
37   public abstract void addMouseListener(MouseListener listener);
38
39   /**
40    * @see java.awt.Component#addMouseMotionListener
41    */
42   public abstract void addMouseListener(MouseMotionListener listener);
43
44   /**
45    * @see java.awt.Component#addKeyListener
46    */
47   public abstract void addKeyListener(KeyListener listener);
48
49   /**
50    * @see java.awt.Window#toFront()
51    */
52   public abstract void toFront();
53
54   /**
55    * @see java.awt.Window#toBack()
56    */
57   public abstract void toBack();
58
59   /**
60    * Dispose the wrapped and releases all resources allocated be the wrapper to help
61    * more efficient garbage collection. You should never invoke this method twice or
62    * invoke any method of the wrapper after invocation of {@code dispose}.
63    */
64   protected abstract void dispose();
65
66   /**
67    * @see javax.swing.JDialog#getContentPane
68    */
69   @Nullable
70   public abstract Container getContentPane();
71
72   /**
73    * @see java.awt.Window#getOwner
74    */
75   public abstract Window getOwner();
76
77   public abstract Window getWindow();
78
79   /**
80    * @see javax.swing.JDialog#getRootPane
81    */
82   public abstract JRootPane getRootPane();
83
84   /**
85    * @see java.awt.Window#getSize
86    */
87   public abstract Dimension getSize();
88
89   /**
90    * @see java.awt.Dialog#getTitle
91    */
92   public abstract String getTitle();
93
94   public abstract Dimension getPreferredSize();
95
96   public abstract void setModal(boolean modal);
97
98   public abstract boolean isModal();
99
100   /**
101    * @see java.awt.Component#isVisible
102    */
103   public abstract boolean isVisible();
104
105   /**
106    * @see java.awt.Window#isShowing
107    */
108   public abstract boolean isShowing();
109
110   /**
111    * @see javax.swing.JDialog#setSize
112    */
113   public abstract void setSize(int width, int height);
114
115   /**
116    * @see javax.swing.JDialog#setTitle
117    */
118   public abstract void setTitle(String title);
119
120   /**
121    * @see javax.swing.JDialog#isResizable
122    */
123   public abstract void isResizable();
124
125   /**
126    * @see javax.swing.JDialog#setResizable
127    */
128   public abstract void setResizable(boolean resizable);
129
130   /**
131    * @see javax.swing.JDialog#getLocation
132    */
133   @NotNull
134   public abstract Point getLocation();
135
136   /**
137    * @see javax.swing.JDialog#setLocation(java.awt.Point)
138    */
139   public abstract void setLocation(@NotNull Point p);
140
141   /**
142    * @see javax.swing.JDialog#setLocation(int,int)
143    */
144   public abstract void setLocation(int x, int y);
145
146   public abstract ActionCallback show();
147
148   public abstract void setContentPane(JComponent content);
149
150   public abstract void centerInParent();
151
152   public abstract void validate();
153   public abstract void repaint();
154   public abstract void pack();
155
156   public abstract void setAppIcons();
157
158   public abstract boolean isHeadless();
159
160   public Object[] getCurrentModalEntities() {
161     return ArrayUtil.EMPTY_OBJECT_ARRAY;
162   }
163 }