/*

 * Copyright (c) 1997, 2008, Oracle and/or its affiliates. All rights reserved.

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle in the LICENSE file that accompanied this code.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 */

package javax.swing.plaf.basic;

import sun.swing.SwingUtilities2;

import java.awt.*;

import java.awt.event.*;

import javax.accessibility.AccessibleContext;

import javax.swing.*;

import javax.swing.plaf.*;

import javax.swing.border.*;

import javax.swing.event.InternalFrameEvent;

import java.util.EventListener;

import java.beans.PropertyChangeListener;

import java.beans.PropertyChangeEvent;

import java.beans.VetoableChangeListener;

import java.beans.PropertyVetoException;

import sun.swing.DefaultLookup;

import sun.swing.UIAction;

/**

 * The class that manages a basic title bar

 * <p>

 * <strong>Warning:</strong>

 * Serialized objects of this class will not be compatible with

 * future Swing releases. The current serialization support is

 * appropriate for short term storage or RMI between applications running

 * the same version of Swing.  As of 1.4, support for long term storage

 * of all JavaBeans™

 * has been added to the <code>java.beans</code> package.

 * Please see {@link java.beans.XMLEncoder}.

 *

 * @author David Kloba

 * @author Steve Wilson

 */

public class BasicInternalFrameTitlePane extends JComponent

{

    protected JMenuBar menuBar;

    protected JButton iconButton;

    protected JButton maxButton;

    protected JButton closeButton;

    protected JMenu windowMenu;

    protected JInternalFrame frame;

    protected Color selectedTitleColor;

    protected Color selectedTextColor;

    protected Color notSelectedTitleColor;

    protected Color notSelectedTextColor;

    protected Icon maxIcon;

    protected Icon minIcon;

    protected Icon iconIcon;

    protected Icon closeIcon;

    protected PropertyChangeListener propertyChangeListener;

    protected Action closeAction;

    protected Action maximizeAction;

    protected Action iconifyAction;

    protected Action restoreAction;

    protected Action moveAction;

    protected Action sizeAction;

    // These constants are not used in JDK code

    protected static final String CLOSE_CMD =

        UIManager.getString("InternalFrameTitlePane.closeButtonText");

    protected static final String ICONIFY_CMD =

        UIManager.getString("InternalFrameTitlePane.minimizeButtonText");

    protected static final String RESTORE_CMD =

        UIManager.getString("InternalFrameTitlePane.restoreButtonText");

    protected static final String MAXIMIZE_CMD =

        UIManager.getString("InternalFrameTitlePane.maximizeButtonText");

    protected static final String MOVE_CMD =

        UIManager.getString("InternalFrameTitlePane.moveButtonText");

    protected static final String SIZE_CMD =

        UIManager.getString("InternalFrameTitlePane.sizeButtonText");

    private String closeButtonToolTip;

    private String iconButtonToolTip;

    private String restoreButtonToolTip;

    private String maxButtonToolTip;

    private Handler handler;

    public BasicInternalFrameTitlePane(JInternalFrame f) {

        frame = f;

        installTitlePane();

    }

    protected void installTitlePane() {

        installDefaults();

        installListeners();

        createActions();

        enableActions();

        createActionMap();

        setLayout(createLayout());

        assembleSystemMenu();

        createButtons();

        addSubComponents();

    }

    protected void addSubComponents() {

        add(menuBar);

        add(iconButton);

        add(maxButton);

        add(closeButton);

    }

    protected void createActions() {

        maximizeAction = new MaximizeAction();

        iconifyAction = new IconifyAction();

        closeAction = new CloseAction();

        restoreAction = new RestoreAction();

        moveAction = new MoveAction();

        sizeAction = new SizeAction();

    }

    ActionMap createActionMap() {

        ActionMap map = new ActionMapUIResource();

        map.put("showSystemMenu", new ShowSystemMenuAction(true));

        map.put("hideSystemMenu", new ShowSystemMenuAction(false));

        return map;

    }

    protected void installListeners() {

        if( propertyChangeListener == null ) {

            propertyChangeListener = createPropertyChangeListener();

        }

        frame.addPropertyChangeListener(propertyChangeListener);

    }

