Package org.cytoscape.group.events

Class GroupAboutToBeRemovedEvent

java.lang.Object

org.cytoscape.event.AbstractCyEvent<CyGroup>

org.cytoscape.group.events.GroupAboutToBeRemovedEvent

All Implemented Interfaces:

CyEvent<CyGroup>

public final class GroupAboutToBeRemovedEvent
extends AbstractCyEvent<CyGroup>

This event signals that a group is about to be removed from a network, but not completely deleted. This event is meant to be used primarily by the the view and presentation layers for managing the visualization of the network.

Module: group-api

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

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

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.

Constructor Summary

Constructors

Constructor	Description
GroupAboutToBeRemovedEvent(CyGroup source, CyNetwork network)	Constructs event.

Method Summary

Modifier and Type	Method	Description
CyNetwork	getNetwork()

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

Constructor Detail

GroupAboutToBeRemovedEvent

public GroupAboutToBeRemovedEvent(CyGroup source,
                                  CyNetwork network)

Constructs event.

Parameters:

source - the CyGroup that is about to be removed.

network - the CyNetwork the group is about to be removed from

Method Detail

getNetwork

public final CyNetwork getNetwork()