/*
 File: LabelPlacerGraphic.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.
 */
package cytoscape.visual.ui;

import giny.view.Label;

import java.awt.BasicStroke;
import java.awt.Color;
import java.awt.Dimension;
import java.awt.FontMetrics;
import java.awt.Graphics;
import java.awt.Graphics2D;
import java.awt.Point;
import java.awt.RenderingHints;
import java.awt.Stroke;
import java.awt.event.MouseAdapter;
import java.awt.event.MouseEvent;
import java.awt.event.MouseMotionAdapter;
import java.awt.geom.Point2D;
import java.beans.PropertyChangeEvent;
import java.beans.PropertyChangeListener;

import javax.swing.JPanel;

import cytoscape.visual.LabelPosition;


/**
 * A drag and drop graphic that allows users to set the placement
 * of node labels.
 * 
 * Deprecated.  Use ObjectPlacerGraphic instead.  Will be removed 03/2011
 * 
 * @deprecated
 */
@Deprecated
public class LabelPlacerGraphic extends JPanel implements PropertyChangeListener {
	private LabelPosition lp;

	// dimensions of panel 
	private int default_xy = 500;
	private int xy;
	private int center;
	private float offsetRatio;

	// dimensions for node box
	private int nxy;

	// locations of node points
	private int[] npoints;

	// dimensions for label box
	private int lx;
	private int ly;

	// locations for label points
	private int[] lxpoints;
	private int[] lypoints;

	// diameter of a point
	private int dot;

	// x/y positions for label box, initially offset
	private int xPos;
	private int yPos;

	// indices of the closest points
	private int bestLabelX = 1;
	private int bestLabelY = 1;
	private int bestNodeX = 1;
	private int bestNodeY = 1;

	// mouse drag state
	private boolean beenDragged = false;
	private boolean canOffsetDrag = false;

	// click offset
	private int xClickOffset = 0;
	private int yClickOffset = 0;

	// the x and y offsets for the label rendering
	private int xOffset;
	private int yOffset;

	// default text justify rule
	private int justify;

	// used to label box and node
	private Color transparentRed = new Color(1.0f, 0.0f, 0.0f, 0.1f);
	private Color transparentBlue = new Color(0.0f, 0.0f, 1.0f, 0.1f);
	private Color transparentMagenta = new Color(0.0f, 0.0f, 1.0f, 0.05f);

	// used to determine the render level of detail
	private boolean renderDetail;

	// strings for the graphic
	private String label = "LABEL";
	private String node = "NODE";
	private String click = "CLICK 'N DRAG";

	// font metrics for strings
	private int labelLen = 0;
	private int nodeLen = 0;
	private int clickLen = 0;
	private int ascent = 0;
	private int detailStrokeWidth = 3;
	private int lowStrokeWidth = 1;
	private Stroke detailStroke = new BasicStroke(detailStrokeWidth);
	private Stroke lowStroke = new BasicStroke(lowStrokeWidth);

	private double gravityDistance = 10;

	/**
	 * A gui for placing a label relative to a node. Draws the graphic
	 * in full detail at a size of 500 pixels.
	 * @param pos initial label position
	 */
	public LabelPlacerGraphic(LabelPosition pos) {
		this(pos, 500, true);
	}

	/**
	 * A gui for placing a label relative to a node.
	 * @param pos initial label position
	 * @param size number of pixels square the that graphic should be
	 * @param fullDetail whether or not to render at full detail or not
	 */
	public LabelPlacerGraphic(LabelPosition pos, int size, boolean fullDetail) {
		super();

		if (pos == null)
			lp = new LabelPosition();
		else
			lp = pos;

		renderDetail = fullDetail;

		initSize(size);

		setPreferredSize(new Dimension(xy, xy));
		setBackground(Color.white);


		addMouseListener(new MouseClickHandler());
		addMouseMotionListener(new MouseDragHandler());

		applyPosition();

		repaint();
	}

	private void initSize(int size) {
		// dimensions of panel 
		xy = size;
		center = xy / 2;

		offsetRatio = (float) xy / (float) default_xy;

		// dimensions for node box
		nxy = (int) (0.3 * xy);

		// locations of node points
		int[] tnpoints = { center - (nxy / 2), center, center + (nxy / 2) };
		npoints = tnpoints;

		// dimensions for label box
		lx = (int) (0.4 * xy);
		ly = (int) (0.1 * xy);

		// locations for label points
		int[] tlxpoints = { 0, lx / 2, lx };
		int[] tlypoints = { 0, ly / 2, ly };
		lxpoints = tlxpoints;
		lypoints = tlypoints;

		// diameter of a point
		dot = (int) (0.02 * xy);

		// x/y positions for label box, initially offset
		xPos = dot;
		yPos = dot;
	}