    protected void uninstallListeners() {

        frame.removePropertyChangeListener(propertyChangeListener);

        handler = null;

    }

    protected void installDefaults() {

        maxIcon = UIManager.getIcon("InternalFrame.maximizeIcon");

        minIcon = UIManager.getIcon("InternalFrame.minimizeIcon");

        iconIcon = UIManager.getIcon("InternalFrame.iconifyIcon");

        closeIcon = UIManager.getIcon("InternalFrame.closeIcon");

        selectedTitleColor = UIManager.getColor("InternalFrame.activeTitleBackground");

        selectedTextColor = UIManager.getColor("InternalFrame.activeTitleForeground");

        notSelectedTitleColor = UIManager.getColor("InternalFrame.inactiveTitleBackground");

        notSelectedTextColor = UIManager.getColor("InternalFrame.inactiveTitleForeground");

        setFont(UIManager.getFont("InternalFrame.titleFont"));

        closeButtonToolTip =

                UIManager.getString("InternalFrame.closeButtonToolTip");

        iconButtonToolTip =

                UIManager.getString("InternalFrame.iconButtonToolTip");

        restoreButtonToolTip =

                UIManager.getString("InternalFrame.restoreButtonToolTip");

        maxButtonToolTip =

                UIManager.getString("InternalFrame.maxButtonToolTip");

    }

    protected void uninstallDefaults() {

    }

    protected void createButtons() {

        iconButton = new NoFocusButton(

                     "InternalFrameTitlePane.iconifyButtonAccessibleName",

                     "InternalFrameTitlePane.iconifyButtonOpacity");

        iconButton.addActionListener(iconifyAction);

        if (iconButtonToolTip != null && iconButtonToolTip.length() != 0) {

            iconButton.setToolTipText(iconButtonToolTip);

        }

        maxButton = new NoFocusButton(

                        "InternalFrameTitlePane.maximizeButtonAccessibleName",

                        "InternalFrameTitlePane.maximizeButtonOpacity");

        maxButton.addActionListener(maximizeAction);

        closeButton = new NoFocusButton(

                      "InternalFrameTitlePane.closeButtonAccessibleName",

                      "InternalFrameTitlePane.closeButtonOpacity");

        closeButton.addActionListener(closeAction);

        if (closeButtonToolTip != null && closeButtonToolTip.length() != 0) {

            closeButton.setToolTipText(closeButtonToolTip);

        }

        setButtonIcons();

    }

    protected void setButtonIcons() {

        if(frame.isIcon()) {

            if (minIcon != null) {

                iconButton.setIcon(minIcon);

            }

            if (restoreButtonToolTip != null &&

                    restoreButtonToolTip.length() != 0) {

                iconButton.setToolTipText(restoreButtonToolTip);

            }

            if (maxIcon != null) {

                maxButton.setIcon(maxIcon);

            }

            if (maxButtonToolTip != null && maxButtonToolTip.length() != 0) {

                maxButton.setToolTipText(maxButtonToolTip);

            }

        } else if (frame.isMaximum()) {

            if (iconIcon != null) {

                iconButton.setIcon(iconIcon);

            }

            if (iconButtonToolTip != null && iconButtonToolTip.length() != 0) {

                iconButton.setToolTipText(iconButtonToolTip);

            }

            if (minIcon != null) {

                maxButton.setIcon(minIcon);

            }

            if (restoreButtonToolTip != null &&

                    restoreButtonToolTip.length() != 0) {

                maxButton.setToolTipText(restoreButtonToolTip);

            }

        } else {

            if (iconIcon != null) {

                iconButton.setIcon(iconIcon);

            }

            if (iconButtonToolTip != null && iconButtonToolTip.length() != 0) {

                iconButton.setToolTipText(iconButtonToolTip);

            }

            if (maxIcon != null) {

                maxButton.setIcon(maxIcon);

            }

            if (maxButtonToolTip != null && maxButtonToolTip.length() != 0) {

                maxButton.setToolTipText(maxButtonToolTip);

            }

        }

        if (closeIcon != null) {

            closeButton.setIcon(closeIcon);

        }

    }

