org.cytoscape.view.model.events

Class AboutToRemoveNodeViewsEvent

java.lang.Object

org.cytoscape.event.AbstractCyEvent<T>

org.cytoscape.event.AbstractCyPayloadEvent<CyNetworkView,View<CyNode>>

org.cytoscape.view.model.events.AboutToRemoveNodeViewsEvent

All Implemented Interfaces:

CyEvent<CyNetworkView>, CyPayloadEvent<CyNetworkView,View<CyNode>>

public final class AboutToRemoveNodeViewsEvent
extends AbstractCyPayloadEvent<CyNetworkView,View<CyNode>>

When node Views are about to be removed from a CyNetworkView, this event will be fired.

Cytoscape Backwards Compatibility (Final Class): This class is final and therefore can't be extended by users. This means that we may add methods for minor version updates. Methods will only be removed for major version updates.

Module: viewmodel-api

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

<dependency>
    <groupId>org.cytoscape</groupId>
    <artifactId>viewmodel-api</artifactId>
</dependency>

Constructor Summary

Constructors

Constructor and Description
AboutToRemoveNodeViewsEvent(CyNetworkView source, Collection<View<CyNode>> payload) Creates the event for about to be removed node views.

Method Summary

Methods inherited from class org.cytoscape.event.AbstractCyPayloadEvent

getPayloadCollection

Methods inherited from class org.cytoscape.event.AbstractCyEvent

getListenerClass, getSource

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.cytoscape.event.CyEvent

getListenerClass, getSource

Constructor Detail

AboutToRemoveNodeViewsEvent

public AboutToRemoveNodeViewsEvent(CyNetworkView source,
                           Collection<View<CyNode>> payload)

Creates the event for about to be removed node views.

Parameters:

source - network view which includes the node views about to be removed.

payload - Collection of node view objects about to be removed.