| Package | Description | 
|---|---|
| org.cytoscape.application.swing | This package defines the various interfaces, abstract classes, and enums
 that represent the Cytoscape Swing Application API. | 
| org.cytoscape.io.write | This package provides factory interfaces to be used by anyone wishing to provide
 export or writing capabilities to the rest of Cytoscape. | 
| org.cytoscape.task | This package provides base classes for common task factory types as well as their associated task types found in Cytoscape. | 
| org.cytoscape.view.layout | This package provides access to the available layout algorithms, as well as provides abstract layout 
 classes and layout information containers for the convenience of implementing other layout algorithms. | 
| org.cytoscape.view.model | Module for View Models and Visual Properties. | 
| org.cytoscape.view.model.events | Definitions for View-Model related events and their listeners. | 
| org.cytoscape.view.presentation | API set for rendering engines (visualizers). | 
| org.cytoscape.view.presentation.customgraphics | This package provides an API for augmenting a  RenderingEngines
node rendering with custom graphics. | 
| org.cytoscape.view.presentation.property.values | Interfaces for VisualPropertyValues -- ArrowShape, LineType and NodeShape | 
| org.cytoscape.view.vizmap | Visual Mapping basic API module. | 
| org.cytoscape.view.vizmap.mappings | APIs for different mapping functions -- continuous mapping, discrete mapping and pass through mapping. | 
| Modifier and Type | Method and Description | 
|---|---|
| CyMenuItem | CyEdgeViewContextMenuFactory. createMenuItem(CyNetworkView netView,
              View<CyEdge> edgeView)This method should return a CyMenuItem to be added to the context
 menu of the specified edge view. | 
| CyMenuItem | CyNodeViewContextMenuFactory. createMenuItem(CyNetworkView netView,
              View<CyNode> nodeView)This method should return a CyMenuItem to be added to the context
 menu of the specified node view. | 
| Constructor and Description | 
|---|
| AbstractViewUpdater(VisualProperty<S> vp,
                   String columnName,
                   Map<CyRow,View<?>> rowViewMap)Constructor. | 
| Modifier and Type | Method and Description | 
|---|---|
| CyWriter | PresentationWriterManager. getWriter(View<?> view,
         RenderingEngine<?> re,
         CyFileFilter filter,
         File file)Returns the  CyWriterTask that will attempt to write the specified view to the
 specified file of the specified file type. | 
| CyWriter | PresentationWriterManager. getWriter(View<?> view,
         RenderingEngine<?> re,
         CyFileFilter filter,
         OutputStream os)Returns the  CyWriterTask that will attempt to write the specified view to the
 specified output stream of the specified file type. | 
| Modifier and Type | Field and Description | 
|---|---|
| protected View<CyEdge> | AbstractEdgeViewTask. edgeViewThe edge view that descendant tasks will operate on. | 
| protected View<CyNode> | AbstractNodeViewTask. nodeViewThe node view that descendants of this class will operate on. | 
| Modifier and Type | Method and Description | 
|---|---|
| TaskIterator | EdgeViewTaskFactory. createTaskIterator(View<CyEdge> edgeView,
                  CyNetworkView networkView)Creates a new TaskIterator using the given edge view and network view. | 
| TaskIterator | NodeViewTaskFactory. createTaskIterator(View<CyNode> nodeView,
                  CyNetworkView networkView)Provisions this factory with the node view and its associated network view, both of
 which will be passed into any task that will be created by this factory. | 
| boolean | EdgeViewTaskFactory. isReady(View<CyEdge> edgeView,
       CyNetworkView networkView)Returns true if this task factory is ready to produce a TaskIterator. | 
| boolean | AbstractEdgeViewTaskFactory. isReady(View<CyEdge> edgeView,
       CyNetworkView networkView)Returns true if the supplied edge and network views are not null. | 
| boolean | NodeViewTaskFactory. isReady(View<CyNode> nodeView,
       CyNetworkView networkView)Returns true if the node view and network view are in a state that is
 ready to be processed by the generated tasks and false otherwise. | 
| boolean | AbstractNodeViewTaskFactory. isReady(View<CyNode> nodeView,
       CyNetworkView networkView)Returns true of the supplied network and node views are not null. | 
| Constructor and Description | 
|---|
| AbstractEdgeViewTask(View<CyEdge> edgeView,
                    CyNetworkView netView)Base constructor for all tasks that need an edge view to operate on. | 
| AbstractNodeViewTask(View<CyNode> nodeView,
                    CyNetworkView netView)Base class constructor for all tasks that need to operate on a node view and possibly its associated network view. | 
| Modifier and Type | Field and Description | 
|---|---|
| static Set<View<CyNode>> | CyLayoutAlgorithm. ALL_NODE_VIEWSA convenience declaration for an empty set signifying that all node views
 should be laid out when creating the task iterator. | 
| protected Set<View<CyNode>> | AbstractLayoutTask. nodesToLayOutThe node views that will be laid out by the algorithm. | 
| Modifier and Type | Method and Description | 
|---|---|
| View<CyNode> | LayoutNode. getNodeView()Accessor function to return the View | 
| Modifier and Type | Method and Description | 
|---|---|
| protected void | LayoutPartition. addNode(CyNetwork network,
       View<CyNode> nv,
       boolean locked)Add a node to this partition. | 
| Modifier and Type | Method and Description | 
|---|---|
| TaskIterator | CyLayoutAlgorithm. createTaskIterator(CyNetworkView networkView,
                  Object layoutContext,
                  Set<View<CyNode>> nodesToLayOut,
                  String layoutAttribute)Creates a task iterator containing the layout tasks. | 
