replaced <code></code> with more concise {@code}
[idea/community.git] / platform / platform-api / src / com / intellij / ide / FrameStateManager.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 package com.intellij.ide;
17
18 import com.intellij.openapi.Disposable;
19 import com.intellij.openapi.application.ApplicationManager;
20 import com.intellij.openapi.util.ActionCallback;
21 import org.jetbrains.annotations.NotNull;
22 import org.jetbrains.annotations.Nullable;
23
24 /**
25  * Manager of listeners for notifications about activation and deactivation of the
26  * IDEA window.
27  *
28  * @since 5.0.2
29  */
30
31 public abstract class FrameStateManager {
32   /**
33    * Returns the global {@code FrameStateManager} instance.
34    *
35    * @return the component instance.
36    */
37   public static FrameStateManager getInstance() {
38     return ApplicationManager.getApplication().getComponent(FrameStateManager.class);
39   }
40
41   /**
42    * Adds a listener which is called when the IDEA window is activated or deactivated.
43    *
44    * @param listener the listener instance.
45    */
46   public abstract void addListener(@NotNull FrameStateListener listener);
47   public abstract void addListener(@NotNull FrameStateListener listener, @Nullable Disposable disposable);
48
49   /**
50    * Removes a listener which is called when the IDEA window is activated or deactivated.
51    *
52    * @param listener the listener instance.
53    */
54   public abstract void removeListener(@NotNull FrameStateListener listener);
55
56
57   /**
58    * @return action callback for application's active state
59    */
60   public abstract ActionCallback getApplicationActive();
61 }