Cytoscape 2.8.0 API

cytoscape
Class CyNetworkEvent

java.lang.Object
  extended by cytoscape.CyNetworkEvent

public class CyNetworkEvent
extends Object

Events of this class are fired from a CyNetwork object when something happens to the network. The event holds a reference to the network that is the source of the event, and an int flag identifying the type of event.


Field Summary
static int BEGIN
          Indicates that someone is beginning to work with the network.
static int END
          Indicates that someone is done working with the network.
static int GRAPH_REPLACED
          Indicates that a new graph has been installed in the network.
static int UNKNOWN
          This type is used when the requested type is unknown to this class.
 
Constructor Summary
CyNetworkEvent(CyNetwork source, int type)
          Creates a new CyNetworkEvent object.
 
Method Summary
 CyNetwork getNetwork()
          DOCUMENT ME!
 int getType()
          DOCUMENT ME!
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

UNKNOWN

public static final int UNKNOWN
This type is used when the requested type is unknown to this class.

See Also:
Constant Field Values

BEGIN

public static final int BEGIN
Indicates that someone is beginning to work with the network.

See Also:
Constant Field Values

END

public static final int END
Indicates that someone is done working with the network.

See Also:
Constant Field Values

GRAPH_REPLACED

public static final int GRAPH_REPLACED
Indicates that a new graph has been installed in the network.

See Also:
Constant Field Values
Constructor Detail

CyNetworkEvent

public CyNetworkEvent(CyNetwork source,
                      int type)
Creates a new CyNetworkEvent object.

Parameters:
source - DOCUMENT ME!
type - DOCUMENT ME!
Method Detail

getNetwork

public CyNetwork getNetwork()
DOCUMENT ME!

Returns:
DOCUMENT ME!

getType

public int getType()
DOCUMENT ME!

Returns:
DOCUMENT ME!

Cytoscape 2.8.0 API

Copyright 2010 Cytoscape Consortium. All rights reserved.