jadex.tools.comanalyzer.diagram.DiagramCanvas Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jadex-tools-comanalyzer Show documentation
The Jadex tools comanalyzer package contains the ComAnalyzer JCC plugin for observing the communication between Jadex components.
The newest version!
package jadex.tools.comanalyzer.diagram;

import jadex.commons.collection.SortedList;
import jadex.tools.comanalyzer.Component;
import jadex.tools.comanalyzer.ComponentFilterMenu;
import jadex.tools.comanalyzer.Message;
import jadex.tools.comanalyzer.MessageFilterMenu;
import jadex.tools.comanalyzer.ToolCanvas;
import jadex.tools.comanalyzer.ToolTab;

import java.awt.BorderLayout;
import java.awt.Cursor;
import java.awt.Point;
import java.awt.Rectangle;
import java.awt.event.MouseAdapter;
import java.awt.event.MouseEvent;
import java.awt.event.MouseMotionAdapter;
import java.util.SortedMap;
import java.util.TreeMap;

import javax.swing.JScrollPane;

import edu.uci.ics.jung.graph.util.Pair;


/**
 * The container for the diagram.
 */
public class DiagramCanvas extends ToolCanvas
{

	// -------- attributes --------

	/** The panel for components */
	protected ComponentCanvas header;

	/** The panel for messages */
	protected MessageCanvas detail;

	/** Internal componentlist for display */
	protected SortedList visible_components;

	/** Internal messagelist for display */
	protected SortedMap visible_messages;

	/** The autoscroll for the diagramm */
	protected boolean autoScroll = true;

	// -------- constructors --------

	/**
	 * Constructor for the container
	 * 
	 * @param tooltab The tooltab.
	 */
	public DiagramCanvas(final ToolTab tooltab)
	{
		super(tooltab);

		visible_components = new SortedList();
		visible_messages = new TreeMap();

		// init component and messages panel
		header = new ComponentCanvas(this);
		detail = new MessageCanvas(this);

		JScrollPane scroll = new JScrollPane();
		scroll.setViewportView(detail);
		scroll.setColumnHeaderView(header);

		this.setLayout(new BorderLayout());
		this.add(BorderLayout.CENTER, scroll);

		// change cursor when over an component
		header.addMouseMotionListener(new MouseMotionAdapter()
		{
			public void mouseMoved(MouseEvent e)
			{
				Component selectedComponent = header.getComponent(e.getX(), e.getY());
				if((selectedComponent != null))
				{
					setCursor(Cursor.getPredefinedCursor(Cursor.HAND_CURSOR));
				}
				else
				{
					setCursor(Cursor.getPredefinedCursor(Cursor.DEFAULT_CURSOR));
				}
			}
		});

		// show poup on trigger or display element on doubleclick
		header.addMouseListener(new MouseAdapter()
		{
			public void mouseClicked(MouseEvent e)
			{
				if(e.getButton() == MouseEvent.BUTTON3)
				{
					Component selectedComponent = header.getComponent(e.getX(), e.getY());
					if((selectedComponent != null))
					{
						ComponentFilterMenu mpopup = new ComponentFilterMenu(tooltab.getPlugin(), selectedComponent);
						mpopup.show(e.getComponent(), e.getX(), e.getY());
					}

				}
				if(e.getButton() == MouseEvent.BUTTON1 && e.getClickCount() == 2)
				{
					Component selectedComponent = header.getComponent(e.getX(), e.getY());
					if((selectedComponent != null))
					{
						tooltab.getToolPanel().showElementDetails(selectedComponent.getParameters());
					}
				}
			}

		});

		// change cursor when over a message
		detail.addMouseMotionListener(new MouseMotionAdapter()
		{
			public void mouseMoved(MouseEvent e)
			{
				Message selectedMessage = detail.getMessage(e.getX(), e.getY());
				if(selectedMessage != null)
				{
					setCursor(Cursor.getPredefinedCursor(Cursor.HAND_CURSOR));
				}
				else
				{
					setCursor(Cursor.getPredefinedCursor(Cursor.DEFAULT_CURSOR));
				}
			}
		});

		// show poup on trigger or display element on doubleclick
		detail.addMouseListener(new MouseAdapter()
		{

			public void mouseClicked(MouseEvent e)
			{
				if(e.getButton() == MouseEvent.BUTTON3)
				{
					Message mess = detail.getMessage(e.getX(), e.getY());
					if(mess != null)
					{
						MessageFilterMenu mpopup = new MessageFilterMenu(tooltab.getPlugin(), mess);
						mpopup.show(e.getComponent(), e.getX(), e.getY());
					}

				}
				if(e.getButton() == MouseEvent.BUTTON1 && e.getClickCount() == 2)
				{
					Message mess = detail.getMessage(e.getX(), e.getY());
					if((mess != null))
					{
						tooltab.getToolPanel().showElementDetails(mess.getParameters());
					}
				}
			}
		});

	}

