// $Id: StylePanelFig.java,v 1.24 2004/09/21 19:03:28 mvw Exp $
// Copyright (c) 2003-2004 The Regents of the University of California. All
// Rights Reserved. Permission to use, copy, modify, and distribute this
// software and its documentation without fee, and without a written
// agreement is hereby granted, provided that the above copyright notice
// and this paragraph appear in all copies. This software program and
// documentation are copyrighted by The Regents of the University of
// California. The software program and documentation are supplied "AS
// IS", without any accompanying services from The Regents. The Regents
// does not warrant that the operation of the program will be
// uninterrupted or error-free. The end-user understands that the program
// was developed for research purposes and is advised not to rely
// exclusively on the program for any reason. IN NO EVENT SHALL THE
// UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT,
// SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS,
// ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
// THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
// SUCH DAMAGE. THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY
// WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
// PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
// CALIFORNIA HAS NO OBLIGATIONS TO PROVIDE MAINTENANCE, SUPPORT,
// UPDATES, ENHANCEMENTS, OR MODIFICATIONS.

package org.argouml.ui;

import java.awt.Color;
import java.awt.GridBagConstraints;
import java.awt.GridBagLayout;
import java.awt.Rectangle;
import java.awt.event.FocusEvent;
import java.awt.event.FocusListener;
import java.awt.event.ItemEvent;
import java.awt.event.ItemListener;
import java.awt.event.KeyEvent;
import java.awt.event.KeyListener;

import javax.swing.JColorChooser;
import javax.swing.JComboBox;
import javax.swing.JLabel;
import javax.swing.JTextField;
import javax.swing.text.Document;

import org.apache.log4j.Logger;
import org.argouml.i18n.Translator;
import org.argouml.kernel.Project;
import org.argouml.kernel.ProjectManager;
import org.argouml.uml.diagram.ui.FigEdgeModelElement;
import org.tigris.gef.ui.ColorRenderer;

/**
 * The basic stylepanel which provides line and fill color information.
 *  
 */
