replaced <code></code> with more concise {@code}
[idea/community.git] / platform / platform-api / src / com / intellij / openapi / wm / FocusRequestor.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.wm;
17
18 import com.intellij.openapi.Disposable;
19 import com.intellij.openapi.util.ActionCallback;
20 import org.jetbrains.annotations.NotNull;
21
22 import java.awt.*;
23
24 /**
25  * Basic interface for requesting sending focus commands to {@code IdeFocusManager}
26  */
27 public interface FocusRequestor extends Disposable {
28
29   /**
30    * Requests focus on a component
31    * @param c - component to request focus to
32    * @param forced - if true - focus request is explicit, must be fulfilled, if false - can be dropped
33    * @return action callback that either notifies when the focus was obtained or focus request was dropped
34    */
35   @NotNull
36   ActionCallback requestFocus(@NotNull Component c, boolean forced);
37
38   /**
39    * Runs a request focus command, actual focus request is defined by the user in the command itself
40    * @param forced - if true - focus request is explicit, must be fulfilled, if false - can be dropped
41    * @return action callback that either notifies when the focus was obtained or focus request was dropped
42    */
43   @NotNull
44   ActionCallback requestFocus(@NotNull FocusCommand command, boolean forced);
45   
46 }