/*

 * Copyright 2002-2006 Sun Microsystems, Inc.  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.  Sun designates this

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

 * by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,

 * CA 95054 USA or visit www.sun.com if you need additional information or

 * have any questions.

 */

package javax.swing.plaf.synth;

import java.awt.Component;

import java.awt.Container;

import java.awt.Dimension;

import java.awt.Graphics;

import java.awt.Insets;

import java.awt.LayoutManager;

import java.awt.Rectangle;

import java.beans.PropertyChangeEvent;

import java.beans.PropertyChangeListener;

import javax.swing.Box;

import javax.swing.Icon;

import javax.swing.JComponent;

import javax.swing.JSeparator;

import javax.swing.JToolBar;

import javax.swing.plaf.ComponentUI;

import javax.swing.plaf.basic.BasicToolBarUI;

import sun.swing.plaf.synth.SynthIcon;

/**

 * Provides the Synth L&F UI delegate for

 * {@link javax.swing.JToolBar}.

 *

 * @since 1.7

 */

public class SynthToolBarUI extends BasicToolBarUI

                            implements PropertyChangeListener, SynthUI {

    private Icon handleIcon = null;

    private Rectangle contentRect = new Rectangle();

    private SynthStyle style;

    private SynthStyle contentStyle;

    private SynthStyle dragWindowStyle;

    /**

     * Creates a new UI object for the given component.

     *

     * @param c component to create UI object for

     * @return the UI object

     */

    public static ComponentUI createUI(JComponent c) {

        return new SynthToolBarUI();

    }

    /**

     * @inheritDoc

     */

    @Override

    protected void installDefaults() {

        toolBar.setLayout(createLayout());

        updateStyle(toolBar);

    }

    /**

     * @inheritDoc

     */

    @Override

    protected void installListeners() {

        super.installListeners();

        toolBar.addPropertyChangeListener(this);

    }

    /**

     * @inheritDoc

     */

    @Override

    protected void uninstallListeners() {

        super.uninstallListeners();

        toolBar.removePropertyChangeListener(this);

    }

    private void updateStyle(JToolBar c) {

        SynthContext context = getContext(

                c, Region.TOOL_BAR_CONTENT, null, ENABLED);

        contentStyle = SynthLookAndFeel.updateStyle(context, this);

        context.dispose();

        context = getContext(c, Region.TOOL_BAR_DRAG_WINDOW, null, ENABLED);

        dragWindowStyle = SynthLookAndFeel.updateStyle(context, this);

        context.dispose();

        context = getContext(c, ENABLED);

        SynthStyle oldStyle = style;

        style = SynthLookAndFeel.updateStyle(context, this);

        if (oldStyle != style) {

            handleIcon =

                style.getIcon(context, "ToolBar.handleIcon");

            if (oldStyle != null) {

                uninstallKeyboardActions();

                installKeyboardActions();

            }

        }

        context.dispose();

    }

    /**

     * @inheritDoc

     */

    @Override

    protected void uninstallDefaults() {

        SynthContext context = getContext(toolBar, ENABLED);

        style.uninstallDefaults(context);

        context.dispose();

        style = null;

        handleIcon = null;

        context = getContext(toolBar, Region.TOOL_BAR_CONTENT,

                             contentStyle, ENABLED);

        contentStyle.uninstallDefaults(context);

        context.dispose();

        contentStyle = null;

        context = getContext(toolBar, Region.TOOL_BAR_DRAG_WINDOW,

                             dragWindowStyle, ENABLED);

        dragWindowStyle.uninstallDefaults(context);

        context.dispose();

        dragWindowStyle = null;

        toolBar.setLayout(null);

    }

    /**

     * @inheritDoc

     */

    @Override

    protected void installComponents() {}

    /**

     * @inheritDoc

     */

    @Override

    protected void uninstallComponents() {}

    /**

     * Creates a {@code LayoutManager} to use with the toolbar.

     *

     * @return a {@code LayoutManager} instance

     */

    protected LayoutManager createLayout() {

        return new SynthToolBarLayoutManager();

    }

    /**

     * @inheritDoc

     */

    @Override

    public SynthContext getContext(JComponent c) {

        return getContext(c, SynthLookAndFeel.getComponentState(c));

    }

    private SynthContext getContext(JComponent c, int state) {

        return SynthContext.getContext(SynthContext.class, c,

                    SynthLookAndFeel.getRegion(c), style, state);

    }

    private SynthContext getContext(JComponent c, Region region, SynthStyle style) {

        return SynthContext.getContext(SynthContext.class, c, region,

                                       style, getComponentState(c, region));

    }

    private SynthContext getContext(JComponent c, Region region,

                                    SynthStyle style, int state) {

        return SynthContext.getContext(SynthContext.class, c, region,

                                       style, state);

    }

    private int getComponentState(JComponent c, Region region) {

        return SynthLookAndFeel.getComponentState(c);

    }

    /**

     */

    @Override

    public void update(Graphics g, JComponent c) {

        SynthContext context = getContext(c);

        SynthLookAndFeel.update(context, g);

        context.getPainter().paintToolBarBackground(context,

                          g, 0, 0, c.getWidth(), c.getHeight(),

                          toolBar.getOrientation());

        paint(context, g);

        context.dispose();

    }

    /**

     */

    @Override

    public void paint(Graphics g, JComponent c) {

        SynthContext context = getContext(c);

        paint(context, g);

        context.dispose();

    }

    /**

     * @inheritDoc

     */

    @Override

    public void paintBorder(SynthContext context, Graphics g, int x,

                            int y, int w, int h) {

        context.getPainter().paintToolBarBorder(context, g, x, y, w, h,

                                                toolBar.getOrientation());

    }

    // Overloaded to do nothing so we can share listeners.

    /**

     * @inheritDoc

     */

    @Override

    protected void setBorderToNonRollover(Component c) {}

    // Overloaded to do nothing so we can share listeners.

    /**

     * @inheritDoc

     */

    @Override

    protected void setBorderToRollover(Component c) {}

    // Overloaded to do nothing so we can share listeners.

    /**

     * @inheritDoc

     */

    @Override

    protected void setBorderToNormal(Component c) {}

    /**

     * Paints the toolbar.

     *

     * @param context context for the component being painted

     */

    protected void paint(SynthContext context, Graphics g) {

        if (handleIcon != null && toolBar.isFloatable()) {

            int startX = toolBar.getComponentOrientation().isLeftToRight() ?

                0 : toolBar.getWidth() -

                    SynthIcon.getIconWidth(handleIcon, context);

            SynthIcon.paintIcon(handleIcon, context, g, startX, 0,

                    SynthIcon.getIconWidth(handleIcon, context),

                    SynthIcon.getIconHeight(handleIcon, context));

        }

        SynthContext subcontext = getContext(

                toolBar, Region.TOOL_BAR_CONTENT, contentStyle);

        paintContent(subcontext, g, contentRect);

        subcontext.dispose();

    }

    /**

     * Paints the toolbar content.

     *

     * @param context context for the component being painted

     * @param g {@code Graphics} object used for painting

     * @param bounds bounding box for the toolbar

     */

    protected void paintContent(SynthContext context, Graphics g,

            Rectangle bounds) {

        SynthLookAndFeel.updateSubregion(context, g, bounds);

        context.getPainter().paintToolBarContentBackground(context, g,

                             bounds.x, bounds.y, bounds.width, bounds.height,

                             toolBar.getOrientation());

        context.getPainter().paintToolBarContentBorder(context, g,

                             bounds.x, bounds.y, bounds.width, bounds.height,

                             toolBar.getOrientation());

    }

    /**

     * @inheritDoc

     */

    @Override

    protected void paintDragWindow(Graphics g) {

        int w = dragWindow.getWidth();

        int h = dragWindow.getHeight();

        SynthContext context = getContext(

                toolBar, Region.TOOL_BAR_DRAG_WINDOW, dragWindowStyle);

        SynthLookAndFeel.updateSubregion(

                context, g, new Rectangle(0, 0, w, h));

        context.getPainter().paintToolBarDragWindowBackground(context,

                                                           g, 0, 0, w, h,

                                                           dragWindow.getOrientation());

        context.getPainter().paintToolBarDragWindowBorder(context, g, 0, 0, w, h,

                                                          dragWindow.getOrientation());

        context.dispose();

    }

    //

    // PropertyChangeListener

    //

    /**

     * @inheritDoc

     */

    @Override

    public void propertyChange(PropertyChangeEvent e) {

        if (SynthLookAndFeel.shouldUpdateStyle(e)) {

            updateStyle((JToolBar)e.getSource());

        }

    }

    class SynthToolBarLayoutManager implements LayoutManager {

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

        public void removeLayoutComponent(Component comp) {}

        public Dimension minimumLayoutSize(Container parent) {

            JToolBar tb = (JToolBar)parent;

            Insets insets = tb.getInsets();

            Dimension dim = new Dimension();

            SynthContext context = getContext(tb);

            if (tb.getOrientation() == JToolBar.HORIZONTAL) {

                dim.width = tb.isFloatable() ?

                    SynthIcon.getIconWidth(handleIcon, context) : 0;

                Dimension compDim;

                for (int i = 0; i < tb.getComponentCount(); i++) {

                    compDim = tb.getComponent(i).getMinimumSize();

                    dim.width += compDim.width;

                    dim.height = Math.max(dim.height, compDim.height);

                }

            } else {

                dim.height = tb.isFloatable() ?

                    SynthIcon.getIconHeight(handleIcon, context) : 0;

                Dimension compDim;

                for (int i = 0; i < tb.getComponentCount(); i++) {

                    compDim = tb.getComponent(i).getMinimumSize();

                    dim.width = Math.max(dim.width, compDim.width);

                    dim.height += compDim.height;

                }

            }

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

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

            context.dispose();

            return dim;

        }

        public Dimension preferredLayoutSize(Container parent) {

            JToolBar tb = (JToolBar)parent;

            Insets insets = tb.getInsets();

            Dimension dim = new Dimension();

            SynthContext context = getContext(tb);

            if (tb.getOrientation() == JToolBar.HORIZONTAL) {

                dim.width = tb.isFloatable() ?

                    SynthIcon.getIconWidth(handleIcon, context) : 0;

                Dimension compDim;

                for (int i = 0; i < tb.getComponentCount(); i++) {

                    compDim = tb.getComponent(i).getPreferredSize();

                    dim.width += compDim.width;

                    dim.height = Math.max(dim.height, compDim.height);

                }

            } else {

                dim.height = tb.isFloatable() ?

                    SynthIcon.getIconHeight(handleIcon, context) : 0;

                Dimension compDim;

                for (int i = 0; i < tb.getComponentCount(); i++) {

                    compDim = tb.getComponent(i).getPreferredSize();

                    dim.width = Math.max(dim.width, compDim.width);

                    dim.height += compDim.height;

                }

            }

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

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

            context.dispose();

            return dim;

        }

        public void layoutContainer(Container parent) {

            JToolBar tb = (JToolBar)parent;

            Insets insets = tb.getInsets();

            boolean ltr = tb.getComponentOrientation().isLeftToRight();

            SynthContext context = getContext(tb);

            Component c;

            Dimension d;

            // JToolBar by default uses a somewhat modified BoxLayout as

            // its layout manager. For compatibility reasons, we want to

            // support Box "glue" as a way to move things around on the

            // toolbar. "glue" is represented in BoxLayout as a Box.Filler

            // with a minimum and preferred size of (0,0).

            // So what we do here is find the number of such glue fillers

            // and figure out how much space should be allocated to them.

            int glueCount = 0;

            for (int i=0; i<tb.getComponentCount(); i++) {

                if (isGlue(tb.getComponent(i))) glueCount++;

            }

            if (tb.getOrientation() == JToolBar.HORIZONTAL) {

                int handleWidth = tb.isFloatable() ?

                    SynthIcon.getIconWidth(handleIcon, context) : 0;

                // Note: contentRect does not take insets into account

                // since it is used for determining the bounds that are

                // passed to paintToolBarContentBackground().

                contentRect.x = ltr ? handleWidth : 0;

                contentRect.y = 0;

                contentRect.width = tb.getWidth() - handleWidth;

                contentRect.height = tb.getHeight();

                // However, we do take the insets into account here for

                // the purposes of laying out the toolbar child components.

                int x = ltr ?

                    handleWidth + insets.left :

                    tb.getWidth() - handleWidth - insets.right;

                int baseY = insets.top;

                int baseH = tb.getHeight() - insets.top - insets.bottom;

                // we need to get the minimum width for laying things out

                // so that we can calculate how much empty space needs to

                // be distributed among the "glue", if any

                int extraSpacePerGlue = 0;

                if (glueCount > 0) {

                    int minWidth = minimumLayoutSize(parent).width;

                    extraSpacePerGlue = (tb.getWidth() - minWidth) / glueCount;

                    if (extraSpacePerGlue < 0) extraSpacePerGlue = 0;

                }

                for (int i = 0; i < tb.getComponentCount(); i++) {

                    c = tb.getComponent(i);

                    d = c.getPreferredSize();

                    int y, h;

                    if (d.height >= baseH || c instanceof JSeparator) {

                        // Fill available height

                        y = baseY;

                        h = baseH;

                    } else {

                        // Center component vertically in the available space

                        y = baseY + (baseH / 2) - (d.height / 2);

                        h = d.height;

                    }

                    //if the component is a "glue" component then add to its

                    //width the extraSpacePerGlue it is due

                    if (isGlue(c)) d.width += extraSpacePerGlue;

                    c.setBounds(ltr ? x : x - d.width, y, d.width, h);

                    x = ltr ? x + d.width : x - d.width;

                }

            } else {

                int handleHeight = tb.isFloatable() ?

                    SynthIcon.getIconHeight(handleIcon, context) : 0;

                // See notes above regarding the use of insets

                contentRect.x = 0;

                contentRect.y = handleHeight;

                contentRect.width = tb.getWidth();

                contentRect.height = tb.getHeight() - handleHeight;

                int baseX = insets.left;

                int baseW = tb.getWidth() - insets.left - insets.right;

                int y = handleHeight + insets.top;

                // we need to get the minimum height for laying things out

                // so that we can calculate how much empty space needs to

                // be distributed among the "glue", if any

                int extraSpacePerGlue = 0;

                if (glueCount > 0) {

                    int minHeight = minimumLayoutSize(parent).height;

                    extraSpacePerGlue = (tb.getHeight() - minHeight) / glueCount;

                    if (extraSpacePerGlue < 0) extraSpacePerGlue = 0;

                }

                for (int i = 0; i < tb.getComponentCount(); i++) {