1 /*
   2  * Copyright (c) 2011, 2014, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package com.apple.laf;
  27 
  28 import java.awt.*;
  29 import java.awt.event.*;
  30 import java.awt.peer.MenuComponentPeer;
  31 
  32 import javax.swing.*;
  33 import javax.swing.plaf.ComponentUI;
  34 
  35 import sun.lwawt.macosx.CMenuItem;
  36 
  37 @SuppressWarnings("serial") // JDK implementation class
  38 final class ScreenMenuItem extends MenuItem implements ActionListener, ComponentListener, ScreenMenuPropertyHandler {
  39     ScreenMenuPropertyListener fListener;
  40     JMenuItem fMenuItem;
  41 
  42     ScreenMenuItem(final JMenuItem mi) {
  43         super(mi.getText());
  44         fMenuItem = mi;
  45         setEnabled(fMenuItem.isEnabled());
  46         final ComponentUI ui = fMenuItem.getUI();
  47 
  48         if (ui instanceof ScreenMenuItemUI) {
  49             ((ScreenMenuItemUI)ui).updateListenersForScreenMenuItem();
  50             // SAK:  Not calling this means that mouse and mouse motion listeners don't get
  51             // installed.  Not a problem because the menu manager handles tracking for us.
  52     }
  53     }
  54 
  55     public void addNotify() {
  56         super.addNotify();
  57 
  58         fMenuItem.addComponentListener(this);
  59         fListener = new ScreenMenuPropertyListener(this);
  60         fMenuItem.addPropertyChangeListener(fListener);
  61         addActionListener(this);
  62 
  63         setEnabled(fMenuItem.isEnabled());
  64 
  65         // can't setState or setAccelerator or setIcon till we have a peer
  66         setAccelerator(fMenuItem.getAccelerator());
  67 
  68         final String label = fMenuItem.getText();
  69         if (label != null) {
  70             setLabel(label);
  71         }
  72 
  73         final Icon icon = fMenuItem.getIcon();
  74         if (icon != null) {
  75             this.setIcon(icon);
  76         }
  77 
  78         final String tooltipText = fMenuItem.getToolTipText();
  79         if (tooltipText != null) {
  80             this.setToolTipText(tooltipText);
  81         }
  82 
  83         if (fMenuItem instanceof JRadioButtonMenuItem) {
  84             final ComponentUI ui = fMenuItem.getUI();
  85 
  86             if (ui instanceof ScreenMenuItemUI) {
  87                 ((ScreenMenuItemUI)ui).updateListenersForScreenMenuItem();
  88             }
  89         }
  90     }
  91 
  92     public void removeNotify() {
  93         super.removeNotify();
  94         removeActionListener(this);
  95         fMenuItem.removePropertyChangeListener(fListener);
  96         fListener = null;
  97         fMenuItem.removeComponentListener(this);
  98     }
  99 
 100     @SuppressWarnings("deprecation")
 101     static void syncLabelAndKS(MenuItem menuItem, String label, KeyStroke ks) {
 102         final MenuComponentPeer peer = menuItem.getPeer();
 103         if (!(peer instanceof CMenuItem)) {
 104             //Is it possible?
 105             return;
 106         }
 107         final CMenuItem cmi = (CMenuItem) peer;
 108         if (ks == null) {
 109             cmi.setLabel(label);
 110         } else {
 111             cmi.setLabel(label, ks.getKeyChar(), ks.getKeyCode(),
 112                          ks.getModifiers());
 113         }
 114     }
 115 
 116     @Override
 117     public synchronized void setLabel(final String label) {
 118         syncLabelAndKS(this, label, fMenuItem.getAccelerator());
 119     }
 120 
 121     @Override
 122     public void setAccelerator(final KeyStroke ks) {
 123         syncLabelAndKS(this, fMenuItem.getText(), ks);
 124     }
 125 
 126     public void actionPerformed(final ActionEvent e) {
 127         fMenuItem.doClick(0); // This takes care of all the different events
 128     }
 129 
 130     /**
 131      * Invoked when the component's size changes.
 132      */
 133     public void componentResized(final ComponentEvent e) {}
 134 
 135     /**
 136      * Invoked when the component's position changes.
 137      */
 138     public void componentMoved(final ComponentEvent e) {}
 139 
 140     /**
 141      * Invoked when the component has been made visible.
 142      * See componentHidden - we should still have a MenuItem
 143      * it just isn't inserted
 144      */
 145     public void componentShown(final ComponentEvent e) {
 146         setVisible(true);
 147     }
 148 
 149     /**
 150      * Invoked when the component has been made invisible.
 151      * MenuComponent.setVisible does nothing,
 152      * so we remove the ScreenMenuItem from the ScreenMenu
 153      * but leave it in fItems
 154      */
 155     public void componentHidden(final ComponentEvent e) {
 156         setVisible(false);
 157     }
 158 
 159     public void setVisible(final boolean b) {
 160         // Tell our parent to add/remove us -- parent may be nil if we aren't set up yet.
 161         // Hang on to our parent
 162         final MenuContainer parent = getParent();
 163 
 164         if (parent != null) {
 165             ((ScreenMenuPropertyHandler)parent).setChildVisible(fMenuItem, b);
 166         }
 167     }
 168 
 169     @SuppressWarnings("deprecation")
 170     public void setToolTipText(final String text) {
 171         final MenuComponentPeer peer = getPeer();
 172         if (!(peer instanceof CMenuItem)) return;
 173 
 174         final CMenuItem cmi = (CMenuItem)peer;
 175         cmi.setToolTipText(text);
 176     }
 177 
 178     @SuppressWarnings("deprecation")
 179     public void setIcon(final Icon i) {
 180         final MenuComponentPeer peer = getPeer();
 181         if (!(peer instanceof CMenuItem)) return;
 182 
 183         final CMenuItem cmi = (CMenuItem)peer;
 184             Image img = null;
 185 
 186         if (i != null) {
 187             if (i.getIconWidth() > 0 && i.getIconHeight() > 0) {
 188                     img = AquaIcon.getImageForIcon(i);
 189                 }
 190         }
 191             cmi.setImage(img);
 192         }
 193 
 194     // we have no children
 195     public void setChildVisible(final JMenuItem child, final boolean b) {}
 196 
 197     // only check and radio items can be indeterminate
 198     public void setIndeterminate(boolean indeterminate) { }
 199 }