Package org.cytoscape.group.events

Class GroupCollapsedEvent

java.lang.Object

org.cytoscape.event.AbstractCyEvent<CyGroup>

org.cytoscape.group.events.GroupCollapsedEvent

All Implemented Interfaces:

CyEvent<CyGroup>

public final class GroupCollapsedEvent
extends AbstractCyEvent<CyGroup>

This event signals that a group has either been 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
GroupCollapsedEvent(CyGroup source, CyNetwork network, boolean collapsed)	Constructs event.

Method Summary

Modifier and Type	Method	Description
boolean	collapsed()	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

GroupCollapsedEvent

public GroupCollapsedEvent(CyGroup source,
                           CyNetwork network,
                           boolean collapsed)

Constructs event.

Parameters:

source - the CyGroup that has been changed.

network - the CyNetwork the group has been changed in.

collapsed - true if the group has collapsed

Method Detail

collapsed

public boolean collapsed()

Is the group collapsed or expanded?

Returns:

true if the group was collapsed

getNetwork

public final CyNetwork getNetwork()