Package org.cytoscape.group.events

Class GroupAddedToNetworkEvent

java.lang.Object

org.cytoscape.event.AbstractCyEvent<CyGroup>

org.cytoscape.group.events.GroupAddedToNetworkEvent

All Implemented Interfaces:

CyEvent<CyGroup>

public final class GroupAddedToNetworkEvent
extends AbstractCyEvent<CyGroup>

This event signals that an existing group has been added to a new network. This is meant to be used primarily by the view and presentation layers to allow them to appropriately visualize the group.

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
GroupAddedToNetworkEvent(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

GroupAddedToNetworkEvent

public GroupAddedToNetworkEvent(CyGroup source,
                                CyNetwork network)

Constructs event.

Parameters:

source - the CyGroup that has been added.

network - the CyNetwork the group has been added to.

Method Detail

getNetwork

public final CyNetwork getNetwork()