Cytoscape 2.8.0 API

cytoscape.visual
Class NodeAppearanceCalculator

java.lang.Object
  extended by cytoscape.visual.NodeAppearanceCalculator
All Implemented Interfaces:
Cloneable

public class NodeAppearanceCalculator
extends Object

This class calculates the appearance of a Node. It holds a default value and a (possibly null) calculator for each visual attribute.


Field Summary
protected  List<Calculator> calcs
           
protected static String CLONE_SUFFIX
           
protected  VisualPropertyDependency deps
           
protected  Appearance tmpDefaultAppearance
           
 
Constructor Summary
NodeAppearanceCalculator()
          Deprecated. Use VisualStyle.getNodeAppearanceCalculator() or new NodeAppearancCalculator( VisualStyle.getDependency() ) instead. Will be removed January 2011.
NodeAppearanceCalculator(NodeAppearanceCalculator toCopy)
          Copy constructor.
NodeAppearanceCalculator(String name, Properties nacProps, String baseKey, CalculatorCatalog catalog, VisualPropertyDependency deps)
          Creates a new NodeAppearanceCalculator and immediately customizes it by calling applyProperties with the supplied arguments.
NodeAppearanceCalculator(VisualPropertyDependency deps)
          Creates a new NodeAppearanceCalculator object.
 
Method Summary
protected  void applyProperties(Appearance appr, String name, Properties nacProps, String baseKey, CalculatorCatalog catalog)
           
 void applyProperties(String name, Properties nacProps, String baseKey, CalculatorCatalog catalog)
          DOCUMENT ME!
 void calculateNodeAppearance(NodeAppearance appr, Node node, CyNetwork network)
          Using the rules defined by the default values and calculators in this object, compute an appearance for the requested Node in the supplied CyNetwork.
 NodeAppearance calculateNodeAppearance(Node node, CyNetwork network)
          Using the rules defined by the default values and calculators in this object, compute an appearance for the requested Node in the supplied CyNetwork.
 Object clone()
          Create deep copy of the object.
 Object clone(String vsName)
          Make deep copy of this object
protected  void copyCalculators(cytoscape.visual.AppearanceCalculator copy)
           
protected  void copyDefaultAppearance(cytoscape.visual.AppearanceCalculator toCopy)
           
 Calculator getCalculator(VisualPropertyType type)
          DOCUMENT ME!
 List<Calculator> getCalculators()
          DOCUMENT ME!
 NodeAppearance getDefaultAppearance()
          DOCUMENT ME!
 String getDescription()
          Returns a text description of the current default values and calculator names.
protected  String getDescription(String name, Appearance defaultAppr)
           
 boolean getNodeSizeLocked()
          Deprecated. Use VisualStyle.getDependency().check(VisualPropertyDependency.Definition.NODE_SIZE_LOCKED) instead. Will be removed Jan 2011.
protected  Properties getProperties(Appearance appr, String baseKey)
           
 Properties getProperties(String baseKey)
          DOCUMENT ME!
 void removeCalculator(VisualPropertyType type)
          DOCUMENT ME!
 void setCalculator(Calculator c)
          DOCUMENT ME!
 void setDefaultAppearance(NodeAppearance n)
          DOCUMENT ME!
 void setNodeSizeLocked(boolean b)
          Deprecated. Use VisualStyle.getDependency().set(VisualPropertyDependency.Definition.NODE_SIZE_LOCKED,b) instead. Will be removed Jan 2011.
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CLONE_SUFFIX

protected static final String CLONE_SUFFIX
See Also:
Constant Field Values

calcs

protected final List<Calculator> calcs

tmpDefaultAppearance

protected Appearance tmpDefaultAppearance

deps

protected VisualPropertyDependency deps
Constructor Detail

NodeAppearanceCalculator

@Deprecated
public NodeAppearanceCalculator()
Deprecated. Use VisualStyle.getNodeAppearanceCalculator() or new NodeAppearancCalculator( VisualStyle.getDependency() ) instead. Will be removed January 2011.


