Cytoscape 2.8.0 API

Uses of Interface
cytoscape.groups.CyGroup

Packages that use CyGroup
cytoscape Core Cytoscape Classes. 
cytoscape.groups   
 

Uses of CyGroup in cytoscape
 

Methods in cytoscape that return types with arguments of type CyGroup
 List<CyGroup> CyNode.getGroups()
          Return the list of groups this node is a member of
 

Methods in cytoscape with parameters of type CyGroup
 void CyNode.addToGroup(CyGroup group)
          Add this node to the specified group.
 boolean CyNode.inGroup(CyGroup group)
          Check to see if this node is a member of the requested group
 void CyNode.removeFromGroup(CyGroup group)
          Remove this node from the specified group.
 

Uses of CyGroup in cytoscape.groups
 

Classes in cytoscape.groups that implement CyGroup
 class CyGroupImpl
          The CyGroup class provides the implementation for a group model that maintains the list of nodes belonging to a group, the parent of a particular group, and the node that represents the group.
 

Methods in cytoscape.groups that return CyGroup
static CyGroup CyGroupManager.copyGroup(CyGroup group, CyNetwork network)
          Create a copy of a group, potentially in a new network, and name the copy automatically.
static CyGroup CyGroupManager.copyGroup(String newName, CyGroup group, CyNetwork network)
          Create a copy of a group, potentially in a new network, and name the copy with the provided new name.
static CyGroup CyGroupManager.createGroup(CyNode groupNode, List<CyNode> nodeList, String viewer)
          Create a new group with a list of nodes as initial members, and a precreated group node.
static CyGroup CyGroupManager.createGroup(CyNode groupNode, List<CyNode> nodeList, String viewer, CyNetwork network)
          Create a new group with a list of nodes as initial members, and a precreated group node.
static CyGroup CyGroupManager.createGroup(String groupName, List<CyNode> nodeList, List<CyEdge> innerEdgeList, List<CyEdge> outerEdgeList, String viewer, CyNetwork network)
          Create a new group by specifying all components.
static CyGroup CyGroupManager.createGroup(String groupName, List<CyNode> nodeList, String viewer)
          Create a new, empty group.
static CyGroup CyGroupManager.createGroup(String groupName, List<CyNode> nodeList, String viewer, CyNetwork network)
          Create a new group with a list of nodes as initial members.
static CyGroup CyGroupManager.createGroup(String groupName, String viewer)
          Create a new, empty group.
static CyGroup CyGroupManager.createGroup(String groupName, String viewer, CyNetwork network)
          Create a new, empty group.
static CyGroup CyGroupManager.findGroup(String groupName)
          Search all groups for the group named 'groupName'
static CyGroup CyGroupManager.getCyGroup(CyNode groupNode)
          getCyGroup is a static method that returns a CyGroup structure when given the CyNode that represents this group.
 

Methods in cytoscape.groups that return types with arguments of type CyGroup
static List<CyGroup> CyGroupManager.getGroup(CyNode memberNode)
          getGroup is a static method that returns a CyGroup structure when given a CyNode that is a member of a group.
static List<CyGroup> CyGroupManager.getGroupList()
          Return the list of all groups
static List<CyGroup> CyGroupManager.getGroupList(CyGroupViewer viewer)
          Return the list of all groups managed by a particular viewer
static List<CyGroup> CyGroupManager.getGroupList(CyNetwork network)
          Return the list of all groups for this network
 

Methods in cytoscape.groups with parameters of type CyGroup
static CyGroup CyGroupManager.copyGroup(CyGroup group, CyNetwork network)
          Create a copy of a group, potentially in a new network, and name the copy automatically.
static CyGroup CyGroupManager.copyGroup(String newName, CyGroup group, CyNetwork network)
          Create a copy of a group, potentially in a new network, and name the copy with the provided new name.
 void CyGroupChangeListener.groupChanged(CyGroup group, CyGroupChangeListener.ChangeType change)
          This method will be called by the CyGroupManager when a group is created, deleted, or modified.
 void CyGroupViewer.groupChanged(CyGroup group, GraphObject changedObject, CyGroupViewer.ChangeType change)
          Provide viewer-specific hooks to the change of a group.
 void CyGroupViewer.groupCreated(CyGroup group)
          Provide viewer-specific initialization after the creation of a group.
 void CyGroupViewer.groupCreated(CyGroup group, CyNetworkView myView)
           
 void CyGroupViewer.groupWillBeRemoved(CyGroup group)
          Provide viewer-specific hooks to deletion of a group.
static void CyGroupManager.notifyCreateGroup(CyGroup group)
          Notify a viewer that a group has been created for them to manage.
static void CyGroupManager.notifyRemoveGroup(CyGroup group)
          Notify a viewer the a group of interest is going to be removed.
static void CyGroupManager.removeGroup(CyGroup group)
          Remove (delete) a group
static void CyGroupManager.setGroupViewer(CyGroup group, String viewer, CyNetworkView myView, boolean notify)
          Set the viewer for a group
 


Cytoscape 2.8.0 API

Copyright 2010 Cytoscape Consortium. All rights reserved.