org.cytoscape.group.events

Class GroupAboutToBeDestroyedEvent

java.lang.Object

org.cytoscape.event.AbstractCyEvent<CyGroupManager>

org.cytoscape.group.events.GroupAboutToBeDestroyedEvent

All Implemented Interfaces:

CyEvent<CyGroupManager>

public final class GroupAboutToBeDestroyedEvent
extends AbstractCyEvent<CyGroupManager>

This event signals that a group is about to be destroyed -- i.e. completely removed from all networks. The group's subnetwork and group node will also be destroyed.

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: 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>

Constructor Summary

Constructors

Constructor and Description
GroupAboutToBeDestroyedEvent(CyGroupManager source, CyGroup group) Constructs event.

Method Summary

Modifier and Type	Method and Description
CyGroup	getGroup()

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

GroupAboutToBeDestroyedEvent

public GroupAboutToBeDestroyedEvent(CyGroupManager source,
                                    CyGroup group)

Constructs event.

Parameters:

source - the CyGroupManager of the group about to be destroyed.

group - the CyGroup about to be destroyed.

Method Detail

getGroup

public final CyGroup getGroup()