Cytoscape 3.0.0-alpha8-SNAPSHOT API

org.cytoscape.view.layout
Class AbstractEdgeWeightedLayoutAlgorithmContext

java.lang.Object
  extended by org.cytoscape.view.layout.AbstractLayoutAlgorithmContext
      extended by org.cytoscape.view.layout.AbstractEdgeWeightedLayoutAlgorithmContext
All Implemented Interfaces:
CyLayoutContext

public abstract class AbstractEdgeWeightedLayoutAlgorithmContext
extends AbstractLayoutAlgorithmContext

The AbstractEdgeWeightedLayoutAlgorithm provides edge weighting Tunables that can be used by an implementing layout algorithm.


Cytoscape Backwards Compatibility (Abstract Class): This class is abstract and meant to be extended by users. This means that we may add methods for minor version updates. Methods will only be removed for major version updates.

Field Summary
 ListSingleSelection<String> edgeWeightColumn
          A tunable for determining the edge attribute that contains the weights.
 double maxWeight
          A tunable for determining the maximum edge weight to consider.
 double minWeight
          A tunable for determining the minimum edge weight to consider.
 ListSingleSelection<org.cytoscape.view.layout.WeightTypes> weightChoices
          A tunable for determining how to interpret weight values.
 
Fields inherited from class org.cytoscape.view.layout.AbstractLayoutAlgorithmContext
network, selectedOnly, staticNodes
 
Constructor Summary
AbstractEdgeWeightedLayoutAlgorithmContext(boolean supportsSelectedOnly, Set<Class<?>> supportedNodeAttributes, Set<Class<?>> supportedEdgeAttributes)
          The Constructor.
 
Method Summary
 void setNetworkView(CyNetworkView view)
          Sets the network view to be laid out.
 
Methods inherited from class org.cytoscape.view.layout.AbstractLayoutAlgorithmContext
configureLayoutFromSubmenuSelection, getNetworkView, getStaticNodes, getSubmenuOptions, initStaticNodes, setLayoutAttribute, setSelectedOnly, setSubmenuOptions, useSelectedOnly
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

edgeWeightColumn

public ListSingleSelection<String> edgeWeightColumn
A tunable for determining the edge attribute that contains the weights.


weightChoices

public ListSingleSelection<org.cytoscape.view.layout.WeightTypes> weightChoices
A tunable for determining how to interpret weight values.


minWeight

public double minWeight
A tunable for determining the minimum edge weight to consider.


maxWeight

public double maxWeight
A tunable for determining the maximum edge weight to consider.

Constructor Detail

AbstractEdgeWeightedLayoutAlgorithmContext

public AbstractEdgeWeightedLayoutAlgorithmContext(boolean supportsSelectedOnly,
                                                  Set<Class<?>> supportedNodeAttributes,
                                                  Set<Class<?>> supportedEdgeAttributes)
The Constructor.

Parameters:
undo - the UndoSupport object used for allowing undo of layouts.
computerName - a computer readable name used to construct property strings.
humanName - a user visible name of the layout.
supportsSelectedOnly - indicates whether only selected nodes should be laid out.
supportedNodeAttributes -
supportedNodeAttributes -
supportedEdgeAttributes -
supportedEdgeAttributes -
Method Detail

setNetworkView

public void setNetworkView(CyNetworkView view)
Sets the network view to be laid out.

Specified by:
setNetworkView in interface CyLayoutContext
Overrides:
setNetworkView in class AbstractLayoutAlgorithmContext
Parameters:
view - the network view to be laid out.

Cytoscape 3.0.0-alpha8-SNAPSHOT API

Copyright 2011 Cytoscape Consortium. All rights reserved.