    protected void assembleSystemMenu() {

        menuBar = createSystemMenuBar();

        windowMenu = createSystemMenu();

        menuBar.add(windowMenu);

        addSystemMenuItems(windowMenu);

        enableActions();

    }

    protected void addSystemMenuItems(JMenu systemMenu) {

        JMenuItem mi = systemMenu.add(restoreAction);

        mi.setMnemonic(getButtonMnemonic("restore"));

        mi = systemMenu.add(moveAction);

        mi.setMnemonic(getButtonMnemonic("move"));

        mi = systemMenu.add(sizeAction);

        mi.setMnemonic(getButtonMnemonic("size"));

        mi = systemMenu.add(iconifyAction);

        mi.setMnemonic(getButtonMnemonic("minimize"));

        mi = systemMenu.add(maximizeAction);

        mi.setMnemonic(getButtonMnemonic("maximize"));

        systemMenu.add(new JSeparator());

        mi = systemMenu.add(closeAction);

        mi.setMnemonic(getButtonMnemonic("close"));

    }

    private static int getButtonMnemonic(String button) {

        try {

            return Integer.parseInt(UIManager.getString(

                    "InternalFrameTitlePane." + button + "Button.mnemonic"));

        } catch (NumberFormatException e) {

            return -1;

        }

    }

    protected JMenu createSystemMenu() {

        return new JMenu("    ");

    }

    protected JMenuBar createSystemMenuBar() {

        menuBar = new SystemMenuBar();

        menuBar.setBorderPainted(false);

        return menuBar;

    }

    protected void showSystemMenu(){

        //      windowMenu.setPopupMenuVisible(true);

      //      windowMenu.setVisible(true);

      windowMenu.doClick();

    }

    public void paintComponent(Graphics g)  {

        paintTitleBackground(g);

        if(frame.getTitle() != null) {

            boolean isSelected = frame.isSelected();

            Font f = g.getFont();

            g.setFont(getFont());

            if(isSelected)

                g.setColor(selectedTextColor);

            else

                g.setColor(notSelectedTextColor);

            // Center text vertically.

            FontMetrics fm = SwingUtilities2.getFontMetrics(frame, g);

            int baseline = (getHeight() + fm.getAscent() - fm.getLeading() -

                    fm.getDescent()) / 2;

            int titleX;

            Rectangle r = new Rectangle(0, 0, 0, 0);

            if (frame.isIconifiable())  r = iconButton.getBounds();

            else if (frame.isMaximizable())  r = maxButton.getBounds();

            else if (frame.isClosable())  r = closeButton.getBounds();

            int titleW;

            String title = frame.getTitle();

            if( BasicGraphicsUtils.isLeftToRight(frame) ) {

              if (r.x == 0)  r.x = frame.getWidth()-frame.getInsets().right;

              titleX = menuBar.getX() + menuBar.getWidth() + 2;

              titleW = r.x - titleX - 3;

              title = getTitle(frame.getTitle(), fm, titleW);

            } else {

                titleX = menuBar.getX() - 2

                         - SwingUtilities2.stringWidth(frame,fm,title);

            }

            SwingUtilities2.drawString(frame, g, title, titleX, baseline);

            g.setFont(f);

        }

    }

   /**

    * Invoked from paintComponent.

    * Paints the background of the titlepane.  All text and icons will

    * then be rendered on top of this background.

    * @param g the graphics to use to render the background

    * @since 1.4

    */

    protected void paintTitleBackground(Graphics g) {

        boolean isSelected = frame.isSelected();

        if(isSelected)

            g.setColor(selectedTitleColor);

        else

            g.setColor(notSelectedTitleColor);

        g.fillRect(0, 0, getWidth(), getHeight());

    }

    protected String getTitle(String text, FontMetrics fm, int availTextWidth) {

        return SwingUtilities2.clipStringIfNecessary(

                           frame, fm, text, availTextWidth);

      }

    /**

     * Post a WINDOW_CLOSING-like event to the frame, so that it can

     * be treated like a regular Frame.

     */

