platform/platform-impl/src/com/intellij/openapi/actionSystem/impl/ActionMenu.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.openapi.actionSystem.impl;
  17
  18 import com.intellij.ide.DataManager;
  19 import com.intellij.openapi.actionSystem.ActionGroup;
  20 import com.intellij.openapi.actionSystem.ActionPlaces;
  21 import com.intellij.openapi.actionSystem.DataContext;
  22 import com.intellij.openapi.actionSystem.Presentation;
  23 import com.intellij.openapi.util.IconLoader;
  24 import com.intellij.openapi.util.SystemInfo;
  25 import com.intellij.openapi.wm.StatusBar;
  26 import com.intellij.openapi.wm.impl.IdeFrameImpl;
  27 import com.intellij.ui.plaf.beg.IdeaMenuUI;
  28 import com.intellij.util.ui.UIUtil;
  29
  30 import javax.swing.*;
  31 import javax.swing.event.MenuEvent;
  32 import javax.swing.event.MenuListener;
  33 import javax.swing.plaf.MenuItemUI;
  34 import java.awt.*;
  35 import java.awt.event.KeyEvent;
  36 import java.beans.PropertyChangeEvent;
  37 import java.beans.PropertyChangeListener;
  38
  39 public final class ActionMenu extends JMenu {
  40   private final String myPlace;
  41   private final DataContext myContext;
  42   private final ActionGroup myGroup;
  43   private final PresentationFactory myPresentationFactory;
  44   private final Presentation myPresentation;
  45   /**
  46    * Defines whether menu shows its mnemonic or not.
  47    */
  48   private boolean myMnemonicEnabled;
  49   private MenuItemSynchronizer myMenuItemSynchronizer;
  50   /**
  51    * This is PATCH!!!
  52    * Do not remove this STUPID code. Otherwise you will lose all keyboard navigation
  53    * at JMenuBar.
  54    */
  55   private StubItem myStubItem;
  56
  57   public ActionMenu(DataContext context, String place, ActionGroup group, PresentationFactory presentationFactory, final boolean enableMnemonics) {
  58     myContext = context;
  59     myPlace = place;
  60     myGroup = group;
  61     myPresentationFactory = presentationFactory;
  62     myPresentation = myPresentationFactory.getPresentation(group);
  63     myMnemonicEnabled = enableMnemonics;
  64
  65     init();
  66
  67     // addNotify won't be called for menus in MacOS system menu
  68     if (SystemInfo.isMacSystemMenu) {
  69       installSynchronizer();
  70     }
  71   }
  72
  73   public void addNotify() {
  74     super.addNotify();
  75     installSynchronizer();
  76   }
  77
  78   private void installSynchronizer() {
  79     if (myMenuItemSynchronizer == null) {
  80       myMenuItemSynchronizer = new MenuItemSynchronizer();
  81       myGroup.addPropertyChangeListener(myMenuItemSynchronizer);
  82       myPresentation.addPropertyChangeListener(myMenuItemSynchronizer);
  83     }
  84   }
  85
  86   public void removeNotify() {
  87     if (myMenuItemSynchronizer != null) {
  88       myGroup.removePropertyChangeListener(myMenuItemSynchronizer);
  89       myPresentation.removePropertyChangeListener(myMenuItemSynchronizer);
  90       myMenuItemSynchronizer = null;
  91     }
  92     super.removeNotify();
  93   }
  94
  95   public void updateUI() {
  96     JPopupMenu popupMenu = getPopupMenu();
  97     if (popupMenu != null) {
  98       popupMenu.updateUI();
  99     }
 100     if (UIUtil.isStandardMenuLAF()) {
 101       setUI((MenuItemUI)UIManager.getUI(this));
 102     }
 103     else {
 104       setUI(IdeaMenuUI.createUI(this));
 105       setFont(UIUtil.getMenuFont());
 106     }
 107   }
 108
 109   private void init() {
 110     boolean macSystemMenu = SystemInfo.isMacSystemMenu && myPlace == ActionPlaces.MAIN_MENU;
 111
 112     myStubItem = macSystemMenu ? null : new StubItem();
 113     addStubItem();
 114     addMenuListener(new MenuListenerImpl());
 115     setBorderPainted(false);
 116
 117     setVisible(myPresentation.isVisible());
 118     setEnabled(myPresentation.isEnabled());
 119     setText(myPresentation.getText());
 120     updateIcon();
 121
 122     setMnemonicEnabled(myMnemonicEnabled);
 123   }
 124
 125   private void addStubItem() {
 126     if (myStubItem != null) {
 127       add(myStubItem);
 128     }
 129   }
 130
 131   public void setMnemonicEnabled(boolean enable) {
 132     myMnemonicEnabled = enable;
 133     setMnemonic(myPresentation.getMnemonic());
 134     setDisplayedMnemonicIndex(myPresentation.getDisplayedMnemonicIndex());
 135   }
 136
 137   @Override
 138   public void setDisplayedMnemonicIndex(final int index) throws IllegalArgumentException {
 139     super.setDisplayedMnemonicIndex(myMnemonicEnabled ? index : -1);
 140   }
 141
 142   public void setMnemonic(int mnemonic) {
 143     super.setMnemonic(myMnemonicEnabled ? mnemonic : 0);
 144   }
 145
 146   private void updateIcon() {
 147     Presentation presentation = myPresentation;
 148     Icon icon = presentation.getIcon();
 149     setIcon(icon);
 150     if (presentation.getDisabledIcon() != null) {
 151       setDisabledIcon(presentation.getDisabledIcon());
 152     }
 153     else {
 154       setDisabledIcon(IconLoader.getDisabledIcon(icon));
 155     }
 156   }
 157
 158   public void menuSelectionChanged(boolean isIncluded) {
 159     super.menuSelectionChanged(isIncluded);
 160     showDescriptionInStatusBar(isIncluded, this, myPresentation.getDescription());
 161   }
 162
 163   public static void showDescriptionInStatusBar(boolean isIncluded, Component component, String description) {
 164     IdeFrameImpl frame = component instanceof IdeFrameImpl ? (IdeFrameImpl)component :
 165                          (IdeFrameImpl)SwingUtilities.getAncestorOfClass(IdeFrameImpl.class, component);
 166     if (frame != null) {
 167       StatusBar statusBar = frame.getStatusBar();
 168       if (isIncluded) {
 169         statusBar.setInfo(description);
 170       }
 171       else {
 172         statusBar.setInfo(null);
 173       }
 174     }
 175   }
 176
 177   private class MenuListenerImpl implements MenuListener {
 178     public void menuCanceled(MenuEvent e) {
 179       clearItems();
 180       addStubItem();
 181     }
 182
 183     public void menuDeselected(MenuEvent e) {
 184       clearItems();
 185       addStubItem();
 186     }
 187
 188
 189     public void menuSelected(MenuEvent e) {
 190       fillMenu();
 191     }
 192   }
 193
 194   private void clearItems() {
 195     if (SystemInfo.isMacSystemMenu && myPlace == ActionPlaces.MAIN_MENU) {
 196       for (Component menuComponent : getMenuComponents()) {
 197         if (menuComponent instanceof ActionMenu) {
 198           ((ActionMenu)menuComponent).clearItems();
 199         }
 200         else if (menuComponent instanceof ActionMenuItem) {
 201           ((ActionMenuItem)menuComponent).setAccelerator(KeyStroke.getKeyStroke(KeyEvent.VK_F24, 0));
 202         }
 203       }
 204     }
 205
 206     removeAll();
 207     validate();
 208   }
 209
 210   private void fillMenu() {
 211     DataContext context = myContext != null ? myContext : DataManager.getInstance().getDataContext();
 212     Utils.fillMenu(myGroup, this, myMnemonicEnabled, myPresentationFactory, context, myPlace, true);
 213   }
 214
 215   private class MenuItemSynchronizer implements PropertyChangeListener {
 216     public void propertyChange(PropertyChangeEvent e) {
 217       String name = e.getPropertyName();
 218       if (Presentation.PROP_VISIBLE.equals(name)) {
 219         setVisible(myPresentation.isVisible());
 220         if (SystemInfo.isMacSystemMenu && myPlace == ActionPlaces.MAIN_MENU) {
 221           validateTree();
 222         }
 223       }
 224       else if (Presentation.PROP_ENABLED.equals(name)) {
 225         setEnabled(myPresentation.isEnabled());
 226       }
 227       else if (Presentation.PROP_MNEMONIC_KEY.equals(name)) {
 228         setMnemonic(myPresentation.getMnemonic());
 229       }
 230       else if (Presentation.PROP_MNEMONIC_INDEX.equals(name)) {
 231         setDisplayedMnemonicIndex(myPresentation.getDisplayedMnemonicIndex());
 232       }
 233       else if (Presentation.PROP_TEXT.equals(name)) {
 234         setText(myPresentation.getText());
 235       }
 236       else if (Presentation.PROP_ICON.equals(name) || Presentation.PROP_DISABLED_ICON.equals(name)) {
 237         updateIcon();
 238       }
 239     }
 240   }
 241 }