org.graphstream.ui.view.ViewerPipe Maven / Gradle / Ivy
/*
* 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
* @author Guilhelm Savin
* @author Dave1704
* @author Hicham Brahimi
* @author Yoann Pigné
*/
package org.graphstream.ui.view;
import org.graphstream.stream.ProxyPipe;
import org.graphstream.stream.SourceBase;
import java.util.HashSet;
/**
* Shell around a proxy pipe coming from the viewer allowing to put viewer
* listeners on a viewer that runs in a distinct thread.
*
*
* This pipe is a probe that you can place in the event loop between the viewer
* and the graph. It will transmit all events coming from the viewer to the
* graph (or any sink you connect to it). But in addition it will monitor
* standard attribute changes to redistribute them to specify "viewer
* listeners".
*
*
*
* As any proxy pipe, a viewer pipe must be "pumped" to receive events coming
* from other threads.
*
*/
public class ViewerPipe extends SourceBase implements ProxyPipe {
// Attribute
private String id;
/**
* The incoming event stream.
*/
protected ProxyPipe pipeIn;
/**
* Listeners on the viewer specific events.
*/
protected HashSet viewerListeners = new HashSet();
// Construction
/**
* A shell around a pipe coming from a viewer in another thread.
*/
public ViewerPipe(String id, ProxyPipe pipeIn) {
this.id = id;
this.pipeIn = pipeIn;
pipeIn.addSink(this);
}
// Access
public String getId() {
return id;
}
// Commands
/*
* (non-Javadoc)
*
* @see org.graphstream.stream.ProxyPipe#pump()
*/
public void pump() {
pipeIn.pump();
}
/*
* (non-Javadoc)
*
* @see org.graphstream.stream.ProxyPipe#blockingPump()
*/
public void blockingPump() throws InterruptedException {
pipeIn.blockingPump();
}
/*
* (non-Javadoc)
*
* @see org.graphstream.stream.ProxyPipe#blockingPump(long)
*/
public void blockingPump(long timeout) throws InterruptedException {
pipeIn.blockingPump(timeout);
}
public void addViewerListener(ViewerListener listener) {
viewerListeners.add(listener);
}
public void removeViewerListener(ViewerListener listener) {
viewerListeners.remove(listener);
}
// Sink interface
/*
* (non-Javadoc)
*
* @see
* org.graphstream.stream.AttributeSink#edgeAttributeAdded(java.lang.String,
* long, java.lang.String, java.lang.String, java.lang.Object)
*/
public void edgeAttributeAdded(String sourceId, long timeId, String edgeId, String attribute, Object value) {
sendEdgeAttributeAdded(sourceId, timeId, edgeId, attribute, value);
}
/*
* (non-Javadoc)
*
* @see
* org.graphstream.stream.AttributeSink#edgeAttributeChanged(java.lang.String ,
* long, java.lang.String, java.lang.String, java.lang.Object, java.lang.Object)
*/
public void edgeAttributeChanged(String sourceId, long timeId, String edgeId, String attribute, Object oldValue,
Object newValue) {
sendEdgeAttributeChanged(sourceId, timeId, edgeId, attribute, oldValue, newValue);
}
/*
* (non-Javadoc)
*
* @see
* org.graphstream.stream.AttributeSink#edgeAttributeRemoved(java.lang.String ,
* long, java.lang.String, java.lang.String)
*/
public void edgeAttributeRemoved(String sourceId, long timeId, String edgeId, String attribute) {
sendEdgeAttributeRemoved(sourceId, timeId, edgeId, attribute);
}
/*
* (non-Javadoc)
*
* @see
* org.graphstream.stream.AttributeSink#graphAttributeAdded(java.lang.String ,
* long, java.lang.String, java.lang.Object)
*/
public void graphAttributeAdded(String sourceId, long timeId, String attribute, Object value) {
sendGraphAttributeAdded(sourceId, timeId, attribute, value);
if (attribute.equals("ui.viewClosed") && value instanceof String) {
for (ViewerListener listener : viewerListeners)
listener.viewClosed((String) value);
sendGraphAttributeRemoved(id, attribute);
} else if (attribute.equals("ui.clicked") && value instanceof String) {
for (ViewerListener listener : viewerListeners)
listener.buttonPushed((String) value);
sendGraphAttributeRemoved(id, attribute);
}
}
/*
* (non-Javadoc)
*
* @see org.graphstream.stream.AttributeSink#graphAttributeChanged(java.lang.
* String, long, java.lang.String, java.lang.Object, java.lang.Object)
*/
public void graphAttributeChanged(String sourceId, long timeId, String attribute, Object oldValue,
Object newValue) {
sendGraphAttributeChanged(sourceId, timeId, attribute, oldValue, newValue);
}
/*
* (non-Javadoc)
*
* @see org.graphstream.stream.AttributeSink#graphAttributeRemoved(java.lang.
* String, long, java.lang.String)
*/
public void graphAttributeRemoved(String sourceId, long timeId, String attribute) {
sendGraphAttributeRemoved(sourceId, timeId, attribute);
}
/*
* (non-Javadoc)
*
* @see
* org.graphstream.stream.AttributeSink#nodeAttributeAdded(java.lang.String,
* long, java.lang.String, java.lang.String, java.lang.Object)
*/
public void nodeAttributeAdded(String sourceId, long timeId, String nodeId, String attribute, Object value) {
sendNodeAttributeAdded(sourceId, timeId, nodeId, attribute, value);
if (attribute.equals("ui.clicked")) {
for (ViewerListener listener : viewerListeners)
listener.buttonPushed(nodeId);
}
if (attribute.equals("ui.mouseOver")) {
for (ViewerListener listener : viewerListeners)
listener.mouseOver(nodeId);
}
}
/*
* (non-Javadoc)
*
* @see
* org.graphstream.stream.AttributeSink#nodeAttributeChanged(java.lang.String ,
* long, java.lang.String, java.lang.String, java.lang.Object, java.lang.Object)
*/
public void nodeAttributeChanged(String sourceId, long timeId, String nodeId, String attribute, Object oldValue,
Object newValue) {
sendNodeAttributeChanged(sourceId, timeId, nodeId, attribute, oldValue, newValue);
}
/*
* (non-Javadoc)
*
* @see
* org.graphstream.stream.AttributeSink#nodeAttributeRemoved(java.lang.String ,
* long, java.lang.String, java.lang.String)
*/
public void nodeAttributeRemoved(String sourceId, long timeId, String nodeId, String attribute) {
sendNodeAttributeRemoved(sourceId, timeId, nodeId, attribute);
if (attribute.equals("ui.clicked")) {
for (ViewerListener listener : viewerListeners)
listener.buttonReleased(nodeId);
}
if (attribute.equals("ui.mouseOver")) {
for (ViewerListener listener : viewerListeners)
listener.mouseLeft(nodeId);
}
}
/*
* (non-Javadoc)
*
* @see org.graphstream.stream.ElementSink#edgeAdded(java.lang.String, long,
* java.lang.String, java.lang.String, java.lang.String, boolean)
*/
public void edgeAdded(String sourceId, long timeId, String edgeId, String fromNodeId, String toNodeId,
boolean directed) {
sendEdgeAdded(sourceId, timeId, edgeId, fromNodeId, toNodeId, directed);
}
/*
* (non-Javadoc)
*
* @see org.graphstream.stream.ElementSink#edgeRemoved(java.lang.String, long,
* java.lang.String)
*/
public void edgeRemoved(String sourceId, long timeId, String edgeId) {
sendEdgeRemoved(sourceId, timeId, edgeId);
}
/*
* (non-Javadoc)
*
* @see org.graphstream.stream.ElementSink#graphCleared(java.lang.String, long)
*/
public void graphCleared(String sourceId, long timeId) {
sendGraphCleared(sourceId, timeId);
}
/*
* (non-Javadoc)
*
* @see org.graphstream.stream.ElementSink#nodeAdded(java.lang.String, long,
* java.lang.String)
*/
public void nodeAdded(String sourceId, long timeId, String nodeId) {
sendNodeAdded(sourceId, timeId, nodeId);
}
/*
* (non-Javadoc)
*
* @see org.graphstream.stream.ElementSink#nodeRemoved(java.lang.String, long,
* java.lang.String)
*/
public void nodeRemoved(String sourceId, long timeId, String nodeId) {
sendNodeRemoved(sourceId, timeId, nodeId);
}
/*
* (non-Javadoc)
*
* @see org.graphstream.stream.ElementSink#stepBegins(java.lang.String, long,
* double)
*/
public void stepBegins(String sourceId, long timeId, double step) {
sendStepBegins(sourceId, timeId, step);
}
}