	/**
	 * The method that handles the rendering of placement gui.
	 */
	public void paint(Graphics gin) {
		Graphics2D g = (Graphics2D) gin;

		g.setRenderingHint(RenderingHints.KEY_ANTIALIASING, RenderingHints.VALUE_ANTIALIAS_ON);

		// calculate the font 
		if (labelLen <= 0) {
			FontMetrics fm = g.getFontMetrics();
			labelLen = fm.stringWidth(label);
			nodeLen = fm.stringWidth(node);
			clickLen = fm.stringWidth(click);
			ascent = fm.getMaxAscent();
		}

		// clear the screen
		g.setColor(Color.white);
		g.fillRect(0, 0, xy, xy);

		// draw the node box
		int x = center - (nxy / 2);
		int y = center - (nxy / 2);

		g.setColor(transparentBlue);
		g.fillOval(x, y, nxy, nxy);

		if (renderDetail)
			g.setStroke(detailStroke);
		else
			g.setStroke(lowStroke);

		g.setColor(Color.blue);
		g.drawLine(x, y, x + nxy, y);
		g.drawLine(x + nxy, y, x + nxy, y + nxy);
		g.drawLine(x + nxy, y + nxy, x, y + nxy);
		g.drawLine(x, y + nxy, x, y);

		if (renderDetail) {
			g.drawString(node, center - (nxy / 12), center - (nxy / 6));

			// draw the node box points
			g.setColor(Color.black);
			int gd = (int)((gravityDistance * 2)+(dot/2));

			for (int i = 0; i < npoints.length; i++)
				for (int j = 0; j < npoints.length; j++) {
					g.setColor(transparentMagenta);
					g.fillOval(npoints[i] - (gd / 2), npoints[j] - (gd / 2), gd, gd);
					if ((i == bestNodeX) && (j == bestNodeY) && !beenDragged)
						g.setColor(Color.yellow);
					else
						g.setColor(Color.black);
					g.fillOval(npoints[i] - (dot / 2), npoints[j] - (dot / 2), dot, dot);
				}
		}

		// draw the label box
		g.setColor(transparentRed);
		g.fillRect(xOffset + xPos, yOffset + yPos, lx, ly);

		g.setColor(Color.red);
		g.drawLine(xOffset + xPos, yOffset + yPos, xOffset + xPos + lx, yOffset + yPos);
		g.drawLine(xOffset + xPos + lx, yOffset + yPos, xOffset + xPos + lx, yOffset + yPos + ly);
		g.drawLine(xOffset + xPos + lx, yOffset + yPos + ly, xOffset + xPos, yOffset + yPos + ly);
		g.drawLine(xOffset + xPos, yOffset + yPos + ly, xOffset + xPos, yOffset + yPos);

		// draw the string in the justified location
		if (renderDetail) {
			int vspace = (ly - ascent - ascent) / 3;

			if (justify == Label.JUSTIFY_LEFT) {
				g.drawString(label, xOffset + xPos + detailStrokeWidth,
				             yOffset + yPos + vspace + ascent);
				g.drawString(click, xOffset + xPos + detailStrokeWidth,
				             yOffset + yPos + (2 * (vspace + ascent)));
			} else if (justify == Label.JUSTIFY_RIGHT) {
				g.drawString(label, xOffset + xPos + (lx - labelLen),
				             yOffset + yPos + vspace + ascent);
				;
				g.drawString(click, xOffset + xPos + (lx - clickLen),
				             yOffset + yPos + (2 * (vspace + ascent)));
			} else { // center
				g.drawString(label, (xOffset + xPos + ((lx - labelLen) / 2)) - detailStrokeWidth,
				             yOffset + yPos + vspace + ascent);
				g.drawString(click, (xOffset + xPos + ((lx - clickLen) / 2)) - detailStrokeWidth,
				             yOffset + yPos + (2 * (vspace + ascent)));
			}
		} else {
			g.setColor(Color.gray);

			if (justify == Label.JUSTIFY_LEFT)
				g.drawLine(xOffset + xPos + lowStrokeWidth, yOffset + yPos + (ly / 2),
				           xOffset + xPos + (lx / 3), yOffset + yPos + (ly / 2));
			else if (justify == Label.JUSTIFY_RIGHT)
				g.drawLine(xOffset + xPos + ((2 * lx) / 3), yOffset + yPos + (ly / 2),
				           xOffset + xPos + lx, yOffset + yPos + (ly / 2));
			else
				g.drawLine(xOffset + xPos + (lx / 3), yOffset + yPos + (ly / 2),
				           (xOffset + xPos + ((2 * lx) / 3)) - lowStrokeWidth,
				           yOffset + yPos + (ly / 2));
		}

		if (renderDetail) {
			// draw the label box points
			g.setColor(Color.black);

			for (int i = 0; i < lxpoints.length; i++)
				for (int j = 0; j < lypoints.length; j++) {
					if ((i == bestLabelX) && (j == bestLabelY) && !beenDragged)
						g.setColor(Color.yellow);

					g.fillOval((xPos + xOffset + lxpoints[i]) - (dot / 2), 
					           (yPos + yOffset + lypoints[j]) - (dot / 2),
					           dot, dot);

					if ((i == bestLabelX) && (j == bestLabelY))
						g.setColor(Color.black);
				}
		}
	}

