Package org.cytoscape.task

Class AbstractNetworkViewLocationTaskFactory

java.lang.Object

org.cytoscape.task.AbstractNetworkViewLocationTaskFactory

All Implemented Interfaces:

NetworkViewLocationTaskFactory

public abstract class AbstractNetworkViewLocationTaskFactory
extends Object
implements NetworkViewLocationTaskFactory

A base class for task factories that need to add a functionality to the network view considering a given location (for example adding a node where a mouse was clicked).

Module: core-task-api

To use this in your app, include the following dependency in your POM:

<dependency>
    <groupId>org.cytoscape</groupId>
    <artifactId>core-task-api</artifactId>
</dependency>

Cytoscape Backwards Compatibility (Abstract Class): This class is abstract and meant to be extended by users. This means that we may add methods for minor version updates. Methods will only be removed for major version updates.

Constructor Summary

Constructors

Constructor	Description
AbstractNetworkViewLocationTaskFactory()

Method Summary

Modifier and Type	Method	Description
boolean	isReady(CyNetworkView networkView, Point2D javaPt, Point2D xformPt)	Returns true if the supplied view and coordinates are not null.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.cytoscape.task.NetworkViewLocationTaskFactory

createTaskIterator

Constructor Detail

AbstractNetworkViewLocationTaskFactory

public AbstractNetworkViewLocationTaskFactory()

Method Detail

isReady

public boolean isReady(CyNetworkView networkView,
                       Point2D javaPt,
                       Point2D xformPt)

Returns true if the supplied view and coordinates are not null.

Specified by:

isReady in interface NetworkViewLocationTaskFactory

Parameters:

networkView - The network view

javaPt - the point on the network view in java coordinates

xformPt - the point on the network view transformed into Cytoscape coordinates

Returns:

true if the supplied view and coordinates are not null.