	// -------- ToolCanvas methods --------

	/**
	 * Update a message by adding it, if the message can be displayed or
	 * removing it if present.
	 * 
	 * @param message The message to add.
	 * @param isPresent true if removal is skipped. (Can be
	 * applied to new messages)
	 */
	public void updateMessage(Message message, boolean isPresent)
	{

		Pair newPair = message.getEndpoints();

		if(newPair != null)
		{
			Component sender = (Component)newPair.getFirst();
			Component receiver = (Component)newPair.getSecond();
			// check if message is already displayed
			if(visible_messages.containsKey(message))
			{
				// check if the message should be redirected
				Pair oldPair = (Pair)visible_messages.get(message);
				if(oldPair.getFirst().equals(sender) && oldPair.getSecond().equals(receiver))
				{
					return; // already displayed
				}
				else
				{
					// remove message, since the message is redirected
					removeMessage(message);
				}
			}
			// now add the message with sender and receiver
			// given by displayMessage
			addMessage(message, sender, receiver);
		}
		else if(isPresent)
		{
			removeMessage(message);
		}
		return;

	}

	/**
	 * Removes a message.
	 * 
	 * @param message The message to remove.
	 */
	public void removeMessage(Message message)
	{
		visible_messages.remove(message);
	}

	/**
	 * Updates an component by adding it, if the component can be displayed or removing
	 * it if present.
	 * 
	 * @param component The component to add.
	 * @param isPresent true if removal is skipped. (Can be
	 * applied to new components)
	 */
	public void updateComponent(Component component, boolean update)
	{
		if(component.isVisible())
		{
			if(!visible_components.contains(component))
			{
				addComponent(component);
			}
		}
		else if(update)
		{
			removeComponent(component);
		}
		return;
	}

	/**
	 * Removes an component.
	 * 
	 * @param component The component to remove.
	 */
	public void removeComponent(Component component)
	{
		visible_components.remove(component);
	}

	/**
	 * This method repaint both canvas checking the size of the scrollbars. The
	 * right procedure to follow is to call method setPreferredSize() the
	 * revalidate() method.
	 */
	public void repaintCanvas()
	{
		header.setPreferredSize();
		detail.setPreferredSize();

		if(autoScroll)
		{
			Point p = new Point(0, detail.getSize().height);
			detail.scrollRectToVisible(new Rectangle(p));
		}

		// detail.setSize(new Dimension(horDim,vertDim));
		revalidate();
		repaint();

	}

	/**
	 * Clear the diagramm by removing all messages and components.
	 */
	public void clear()
	{
		visible_components.clear();
		visible_messages.clear();
	}

	// -------- DiagramCanvas methods --------

	/**
	 * @return Returns true if autoscroll is on
	 */
	public boolean isAutoScroll()
	{
		return autoScroll;
	}

	/**
	 * @param autoScroll The autoScroll to set.
	 */
	public void setAutoScroll(boolean autoScroll)
	{
		this.autoScroll = autoScroll;
	}

	/**
	 * Adds the component.
	 * @param component The component to add.
	 */
	public void addComponent(Component component)
	{
		visible_components.add(component);
	}

	/**
	 * Add message with given sender and receiver (for redirection)
	 * 
	 * @param message The message to add.
	 * @param sender The sender in the presentation.
	 * @param receiver The receiver in the presentation. (e.g. dummy)
	 */
	public void addMessage(Message message, Component sender, Component receiver)
	{
		visible_messages.put(message, new Pair(sender, receiver));
	}

}