| boolean | CyLayoutAlgorithm. isReady(CyNetworkView networkView,
       Object layoutContext,
       Set<View<CyNode>> nodesToLayOut,
       String layoutAttribute)Returns true if the task factory is ready to produce a task iterator. | 
| boolean | AbstractLayoutAlgorithm. isReady(CyNetworkView view,
       Object tunableContext,
       Set<View<CyNode>> nodesToLayout,
       String attributeName) | 
| Constructor and Description | 
|---|
| LayoutNode(View<CyNode> nodeView,
          int index,
          CyRow row)The main constructor for a LayoutNode. | 
| Constructor and Description | 
|---|
| AbstractLayoutTask(String displayName,
                  CyNetworkView networkView,
                  Set<View<CyNode>> nodesToLayOut,
                  String layoutAttribute,
                  UndoSupport undo)Constructor. | 
| AbstractPartitionLayoutTask(String displayName,
                           boolean singlePartition,
                           CyNetworkView networkView,
                           Set<View<CyNode>> nodesToLayOut,
                           String layoutAttribute,
                           UndoSupport undo)Creates a new AbstractPartitionLayoutTask object. | 
| LayoutPartition(CyNetworkView networkView,
               Collection<View<CyNode>> nodeSet,
               EdgeWeighter edgeWeighter)LayoutPartition: use this constructor to create a LayoutPartition that
 includes the entire network. | 
| Modifier and Type | Interface and Description | 
|---|---|
| interface  | CyNetworkViewAdditional methods for CyNetworkView. | 
| interface  | NullCyNetworkViewA CyNetwork with no corresponding view. | 
| Modifier and Type | Method and Description | 
|---|---|
| View<CyEdge> | CyNetworkView. getEdgeView(CyEdge edge)Returns a View for a specified Edge. | 
| View<CyNode> | CyNetworkView. getNodeView(CyNode node)Returns a View for a specified Node. | 
| Modifier and Type | Method and Description | 
|---|---|
| Collection<View<? extends CyIdentifiable>> | CyNetworkView. getAllViews()Returns a list of all View including those for Nodes, Edges, and Network. | 
| Collection<View<CyEdge>> | CyNetworkView. getEdgeViews()Returns a list of Views for all CyEdges in the network. | 
| Collection<View<CyNode>> | CyNetworkView. getNodeViews()Returns a list of Views for all CyNodes in the network. | 
| Modifier and Type | Method and Description | 
|---|---|
| View<T> | ViewChangeRecord. getView()Returns the view that has been changed. | 
| Modifier and Type | Method and Description | 
|---|---|
| Collection<View<CyEdge>> | AddedEdgeViewsEvent. getEdgeViews()Returns new edge view added to the source network view object. | 
| Collection<View<CyNode>> | AddedNodeViewsEvent. getNodeViews()Returns new node view object. | 
| Constructor and Description | 
|---|
| ViewChangeRecord(View<T> view,
                VisualProperty<?> vp,
                Object value)Constructor. | 
| Constructor and Description | 
|---|
| AboutToRemoveEdgeViewsEvent(CyNetworkView source,
                           Collection<View<CyEdge>> payload)Creates the event for about to be removed edge views. | 
| AboutToRemoveNodeViewsEvent(CyNetworkView source,
                           Collection<View<CyNode>> payload)Creates the event for about to be removed node views. | 
| AddedEdgeViewsEvent(CyNetworkView source,
                   Collection<View<CyEdge>> edgeViews)Creates the event for new edge views. | 
| AddedNodeViewsEvent(CyNetworkView source,
                   Collection<View<CyNode>> nodeViews)Creates the event for a new node view. | 
| Modifier and Type | Method and Description | 
|---|---|
| View<T> | RenderingEngine. getViewModel()Returns View being rendered. | 
| Modifier and Type | Method and Description | 
|---|---|
| RenderingEngine<T> | RenderingEngineFactory. createRenderingEngine(Object visualizationContainer,
                     View<T> viewModel)A view model can have multiple presentations. | 
| Collection<RenderingEngine<?>> | RenderingEngineManager. getRenderingEngines(View<?> viewModel)Get rendering engines for the given view model. | 
| Modifier and Type | Method and Description | 
|---|---|
| List<T> | CyCustomGraphics. getLayers(CyNetworkView networkView,
         View<? extends CyIdentifiable> grView)Get layers that belong to this object. | 
| Modifier and Type | Method and Description | 
|---|---|
| Point2D | Handle. calculateHandleLocation(CyNetworkView netView,
                       View<CyEdge> edgeView)Calculate absolute position of this handle for the given edge view. | 
| Handle | HandleFactory. createHandle(CyNetworkView graphView,
            View<CyEdge> view,
            double x,
            double y)Creates a new instance of the Handle. | 
| void | Handle. defineHandle(CyNetworkView netView,
            View<CyEdge> edgeView,
            double x,
            double y)Define this handle. | 
| Modifier and Type | Method and Description | 
|---|---|
| void | VisualStyle. apply(CyRow row,
     View<? extends CyIdentifiable> view)Apply Visual Property values only to the given View Object (node or edge). | 
| void | VisualMappingFunction. apply(CyRow row,
     View<? extends CyIdentifiable> view)Apply mapping to the view model. | 
| Modifier and Type | Method and Description | 
|---|---|
| void | AbstractVisualMappingFunction. apply(CyRow row,
     View<? extends CyIdentifiable> view) | 
Copyright 2011 Cytoscape Consortium. All rights reserved.