	private class MouseClickHandler extends MouseAdapter {
		/**
		* Only allows dragging if we're in the label box.
		* Also sets the offset from where the click is and where
		* the box is, so the box doesn't appear to jump around
		* too much.
		*/
		public void mousePressed(MouseEvent e) {
			int x = e.getX();
			int y = e.getY();

			// click+drag within box
			if ((x >= (xPos + xOffset)) && (x <= (xPos + xOffset + lx)) && 
			    (y >= (yPos + yOffset)) && (y <= (yPos + yOffset + ly))) {
				canOffsetDrag = true;
				xClickOffset = x - xPos;
				yClickOffset = y - yPos;
			}
		}

		/**
		 * Finds the closest points once the dragging is finished.
		 */
		public void mouseReleased(MouseEvent e) {
			if (beenDragged) {

				int x = e.getX();
				int y = e.getY();

				// top right
				xPos = x - xClickOffset + xOffset;
				yPos = y - yClickOffset + yOffset;

				double best = Double.POSITIVE_INFINITY;
				double offX = 0;
				double offY = 0;

				// loop over each point in the node box
				for (int i = 0; i < npoints.length; i++) {
					for (int j = 0; j < npoints.length; j++) {
						Point nodePoint = new Point(npoints[i] - (dot / 2), npoints[j] - (dot / 2));

						// loop over each point in the label box
						for (int a = 0; a < lxpoints.length; a++) {
							for (int b = 0; b < lypoints.length; b++) {
								Point labelPoint = new Point((xPos + lxpoints[a]) - (dot / 2),
								                             (yPos + lypoints[b]) - (dot / 2));

								double dist = labelPoint.distance((Point2D) nodePoint);
		
								if (dist < best) {
									best = dist;
									bestLabelX = a;
									bestLabelY = b;
									bestNodeX = i;
									bestNodeY = j;
									offX = labelPoint.getX() - nodePoint.getX();
									offY = labelPoint.getY() - nodePoint.getY();
								}
							}
						}
					}
				}

				xPos = npoints[bestNodeX] - lxpoints[bestLabelX];
				yPos = npoints[bestNodeY] - lypoints[bestLabelY];

				if ( Math.sqrt(offX*offX + offY*offY) > (gravityDistance+(dot/2)) ) {
					xOffset = (int)offX;
					yOffset = (int)offY;
				} else {
					xOffset = 0; 
					yOffset = 0; 
				}

				lp.setOffsetX(xOffset);
				lp.setOffsetY(yOffset);
				lp.setLabelAnchor(bestLabelX + (3 * bestLabelY));
				lp.setTargetAnchor(bestNodeX + (3 * bestNodeY));
				firePropertyChange(ObjectPlacerGraphic.OBJECT_POSITION_CHANGED, null, lp);

				repaint();
				beenDragged = false;
				canOffsetDrag = false;
			}
		}
	}

	private class MouseDragHandler extends MouseMotionAdapter {
		/**
		* Handles redrawing for dragging.
		*/
		public void mouseDragged(MouseEvent e) {
			// dragging within normal box
			if (canOffsetDrag) {
				xPos = e.getX() - xClickOffset; 
				yPos = e.getY() - yClickOffset;

				beenDragged = true;
				repaint();
			}
		}
	}

	/**
	 * Finds the points on the Label box and Node box that are closest.
	 */
	private void findClosestPoint() {

	}

	/**
	 * Applies the new LabelPosition to the graphic.
	 */
	private void applyPosition() {
		xOffset = (int) (lp.getOffsetX() * offsetRatio);
		yOffset = (int) (lp.getOffsetY() * offsetRatio);
		justify = lp.getJustify();

		int nodeAnchor = lp.getTargetAnchor();

		if (nodeAnchor != Label.NONE) {
			bestNodeX = nodeAnchor % 3;
			bestNodeY = (int) nodeAnchor / 3;
		}

		int labelAnchor = lp.getLabelAnchor();

		if (labelAnchor != Label.NONE) {
			bestLabelX = labelAnchor % 3;
			bestLabelY = (int) labelAnchor / 3;
		}

		if ((nodeAnchor != Label.NONE) || (labelAnchor != Label.NONE)) {
			xPos = npoints[bestNodeX] - lxpoints[bestLabelX];
			yPos = npoints[bestNodeY] - lypoints[bestLabelY];
		}
	}

	/**
	 * Handles all property changes that the panel listens for.
	 */
	public void propertyChange(PropertyChangeEvent e) {
		String type = e.getPropertyName();

		if (type.equals(ObjectPlacerGraphic.OBJECT_POSITION_CHANGED)) {
			lp = (LabelPosition) e.getNewValue();
			applyPosition();
			repaint();
		}
	}
}