platform-api/src/com/intellij/openapi/wm/IdeFocusManager.java

   1 /*
   2  * Copyright 2000-2007 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.actionSystem.DataContext;
  19 import com.intellij.openapi.actionSystem.PlatformDataKeys;
  20 import com.intellij.openapi.project.Project;
  21 import com.intellij.openapi.util.ActionCallback;
  22 import com.intellij.util.ui.UIUtil;
  23 import org.jetbrains.annotations.NotNull;
  24 import org.jetbrains.annotations.Nullable;
  25
  26 import javax.swing.*;
  27 import java.awt.*;
  28 import java.awt.event.KeyEvent;
  29
  30 public abstract class IdeFocusManager {
  31
  32   /**
  33    * Requests focus on a component
  34    * @param c
  35    * @param forced
  36    * @return action callback that either notifies when the focus was obtained or focus request was droppped
  37    */
  38   @NotNull
  39   public abstract ActionCallback requestFocus(@NotNull Component c, boolean forced);
  40
  41   /**
  42    * Runs a request focus command, actual focus request is defined by the user in the command itself
  43    * @param command
  44    * @param forced
  45    * @return action callback that either notifies when the focus was obtained or focus request was droppped
  46    */
  47   @NotNull
  48   public abstract ActionCallback requestFocus(@NotNull FocusCommand command, boolean forced);
  49
  50   /**
  51    * Finds most suitable component to request focus to. For instance you may pass a JPanel instance,
  52    * this method will traverse into it's children to find focusable component
  53    * @param comp
  54    * @return suitable component to focus
  55    */
  56   @Nullable
  57   public abstract JComponent getFocusTargetFor(@NotNull final JComponent comp);
  58
  59
  60   public abstract void doWhenFocusSettlesDown(@NotNull Runnable runnable);
  61
  62   @Nullable
  63   public abstract Component getFocusedDescendantFor(final Component comp);
  64
  65   public abstract boolean dispatch(KeyEvent e);
  66
  67   public abstract void suspendKeyProcessingUntil(@NotNull ActionCallback done);
  68
  69   public abstract boolean isFocusBeingTransferred();
  70
  71   public abstract ActionCallback requestDefaultFocus(boolean forced);
  72
  73   public static IdeFocusManager getInstance(@NotNull Project project) {
  74     if (project.isDisposed() || !project.isInitialized()) return PassThroughtIdeFocusManager.getInstance();
  75     return project.getComponent(IdeFocusManager.class);
  76   }
  77
  78   @NotNull
  79   public static IdeFocusManager findInstanceByContext(@Nullable DataContext context) {
  80     IdeFocusManager instance = null;
  81     if (context != null) {
  82       instance = getInstanceSafe(PlatformDataKeys.PROJECT.getData(context));
  83     }
  84
  85     if (instance == null) {
  86       instance = findByComponent(KeyboardFocusManager.getCurrentKeyboardFocusManager().getActiveWindow());
  87     }
  88
  89     if (instance == null) {
  90       instance = PassThroughtIdeFocusManager.getInstance();
  91     }
  92
  93     return instance;
  94   }
  95
  96   @NotNull
  97   public static IdeFocusManager findInstanceByComponent(@NotNull Component c) {
  98     final IdeFocusManager instance = findByComponent(c);
  99     return instance != null ? instance : findInstanceByContext(null);
 100   }
 101
 102
 103   @Nullable
 104   private static IdeFocusManager findByComponent(Component c) {
 105     final Component parent = UIUtil.findUltimateParent(c);
 106     if (parent instanceof IdeFrame) {
 107       return getInstanceSafe(((IdeFrame)parent).getProject());
 108     }
 109     return null;
 110   }
 111
 112
 113   @Nullable
 114   private static IdeFocusManager getInstanceSafe(@Nullable Project project) {
 115     if (project != null && !project.isDisposed() && project.isInitialized()) {
 116       return IdeFocusManager.getInstance(project);
 117     } else {
 118       return null;
 119     }
 120   }
 121
 122   @NotNull
 123   public static IdeFocusManager findInstance() {
 124     final Component owner = KeyboardFocusManager.getCurrentKeyboardFocusManager().getFocusOwner();
 125     return owner != null ? findInstanceByComponent(owner) : findInstanceByContext(null);
 126   }
 127
 128 }