/*
 File: Arrow.java

 Copyright (c) 2006, The Cytoscape Consortium (www.cytoscape.org)

 The Cytoscape Consortium is:
 - Institute for Systems Biology
 - University of California San Diego
 - Memorial Sloan-Kettering Cancer Center
 - Institut Pasteur
 - Agilent Technologies

 This library is free software; you can redistribute it and/or modify it
 under the terms of the GNU Lesser General Public License as published
 by the Free Software Foundation; either version 2.1 of the License, or
 any later version.

 This library 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.  The software and
 documentation provided hereunder is on an "as is" basis, and the
 Institute for Systems Biology and the Whitehead Institute
 have no obligations to provide maintenance, support,
 updates, enhancements or modifications.  In no event shall the
 Institute for Systems Biology and the Whitehead Institute
 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
 Institute for Systems Biology and the Whitehead Institute
 have been advised of the possibility of such damage.  See
 the GNU Lesser General Public License for more details.

 You should have received a copy of the GNU Lesser General Public License
 along with this library; if not, write to the Free Software Foundation,
 Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
 */

//----------------------------------------------------------------------------
// $Revision: 18694 $
// $Date: 2009-12-07 17:35:57 -0600 (Mon, 07 Dec 2009) $
// $Author: mes $
//----------------------------------------------------------------------------
package cytoscape.visual;

import giny.view.EdgeView;

import java.awt.Color;

import java.io.Serializable;


/**
 * This class is a replacement for the yFiles Arrow class.
 */
public class Arrow
    implements Serializable {
    private static final Color DEFAULT_ARROW_COLOR = Color.BLACK;

    /**
     * DOCUMENT ME!
     */
    public static final Arrow NONE = new Arrow(ArrowShape.NONE,
            DEFAULT_ARROW_COLOR);

    /**
     * DOCUMENT ME!
     */
    public static final Arrow DIAMOND = new Arrow(ArrowShape.DIAMOND,
            DEFAULT_ARROW_COLOR);

    /**
     * DOCUMENT ME!
     */
    public static final Arrow DELTA = new Arrow(ArrowShape.DELTA,
            DEFAULT_ARROW_COLOR);

    /**
     * DOCUMENT ME!
     */
    public static final Arrow ARROW = new Arrow(ArrowShape.ARROW,
            DEFAULT_ARROW_COLOR);

    /**
     * DOCUMENT ME!
     */
    public static final Arrow T = new Arrow(ArrowShape.T, DEFAULT_ARROW_COLOR);

    /**
     * DOCUMENT ME!
     */
    public static final Arrow CIRCLE = new Arrow(ArrowShape.CIRCLE,
            DEFAULT_ARROW_COLOR);

    /*
     * New in 2.5: Arrow can have arbitrary color. This can be different from
     */
    private Color arrowColor;
    private ArrowShape shape;

    // Maybe supported in future.
    private int size;

    /**
     * New constructor for 2.5 and later:<br>
     *
     * @param shape
     * @param arrowColor
     */
    public Arrow(ArrowShape shape, Color arrowColor) {
        this.shape = shape;
        this.arrowColor = arrowColor;
    }

    /**
     * DOCUMENT ME!
     *
     * @return DOCUMENT ME!
     */
    public ArrowShape getShape() {
        return shape;
    }

    /**
     * DOCUMENT ME!
     *
     * @param newShape DOCUMENT ME!
     */
    public void setShape(ArrowShape newShape) {
        this.shape = newShape;
    }

    /**
     * DOCUMENT ME!
     *
     * @return DOCUMENT ME!
     */
    public Color getColor() {
        return arrowColor;
    }

    /**
     * DOCUMENT ME!
     *
     * @param newColor DOCUMENT ME!
     */
    public void setColor(Color newColor) {
        this.arrowColor = newColor;
    }

    /**
     * DOCUMENT ME!
     *
     * @return DOCUMENT ME!
     */
    public String toString() {
        return shape.getGinyName();
    }

    /**
     * DOCUMENT ME!
     *
     * @param text DOCUMENT ME!
     *
     * @return DOCUMENT ME!
     */
    public static Arrow parseArrowText(String text) {
        String arrowtext = text.trim();

        if (arrowtext.equals("WHITE_DIAMOND"))
            return new Arrow(ArrowShape.DIAMOND, Color.white);
        else if (arrowtext.equals("BLACK_DIAMOND"))
            return DIAMOND;
        else if (arrowtext.equals("COLOR_DIAMOND"))
            return DIAMOND;

        else if (arrowtext.equals("WHITE_DELTA"))
            return new Arrow(ArrowShape.DELTA, Color.white);
        else if (arrowtext.equals("BLACK_DELTA"))
            return DELTA;
        else if (arrowtext.equals("COLOR_DELTA"))
            return DELTA;

        else if (arrowtext.equals("WHITE_ARROW"))
            return new Arrow(ArrowShape.ARROW, Color.white);
        else if (arrowtext.equals("BLACK_ARROW"))
            return ARROW;
        else if (arrowtext.equals("COLOR_ARROW"))
            return ARROW;

        else if (arrowtext.equals("WHITE_T"))
            return new Arrow(ArrowShape.T, Color.white);
        else if (arrowtext.equals("BLACK_T"))
            return T;
        else if (arrowtext.equals("COLOR_T"))
            return T;

        else if (arrowtext.equals("WHITE_CIRCLE"))
            return new Arrow(ArrowShape.CIRCLE, Color.white);
        else if (arrowtext.equals("BLACK_CIRCLE"))
            return CIRCLE;
        else if (arrowtext.equals("COLOR_CIRCLE"))
            return CIRCLE;

        else

            return Arrow.NONE;
    } // parseArrowText
}