    protected void postClosingEvent(JInternalFrame frame) {

        InternalFrameEvent e = new InternalFrameEvent(

            frame, InternalFrameEvent.INTERNAL_FRAME_CLOSING);

        // Try posting event, unless there's a SecurityManager.

        if (JInternalFrame.class.getClassLoader() == null) {

            try {

                Toolkit.getDefaultToolkit().getSystemEventQueue().postEvent(e);

                return;

            } catch (SecurityException se) {

                // Use dispatchEvent instead.

            }

        }

        frame.dispatchEvent(e);

    }

    protected void enableActions() {

        restoreAction.setEnabled(frame.isMaximum() || frame.isIcon());

        maximizeAction.setEnabled(

            (frame.isMaximizable() && !frame.isMaximum() && !frame.isIcon()) ||

            (frame.isMaximizable() && frame.isIcon()));

        iconifyAction.setEnabled(frame.isIconifiable() && !frame.isIcon());

        closeAction.setEnabled(frame.isClosable());

        sizeAction.setEnabled(false);

        moveAction.setEnabled(false);

    }

    private Handler getHandler() {

        if (handler == null) {

            handler = new Handler();

        }

        return handler;

    }

    protected PropertyChangeListener createPropertyChangeListener() {

        return getHandler();

    }

    protected LayoutManager createLayout() {

        return getHandler();

    }

    private class Handler implements LayoutManager, PropertyChangeListener {

        //

        // PropertyChangeListener

        //

        public void propertyChange(PropertyChangeEvent evt) {

            String prop = evt.getPropertyName();

            if (prop == JInternalFrame.IS_SELECTED_PROPERTY) {

                repaint();

                return;

            }

            if (prop == JInternalFrame.IS_ICON_PROPERTY ||

                    prop == JInternalFrame.IS_MAXIMUM_PROPERTY) {

                setButtonIcons();

                enableActions();

                return;

            }

            if ("closable" == prop) {

                if (evt.getNewValue() == Boolean.TRUE) {

                    add(closeButton);

                } else {

                    remove(closeButton);

                }

            } else if ("maximizable" == prop) {

                if (evt.getNewValue() == Boolean.TRUE) {

                    add(maxButton);

                } else {

                    remove(maxButton);

                }

            } else if ("iconable" == prop) {

                if (evt.getNewValue() == Boolean.TRUE) {

                    add(iconButton);

                } else {

                    remove(iconButton);

                }

            }

            enableActions();

            revalidate();

            repaint();

        }

        //

        // LayoutManager

        //

        public void addLayoutComponent(String name, Component c) {}

        public void removeLayoutComponent(Component c) {}

        public Dimension preferredLayoutSize(Container c) {

            return minimumLayoutSize(c);

        }

        public Dimension minimumLayoutSize(Container c) {

            // Calculate width.

            int width = 22;

            if (frame.isClosable()) {

                width += 19;

            }

            if (frame.isMaximizable()) {

                width += 19;

            }

            if (frame.isIconifiable()) {

                width += 19;

            }

            FontMetrics fm = frame.getFontMetrics(getFont());

            String frameTitle = frame.getTitle();

            int title_w = frameTitle != null ? SwingUtilities2.stringWidth(

                               frame, fm, frameTitle) : 0;

            int title_length = frameTitle != null ? frameTitle.length() : 0;

            // Leave room for three characters in the title.

            if (title_length > 3) {

                int subtitle_w = SwingUtilities2.stringWidth(

                    frame, fm, frameTitle.substring(0, 3) + "...");

                width += (title_w < subtitle_w) ? title_w : subtitle_w;

            } else {

                width += title_w;

            }

            // Calculate height.

            Icon icon = frame.getFrameIcon();

            int fontHeight = fm.getHeight();

            fontHeight += 2;

            int iconHeight = 0;

            if (icon != null) {

                // SystemMenuBar forces the icon to be 16x16 or less.

                iconHeight = Math.min(icon.getIconHeight(), 16);

            }

            iconHeight += 2;

            int height = Math.max( fontHeight, iconHeight );

            Dimension dim = new Dimension(width, height);

            // Take into account the border insets if any.

            if (getBorder() != null) {

                Insets insets = getBorder().getBorderInsets(c);

                dim.height += insets.top + insets.bottom;

                dim.width += insets.left + insets.right;

            }