NodeAppearanceCalculator

public NodeAppearanceCalculator(VisualPropertyDependency deps)
Creates a new NodeAppearanceCalculator object.


NodeAppearanceCalculator

public NodeAppearanceCalculator(String name,
                                Properties nacProps,
                                String baseKey,
                                CalculatorCatalog catalog,
                                VisualPropertyDependency deps)
Creates a new NodeAppearanceCalculator and immediately customizes it by calling applyProperties with the supplied arguments.


NodeAppearanceCalculator

public NodeAppearanceCalculator(NodeAppearanceCalculator toCopy)
Copy constructor. Returns a default object if the argument is null.

Method Detail

calculateNodeAppearance

public NodeAppearance calculateNodeAppearance(Node node,
                                              CyNetwork network)
Using the rules defined by the default values and calculators in this object, compute an appearance for the requested Node in the supplied CyNetwork. A new NodeApperance object will be created.


clone

public Object clone()
Create deep copy of the object.


calculateNodeAppearance

public void calculateNodeAppearance(NodeAppearance appr,
                                    Node node,
                                    CyNetwork network)
Using the rules defined by the default values and calculators in this object, compute an appearance for the requested Node in the supplied CyNetwork. The supplied NodeAppearance object will be changed to hold the new values.


getDefaultAppearance

public NodeAppearance getDefaultAppearance()
DOCUMENT ME!

Returns:
DOCUMENT ME!

setDefaultAppearance

public void setDefaultAppearance(NodeAppearance n)
DOCUMENT ME!

Parameters:
n - DOCUMENT ME!

getDescription

public String getDescription()
Returns a text description of the current default values and calculator names.


applyProperties

public void applyProperties(String name,
                            Properties nacProps,
                            String baseKey,
                            CalculatorCatalog catalog)
DOCUMENT ME!

Parameters:
name - DOCUMENT ME!
nacProps - DOCUMENT ME!
baseKey - DOCUMENT ME!
catalog - DOCUMENT ME!

getProperties

public Properties getProperties(String baseKey)
DOCUMENT ME!

Parameters:
baseKey - DOCUMENT ME!
Returns:
DOCUMENT ME!

copyDefaultAppearance

protected void copyDefaultAppearance(cytoscape.visual.AppearanceCalculator toCopy)

getNodeSizeLocked

public boolean getNodeSizeLocked()
Deprecated. Use VisualStyle.getDependency().check(VisualPropertyDependency.Definition.NODE_SIZE_LOCKED) instead. Will be removed Jan 2011.


setNodeSizeLocked

public void setNodeSizeLocked(boolean b)
Deprecated. Use VisualStyle.getDependency().set(VisualPropertyDependency.Definition.NODE_SIZE_LOCKED,b) instead. Will be removed Jan 2011.


clone

public Object clone(String vsName)
Make deep copy of this object


getCalculator

public Calculator getCalculator(VisualPropertyType type)
DOCUMENT ME!

Parameters:
type - DOCUMENT ME!
Returns:
DOCUMENT ME!

getCalculators

public List<Calculator> getCalculators()
DOCUMENT ME!

Returns:
DOCUMENT ME!

removeCalculator

public void removeCalculator(VisualPropertyType type)
DOCUMENT ME!

Parameters:
type - DOCUMENT ME!

setCalculator

public void setCalculator(Calculator c)
DOCUMENT ME!

Parameters:
c - DOCUMENT ME!

getDescription

protected String getDescription(String name,
                                Appearance defaultAppr)

applyProperties

protected void applyProperties(Appearance appr,
                               String name,
                               Properties nacProps,
                               String baseKey,
                               CalculatorCatalog catalog)

getProperties

protected Properties getProperties(Appearance appr,
                                   String baseKey)

copyCalculators

protected void copyCalculators(cytoscape.visual.AppearanceCalculator copy)

Cytoscape 2.8.0 API

Copyright 2010 Cytoscape Consortium. All rights reserved.