Package org.cytoscape.group.events

Class GroupAboutToCollapseEvent

java.lang.Object

org.cytoscape.event.AbstractCyEvent<CyGroup>

org.cytoscape.group.events.GroupAboutToCollapseEvent

All Implemented Interfaces:

CyEvent<CyGroup>

public final class GroupAboutToCollapseEvent
extends AbstractCyEvent<CyGroup>

This event signals that a group is either about to be expanded or collapsed in a particular 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
GroupAboutToCollapseEvent(CyGroup source, CyNetwork network, boolean collapsing)	Constructs event.

Method Summary

Modifier and Type	Method	Description
boolean	collapsing()	Is the group collapsed or expanded?
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

GroupAboutToCollapseEvent

public GroupAboutToCollapseEvent(CyGroup source,
                                 CyNetwork network,
                                 boolean collapsing)

Constructs event.

Parameters:

source - the CyGroup that has been changed.

network - the CyNetwork the group has been changed in.

collapsing - true if the group is about to be collapsed

Method Detail

collapsing

public boolean collapsing()

Is the group collapsed or expanded?

Returns:

true if the group is about to be collapsed

getNetwork

public final CyNetwork getNetwork()