public class StylePanelFig extends StylePanel implements ItemListener,
        FocusListener, KeyListener {

    private static final Logger LOG = Logger
            .getLogger(StylePanelFigNodeModelElement.class);

    private static final String CUSTOM_ITEM = Translator
            .localize("label.stylepane.custom")
            + "...";

    private JLabel bboxLabel = new JLabel(Translator
            .localize("label.stylepane.bounds")
            + ": ");

    private JTextField bboxField = new JTextField();

    private JLabel fillLabel = new JLabel(Translator
            .localize("label.stylepane.fill")
            + ": ");

    private JComboBox fillField = new JComboBox();

    private JLabel lineLabel = new JLabel(Translator
            .localize("label.stylepane.line")
            + ": ");

    private JComboBox lineField = new JComboBox();

    private SpacerPanel spacer = new SpacerPanel();

    private SpacerPanel spacer2 = new SpacerPanel();

    private SpacerPanel spacer3 = new SpacerPanel();

    /**
     * The constructor of the style panel of a Fig.
     * 
     * @param title the title string
     */
    public StylePanelFig(String title) {
        super(title);
    }

    /**
     * The constructor.
     * 
     */
    public StylePanelFig() {
        super("Fig Appearance");
        initChoices();
        GridBagLayout gb = (GridBagLayout) getLayout();
        GridBagConstraints c = new GridBagConstraints();
        c.fill = GridBagConstraints.BOTH;
        c.ipadx = 0;
        c.ipady = 0;

        Document bboxDoc = bboxField.getDocument();
        bboxDoc.addDocumentListener(this);
        bboxField.addKeyListener(this);
        bboxField.addFocusListener(this);
        fillField.addItemListener(this);
        lineField.addItemListener(this);

        fillField.setRenderer(new ColorRenderer());
        lineField.setRenderer(new ColorRenderer());
        //_dashedField.setRenderer(DashRenderer.SINGLETON);

        c.gridx = 0;
        c.gridwidth = 1;
        c.gridy = 1;
        c.weightx = 0.0;
        gb.setConstraints(bboxLabel, c);
        add(bboxLabel);
        c.gridy = 2;
        gb.setConstraints(fillLabel, c);
        add(fillLabel);
        c.gridy = 3;
        gb.setConstraints(lineLabel, c);
        add(lineLabel);
        c.gridy = 4;

        c.weightx = 1.0;
        c.gridx = 1;
        //c.gridwidth = GridBagConstraints.REMAINDER;
        c.gridy = 1;
        gb.setConstraints(bboxField, c);
        add(bboxField);
        c.gridy = 2;
        gb.setConstraints(fillField, c);
        add(fillField);
        c.gridy = 3;
        gb.setConstraints(lineField, c);
        add(lineField);

        c.weightx = 0.0;
        c.gridx = 2;
        c.gridy = 1;
        gb.setConstraints(spacer, c);
        add(spacer);

        c.gridx = 3;
        c.gridy = 10;
        gb.setConstraints(spacer2, c);
        add(spacer2);

        c.weightx = 1.0;
        c.gridx = 4;
        c.gridy = 10;
        gb.setConstraints(spacer3, c);
        add(spacer3);
    }

    /**
     * Fill in the user-choices.
     */
    protected void initChoices() {
        fillField.addItem(Translator.localize("label.stylepane.no-fill"));
        fillField.addItem(Color.black);
        fillField.addItem(Color.white);
        fillField.addItem(Color.gray);
        fillField.addItem(Color.lightGray);
        fillField.addItem(Color.darkGray);
        fillField.addItem(new Color(255, 255, 200));
        fillField.addItem(new Color(255, 200, 255));
        fillField.addItem(new Color(200, 255, 255));
        fillField.addItem(new Color(200, 200, 255));
        fillField.addItem(new Color(200, 255, 200));
        fillField.addItem(new Color(255, 200, 200));
        fillField.addItem(new Color(200, 200, 200));
        fillField.addItem(Color.red);
        fillField.addItem(Color.blue);
        fillField.addItem(Color.cyan);
        fillField.addItem(Color.yellow);
        fillField.addItem(Color.magenta);
        fillField.addItem(Color.green);
        fillField.addItem(Color.orange);
        fillField.addItem(Color.pink);
        fillField.addItem(CUSTOM_ITEM);

        lineField.addItem(Translator.localize("label.stylepane.no-line"));
        lineField.addItem(Color.black);
        lineField.addItem(Color.white);
        lineField.addItem(Color.gray);
        lineField.addItem(Color.lightGray);
        lineField.addItem(Color.darkGray);
        lineField.addItem(new Color(60, 60, 200));
        lineField.addItem(new Color(60, 200, 60));
        lineField.addItem(new Color(200, 60, 60));
        lineField.addItem(Color.red);
        lineField.addItem(Color.blue);
        lineField.addItem(Color.cyan);
        lineField.addItem(Color.yellow);
        lineField.addItem(Color.magenta);
        lineField.addItem(Color.green);
        lineField.addItem(Color.orange);
        lineField.addItem(Color.pink);
        lineField.addItem(CUSTOM_ITEM);
    }

    /**
     * set whether this Fig has a editable boundingbox. This is done normally in
     * refresh(), e.g. for FigEdgeModelElements where it does
     * not make sense to edit the bounding box.
     * 
     * @param value
     *            the boolean value of the bounding box property
     */

    protected void hasEditableBoundingBox(boolean value) {
        bboxField.setEnabled(value);
        bboxLabel.setEnabled(value);
    }

    /**
     * 

     * Handle a refresh of the style panel after the fig has moved.
     * 
     * 
     * 

     * Warning. There is a circular trap here. Editing the boundary
     * box will also trigger a refresh, and so we reset the boundary box, which
     * causes funny behaviour (the cursor keeps jumping to the end of the text).
     * 
     * 
     * 

     * The solution is to not reset the boundary box field if the boundaries
     * have not changed.
     * 
     */
    public void refresh() {

        if (getPanelTarget() instanceof FigEdgeModelElement) {
            hasEditableBoundingBox(false);
        } else
            hasEditableBoundingBox(true);
        
        // The boundary box as held in the target fig, and as listed in
        // the
        // boundary box style field (null if we don't have anything
        // valid)

        Rectangle figBounds = getPanelTarget().getBounds();
        Rectangle styleBounds = parseBBox();

        // Only reset the text if the two are not the same (i.e the fig
        // has
        // moved, rather than we've just edited the text, when
        // setTargetBBox()
        // will have made them the same). Note that styleBounds could
        // be null,
        // so we do the test this way round.

        if (!(figBounds.equals(styleBounds))) {
            bboxField.setText(figBounds.x + "," + figBounds.y + ","
                    + figBounds.width + "," + figBounds.height);
        }

        // Change the fill colour

        if (getPanelTarget().getFilled()) {
            Color c = getPanelTarget().getFillColor();
            fillField.setSelectedItem(c);
            if (c != null && !fillField.getSelectedItem().equals(c)) {
                fillField.insertItemAt(c, fillField.getItemCount() - 1);
                fillField.setSelectedItem(c);
            }
        } else {
            fillField.setSelectedIndex(0);
        }

        // Change the line colour

        if (getPanelTarget().getLineWidth() > 0) {
            Color c = getPanelTarget().getLineColor();
            lineField.setSelectedItem(c);
            if (c != null && !lineField.getSelectedItem().equals(c)) {
                lineField.insertItemAt(c, lineField.getItemCount() - 1);
                lineField.setSelectedItem(c);
            }
        } else {
            lineField.setSelectedIndex(0);
        }

    }

    /**
     * 

     * Change the bounds of the target fig. Called whenever the bounds box is
     * edited.
     * 
     * 
     * 

     * Format of the bounds is four integers representing x, y, width and height
     * separated by spaces or commas. An empty field is treated as no change and
     * leading and trailing spaces are ignored.
     * 
     * 
     * 

     * Note. There is a note in the old code that more work might be
     * needed, because this could change the graph model. I don't see how that
     * could ever be.
     * 
     */
    protected void setTargetBBox() { // Can't do anything if we don't have
        // a
        // fig.
        if (getPanelTarget() == null) { return; } 
        // Parse the boundary box text. Null is
        // returned if it is empty or
        // invalid, which causes no change. Otherwise we tell
        // GEF we are making
        // a change, make the change and tell GEF we've
        // finished.
        Rectangle bounds = parseBBox();
        if (bounds == null) { return; }

        if (!getPanelTarget().getBounds().equals(bounds)) {
            getPanelTarget().setBounds(bounds.x, bounds.y, bounds.width, 
                    bounds.height);
            getPanelTarget().endTrans();
            markNeedsSave();
        }
    }

    /**
     * 

     * Parse the boundary box string and return the rectangle it represents.
     * 
     * 
     * 

     * The syntax are four integers separated by spaces or commas. We ignore
     * leading and trailing blanks.
     * 
     * 
     * 

     * If we have the empty string we return null.
     * 
     * 
     * 

     * If we fail to parse, then we return null and print out a
     * rude message.
     * 
     * 
     * @return The size of the box, or null if the bounds string
     *         is empty or invalid.
     */
    protected Rectangle parseBBox() {
        // Get the text in the field, and don't do anything if the
        // field is
        // empty.
        String bboxStr = bboxField.getText().trim();
        if (bboxStr.length() == 0) { return null; } // Parse the string as if
        // possible
        Rectangle res = new Rectangle();
        java.util.StringTokenizer st = new java.util.StringTokenizer(bboxStr,
                ", ");
        try {
            boolean changed = false;
            if (!st.hasMoreTokens()) return getPanelTarget().getBounds();
            res.x = Integer.parseInt(st.nextToken());
            if (!st.hasMoreTokens()) {
                res.y = getPanelTarget().getBounds().y;
                res.width = getPanelTarget().getBounds().width;
                res.height = getPanelTarget().getBounds().height;
                return res;
            }
            res.y = Integer.parseInt(st.nextToken());
            if (!st.hasMoreTokens()) {
                res.width = getPanelTarget().getBounds().width;
                res.height = getPanelTarget().getBounds().height;
                return res;
            }
            res.width = Integer.parseInt(st.nextToken());
            if ((res.width + res.x) > 6000) {
                res.width = 6000 - res.x;
                changed = true;
            }
            if (!st.hasMoreTokens()) {
                res.width = getPanelTarget().getBounds().width;
                return res;
            }
            res.height = Integer.parseInt(st.nextToken());
            if ((res.height + res.y) > 6000) {
                res.height = 6000 - res.y;
                changed = true;
            }
            if (changed) {
                StringBuffer sb = new StringBuffer();
                sb.append(Integer.toString(res.x));
                sb.append(",");
                sb.append(Integer.toString(res.y));
                sb.append(",");
                sb.append(Integer.toString(res.width));
                sb.append(",");
                sb.append(Integer.toString(res.height));
                bboxField.setText(sb.toString());
            }
        } catch (NumberFormatException ex) {
            return null;
        }

        return res;
    }

    /**
     * Prompts the user for a new custom color and adds that color to the combo
     * box.
     *
     * @param field the combobox to enter a new color for
     * @param title the title for the dialog box
     * @param targetColor the initial Color set when the color-chooser is shown
     */
    protected void handleCustomColor(JComboBox field, String title,
            Color targetColor) {
        Color newColor = JColorChooser.showDialog(ProjectBrowser.getInstance(),
                title, targetColor);
        if (newColor != null) {
            field.insertItemAt(newColor, field.getItemCount() - 1);
            field.setSelectedItem(newColor);
        } else if (getPanelTarget() != null) {
            field.setSelectedItem(targetColor);
        }
    }

    /**
     * Change the fill.
     */
    public void setTargetFill() {
        Object c = fillField.getSelectedItem();
        if (getPanelTarget() == null || c == null) return;
        Color oldColor = getPanelTarget().getFillColor();
        if (c instanceof Color) getPanelTarget().setFillColor((Color) c);
        getPanelTarget().setFilled(c instanceof Color);
        getPanelTarget().endTrans();
        if (!c.equals(oldColor)) {
            markNeedsSave();
        }
    }

    /**
     * Change the line.
     */
    public void setTargetLine() {
        Object c = lineField.getSelectedItem();
        if (getPanelTarget() == null || c == null) return;
        Color oldColor = getPanelTarget().getLineColor();
        if (c instanceof Color) getPanelTarget().setLineColor((Color) c);
        getPanelTarget().setLineWidth((c instanceof Color) ? 1 : 0);
        getPanelTarget().endTrans();
        if (!c.equals(oldColor)) {
            markNeedsSave();
        }
    }

    /**
     * Called when some property of the target has changed through the style
     * panel. Sets the save flag in the current project.
     */
    protected void markNeedsSave() {
        Project p = ProjectManager.getManager().getCurrentProject();
        if (p != null) {
            p.setNeedsSave(true);
        }
    }

    /**
     * @see java.awt.event.ItemListener#itemStateChanged(java.awt.event.ItemEvent)
     */
    public void itemStateChanged(ItemEvent e) {
        Object src = e.getSource();
        if (e.getStateChange() == ItemEvent.SELECTED 
                && getPanelTarget() != null) {
            if (src == fillField) {
                if (e.getItem() == CUSTOM_ITEM) {
                    handleCustomColor(fillField, "Custom Fill Color", 
                            getPanelTarget().getFillColor());
                }
                setTargetFill();
            } else if (src == lineField) {
                if (e.getItem() == CUSTOM_ITEM) {
                    handleCustomColor(lineField, "Custom Line Color", 
                            getPanelTarget().getLineColor());
                }
                setTargetLine();
            }
        }
    }

    /**
     * @see java.awt.event.FocusListener#focusGained(java.awt.event.FocusEvent)
     */
    public void focusGained(FocusEvent e) {
    }

    /**
     * Makes sure that the fig is updated when the _bboxField loses focus.
     * 
     * @see java.awt.event.FocusListener#focusLost(java.awt.event.FocusEvent)
     */
    public void focusLost(FocusEvent e) {
        if (e.getSource() == bboxField) {
            setTargetBBox();
        }
    }

    /**
     * @see java.awt.event.KeyListener#keyPressed(java.awt.event.KeyEvent)
     */
    public void keyPressed(KeyEvent e) {
    }

    /**
     * @see java.awt.event.KeyListener#keyReleased(java.awt.event.KeyEvent)
     */
    public void keyReleased(KeyEvent e) {
    }

    /**
     * Tests if enter is pressed in the _bbodField so we need to set the target
     * bounds.
     * 
     * @see java.awt.event.KeyListener#keyTyped(java.awt.event.KeyEvent)
     */
    public void keyTyped(KeyEvent e) {
        if (e.getSource().equals(bboxField) && e.getKeyChar() == '\n') {
            setTargetBBox();
        }
    }

    /**
     * @return Returns the _bboxLabel.
     */
    protected JLabel getBBoxLabel() {
        return bboxLabel;
    }

    /**
     * @return Returns the _bboxField.
     */
    protected JTextField getBBoxField() {
        return bboxField;
    }

    /**
     * @return Returns the _fillLabel.
     */
    protected JLabel getFillLabel() {
        return fillLabel;
    }

    /**
     * @return Returns the _fillField.
     */
    protected JComboBox getFillField() {
        return fillField;
    }

    /**
     * @return Returns the _lineLabel.
     */
    protected JLabel getLineLabel() {
        return lineLabel;
    }

    /**
     * @return Returns the _lineField.
     */
    protected JComboBox getLineField() {
        return lineField;
    }

    /**
     * @return Returns the _spacer.
     */
    protected SpacerPanel getSpacer() {
        return spacer;
    }

    /**
     * @return Returns the _spacer2.
     */
    protected SpacerPanel getSpacer2() {
        return spacer2;
    }

    /**
     * @return Returns the _spacer3.
     */
    protected SpacerPanel getSpacer3() {
        return spacer3;
    }

}