org.graphstream.ui.swing_viewer.ViewPanel Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gs-ui-swing Show documentation
Swing interface for GraphStream
The newest version!
/*
 * This file is part of GraphStream .
 * 
 * GraphStream is a library whose purpose is to handle static or dynamic
 * graph, create them from scratch, file or any source and display them.
 * 
 * This program is free software distributed under the terms of two licenses, the
 * CeCILL-C license that fits European law, and the GNU Lesser General Public
 * License. You can  use, modify and/ or redistribute the software under the terms
 * of the CeCILL-C license as circulated by CEA, CNRS and INRIA at the following
 * URL  or under the terms of the GNU LGPL as published by
 * the Free Software Foundation, either version 3 of the License, or (at your
 * option) any later version.
 * 
 * This program 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 Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see .
 * 
 * The fact that you are presently reading this means that you have had
 * knowledge of the CeCILL-C and LGPL licenses and that you accept their terms.
 */

 /**
  * @author Antoine Dutot 
  * @author Guilhelm Savin 
  * @author Hicham Brahimi 
  */
  
package org.graphstream.ui.swing_viewer;

import org.graphstream.ui.view.View;

import javax.swing.JPanel;

/**
 * A view on a graphic graph.
 * 
 * Basically a view is a Swing panel where a
 * {@link org.graphstream.ui.view.GraphRenderer} renders the graphic graph. If
 * you are in the Swing thread, you can change the view on the graphic graph
 * using methods to translate, zoom and rotate the view.
 */
public abstract class ViewPanel extends JPanel implements View {
	private static final long serialVersionUID = 4372240131578395549L;

	/**
	 * The view identifier.
	 */
	private final String id;

	/**
	 * New view.
	 *
	 * @param identifier
	 *            The view unique identifier.
	 */
	public ViewPanel(final String identifier) {
		if (null == identifier || identifier.isEmpty()) {
			throw new IllegalArgumentException("View id cannot be null/empty.");
		}
		id = identifier;
	}

	public String getIdView() {
		return id;
	}

	/**
	 * Set the size of the view frame, if any. If this view has been open in a
	 * frame, this changes the size of the frame containing it.
	 *
	 * @param width
	 *            The new width.
	 * @param height
	 *            The new height.
	 */
	public abstract void resizeFrame(int width, int height);
	
	public abstract void enableMouseOptions();
}