cytoscape.visual
Class NodeAppearanceCalculator

java.lang.Object
  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

static String	nodeBorderColorBypass Deprecated. Use calculator.getAttrNameBypass() instead. Will be removed Sept 2007.
static String	nodeFillColorBypass Deprecated. Use calculator.getAttrNameBypass() instead. Will be removed Sept 2007.
static String	nodeFontBypass Deprecated. Use calculator.getAttrNameBypass() instead. Will be removed Sept 2007.
static String	nodeHeightBypass Deprecated. Use calculator.getAttrNameBypass() instead. Will be removed Sept 2007.
static String	nodeLabelBypass Deprecated. Use calculator.getAttrNameBypass() instead. Will be removed Sept 2007.
static String	nodeLabelColorBypass Deprecated. Use calculator.getAttrNameBypass() instead. Will be removed Sept 2007.
static String	nodeLineTypeBypass Deprecated. Use calculator.getAttrNameBypass() instead. Will be removed Sept 2007.
static String	nodeShapeBypass Deprecated. Use calculator.getAttrNameBypass() instead. Will be removed Sept 2007.
static String	nodeToolTipBypass Deprecated. Use calculator.getAttrNameBypass() instead. Will be removed Sept 2007.
static String	nodeWidthBypass Deprecated. Use calculator.getAttrNameBypass() instead. Will be removed Sept 2007.

Constructor Summary

NodeAppearanceCalculator()

NodeAppearanceCalculator(NodeAppearanceCalculator toCopy)
Copy constructor.

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

Method Summary

void	applyProperties(String name, Properties nacProps, String baseKey, CalculatorCatalog catalog)
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.
Color	calculateNodeBorderColor(Node node, CyNetwork network) Deprecated. Use calculateNodeAppearance() and get the value from the NodeAppearance. This method will be removed Sept 2007.
Color	calculateNodeFillColor(Node node, CyNetwork network) Deprecated. Use calculateNodeAppearance() and get the value from the NodeAppearance. This method will be removed Sept 2007.
Font	calculateNodeFont(Node node, CyNetwork network) Deprecated. Use calculateNodeAppearance() and get the value from the NodeAppearance. This method will be removed Sept 2007.
double	calculateNodeHeight(Node node, CyNetwork network) Deprecated. Use calculateNodeAppearance() and get the value from the NodeAppearance. This method will be removed Sept 2007.
String	calculateNodeLabel(Node node, CyNetwork network) Deprecated. Use calculateNodeAppearance() and get the value from the NodeAppearance. This method will be removed Sept 2007.
Color	calculateNodeLabelColor(Node node, CyNetwork network) Deprecated. Use calculateNodeAppearance() and get the value from the NodeAppearance. This method will be removed Sept 2007.
LineType	calculateNodeLineType(Node node, CyNetwork network) Deprecated. Use calculateNodeAppearance() and get the value from the NodeAppearance. This method will be removed Sept 2007.
byte	calculateNodeShape(Node node, CyNetwork network) Deprecated. Use calculateNodeAppearance() and get the value from the NodeAppearance. This method will be removed Sept 2007.
String	calculateNodeToolTip(Node node, CyNetwork network) Deprecated. Use calculateNodeAppearance() and get the value from the NodeAppearance. This method will be removed Sept 2007.
double	calculateNodeWidth(Node node, CyNetwork network) Deprecated. Use calculateNodeAppearance() and get the value from the NodeAppearance. This method will be removed Sept 2007.
Object	clone() Make shallow copy of this object
Calculator	getCalculator(byte type)
List<Calculator>	getCalculators()
NodeAppearance	getDefaultAppearance()
Color	getDefaultNodeBorderColor() Deprecated. Use setDefaultAppearance() instead. This method will be removed Sept 2007.
Color	getDefaultNodeFillColor() Deprecated. Use setDefaultAppearance() instead. This method will be removed Sept 2007.
Font	getDefaultNodeFont() Deprecated. Use setDefaultAppearance() instead. This method will be removed Sept 2007.
Font	getDefaultNodeFontFace() Deprecated. Use setDefaultAppearance() instead. This method will be removed Sept 2007.
float	getDefaultNodeFontSize() Deprecated. Use setDefaultAppearance() instead. This method will be removed Sept 2007.
double	getDefaultNodeHeight() Deprecated. Use setDefaultAppearance() instead. This method will be removed Sept 2007.
String	getDefaultNodeLabel() Deprecated. Use setDefaultAppearance() instead. This method will be removed Sept 2007.
Color	getDefaultNodeLabelColor() Deprecated. Use setDefaultAppearance() instead. This method will be removed Sept 2007.
LineType	getDefaultNodeLineType() Deprecated. Use setDefaultAppearance() instead. This method will be removed Sept 2007.
byte	getDefaultNodeShape() Deprecated. Use setDefaultAppearance() instead. This method will be removed Sept 2007.
String	getDefaultNodeToolTip() Deprecated. Use setDefaultAppearance() instead. This method will be removed Sept 2007.
double	getDefaultNodeWidth() Deprecated. Use setDefaultAppearance() instead. This method will be removed Sept 2007.
String	getDescription() Returns a text description of the current default values and calculator names.
NodeColorCalculator	getNodeBorderColorCalculator() Deprecated. Use getCalculator(type) instead. This method will be removed Sept 2007.
NodeColorCalculator	getNodeFillColorCalculator() Deprecated. Use getCalculator(type) instead. This method will be removed Sept 2007.
NodeFontFaceCalculator	getNodeFontFaceCalculator() Deprecated. Use getCalculator(type) instead. This method will be removed Sept 2007.
NodeFontSizeCalculator	getNodeFontSizeCalculator() Deprecated. Use getCalculator(type) instead. This method will be removed Sept 2007.
NodeSizeCalculator	getNodeHeightCalculator() Deprecated. Use getCalculator(type) instead. This method will be removed Sept 2007.
NodeLabelCalculator	getNodeLabelCalculator() Deprecated. Use getCalculator(type) instead. This method will be removed Sept 2007.
NodeLabelColorCalculator	getNodeLabelColorCalculator() Deprecated. Use getCalculator(type) instead. This method will be removed Sept 2007.
NodeLineTypeCalculator	getNodeLineTypeCalculator() Deprecated. Use getCalculator(type) instead. This method will be removed Sept 2007.
NodeShapeCalculator	getNodeShapeCalculator() Deprecated. Use getCalculator(type) instead. This method will be removed Sept 2007.
boolean	getNodeSizeLocked()
NodeToolTipCalculator	getNodeToolTipCalculator() Deprecated. Use getCalculator(type) instead. This method will be removed Sept 2007.
NodeSizeCalculator	getNodeWidthCalculator() Deprecated. Use getCalculator(type) instead. This method will be removed Sept 2007.
Properties	getProperties(String baseKey)
void	removeCalculator(byte type)
void	setCalculator(Calculator c)
void	setDefaultAppearance(NodeAppearance n)
void	setDefaultNodeBorderColor(Color c) Deprecated. Use getDefaultAppearance() and then set that. This method will be removed Sept 2007.
void	setDefaultNodeFillColor(Color c) Deprecated. Use getDefaultAppearance() and then set that. This method will be removed Sept 2007.
void	setDefaultNodeFont(Font f) Deprecated. Use getDefaultAppearance() and then set that. This method will be removed Sept 2007.
void	setDefaultNodeFontFace(Font f) Deprecated. Use getDefaultAppearance() and then set that. This method will be removed Sept 2007.
void	setDefaultNodeFontSize(float f) Deprecated. Use getDefaultAppearance() and then set that. This method will be removed Sept 2007.
void	setDefaultNodeHeight(double d) Deprecated. Use getDefaultAppearance() and then set that. This method will be removed Sept 2007.
void	setDefaultNodeLabel(String s) Deprecated. Use getDefaultAppearance() and then set that. This method will be removed Sept 2007.
void	setDefaultNodeLabelColor(Color c) Deprecated. Use getDefaultAppearance() and then set that. This method will be removed Sept 2007.
void	setDefaultNodeLineType(LineType lt) Deprecated. Use getDefaultAppearance() and then set that. This method will be removed Sept 2007.
void	setDefaultNodeShape(byte s) Deprecated. Use getDefaultAppearance() and then set that. This method will be removed Sept 2007.
void	setDefaultNodeToolTip(String s) Deprecated. Use getDefaultAppearance() and then set that. This method will be removed Sept 2007.
void	setDefaultNodeWidth(double d) Deprecated. Use getDefaultAppearance() and then set that. This method will be removed Sept 2007.
void	setNodeBorderColorCalculator(NodeColorCalculator c) Deprecated. Use setCalculator(calc) instead. This method will be removed Sept 2007.
void	setNodeFillColorCalculator(NodeColorCalculator c) Deprecated. Use setCalculator(calc) instead. This method will be removed Sept 2007.
void	setNodeFontFaceCalculator(NodeFontFaceCalculator c) Deprecated. Use setCalculator(calc) instead. This method will be removed Sept 2007.
void	setNodeFontSizeCalculator(NodeFontSizeCalculator c) Deprecated. Use setCalculator(calc) instead. This method will be removed Sept 2007.
void	setNodeHeightCalculator(NodeSizeCalculator c) Deprecated. Use setCalculator(calc) instead. This method will be removed Sept 2007.
void	setNodeLabelCalculator(NodeLabelCalculator c) Deprecated. Use setCalculator(calc) instead. This method will be removed Sept 2007.
void	setNodeLabelColorCalculator(NodeLabelColorCalculator c) Deprecated. Use setCalculator(calc) instead. This method will be removed Sept 2007.
void	setNodeLineTypeCalculator(NodeLineTypeCalculator c) Deprecated. Use setCalculator(calc) instead. This method will be removed Sept 2007.
void	setNodeShapeCalculator(NodeShapeCalculator c) Deprecated. Use setCalculator(calc) instead. This method will be removed Sept 2007.
void	setNodeSizeLocked(boolean b)
void	setNodeToolTipCalculator(NodeToolTipCalculator c) Deprecated. Use setCalculator(calc) instead. This method will be removed Sept 2007.
void	setNodeWidthCalculator(NodeSizeCalculator c) Deprecated. Use setCalculator(calc) instead. This method will be removed Sept 2007.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

nodeFillColorBypass

public static final String nodeFillColorBypass

Deprecated. Use calculator.getAttrNameBypass() instead. Will be removed Sept 2007.

See Also:

Constant Field Values

nodeBorderColorBypass

public static final String nodeBorderColorBypass

Deprecated. Use calculator.getAttrNameBypass() instead. Will be removed Sept 2007.

See Also:

Constant Field Values

nodeLineTypeBypass

public static final String nodeLineTypeBypass

Deprecated. Use calculator.getAttrNameBypass() instead. Will be removed Sept 2007.

See Also:

Constant Field Values

nodeShapeBypass

public static final String nodeShapeBypass

Deprecated. Use calculator.getAttrNameBypass() instead. Will be removed Sept 2007.

See Also:

Constant Field Values

nodeWidthBypass

public static final String nodeWidthBypass

Deprecated. Use calculator.getAttrNameBypass() instead. Will be removed Sept 2007.

See Also:

Constant Field Values

nodeHeightBypass

public static final String nodeHeightBypass

Deprecated. Use calculator.getAttrNameBypass() instead. Will be removed Sept 2007.

See Also:

Constant Field Values

nodeLabelBypass

public static final String nodeLabelBypass

Deprecated. Use calculator.getAttrNameBypass() instead. Will be removed Sept 2007.

See Also:

Constant Field Values

nodeToolTipBypass

public static final String nodeToolTipBypass

Deprecated. Use calculator.getAttrNameBypass() instead. Will be removed Sept 2007.

See Also:

Constant Field Values

nodeFontBypass

public static final String nodeFontBypass

Deprecated. Use calculator.getAttrNameBypass() instead. Will be removed Sept 2007.

See Also:

Constant Field Values

nodeLabelColorBypass

public static final String nodeLabelColorBypass

Deprecated. Use calculator.getAttrNameBypass() instead. Will be removed Sept 2007.

See Also:

Constant Field Values

Constructor Detail

NodeAppearanceCalculator

public NodeAppearanceCalculator()

NodeAppearanceCalculator

public NodeAppearanceCalculator(String name,
                                Properties nacProps,
                                String baseKey,
                                CalculatorCatalog catalog)

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.

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()

setDefaultAppearance

public void setDefaultAppearance(NodeAppearance n)

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)

getProperties

public Properties getProperties(String baseKey)

getNodeSizeLocked

public boolean getNodeSizeLocked()

setNodeSizeLocked

public void setNodeSizeLocked(boolean b)

setDefaultNodeFillColor

public void setDefaultNodeFillColor(Color c)

Deprecated. Use getDefaultAppearance() and then set that. This method will be removed Sept 2007.

setDefaultNodeBorderColor

public void setDefaultNodeBorderColor(Color c)

Deprecated. Use getDefaultAppearance() and then set that. This method will be removed Sept 2007.

setDefaultNodeLineType

public void setDefaultNodeLineType(LineType lt)

Deprecated. Use getDefaultAppearance() and then set that. This method will be removed Sept 2007.

setDefaultNodeShape

public void setDefaultNodeShape(byte s)

Deprecated. Use getDefaultAppearance() and then set that. This method will be removed Sept 2007.

setDefaultNodeWidth

public void setDefaultNodeWidth(double d)

Deprecated. Use getDefaultAppearance() and then set that. This method will be removed Sept 2007.

setDefaultNodeHeight

public void setDefaultNodeHeight(double d)

Deprecated. Use getDefaultAppearance() and then set that. This method will be removed Sept 2007.

setDefaultNodeLabel

public void setDefaultNodeLabel(String s)

Deprecated. Use getDefaultAppearance() and then set that. This method will be removed Sept 2007.

setDefaultNodeToolTip

public void setDefaultNodeToolTip(String s)

Deprecated. Use getDefaultAppearance() and then set that. This method will be removed Sept 2007.

setDefaultNodeFont

public void setDefaultNodeFont(Font f)

Deprecated. Use getDefaultAppearance() and then set that. This method will be removed Sept 2007.

setDefaultNodeFontFace

public void setDefaultNodeFontFace(Font f)

Deprecated. Use getDefaultAppearance() and then set that. This method will be removed Sept 2007.

setDefaultNodeFontSize

public void setDefaultNodeFontSize(float f)

Deprecated. Use getDefaultAppearance() and then set that. This method will be removed Sept 2007.

setDefaultNodeLabelColor

public void setDefaultNodeLabelColor(Color c)

Deprecated. Use getDefaultAppearance() and then set that. This method will be removed Sept 2007.

getDefaultNodeFillColor

public Color getDefaultNodeFillColor()

Deprecated. Use setDefaultAppearance() instead. This method will be removed Sept 2007.

getDefaultNodeBorderColor

public Color getDefaultNodeBorderColor()

Deprecated. Use setDefaultAppearance() instead. This method will be removed Sept 2007.

getDefaultNodeLineType

public LineType getDefaultNodeLineType()

Deprecated. Use setDefaultAppearance() instead. This method will be removed Sept 2007.

getDefaultNodeShape

public byte getDefaultNodeShape()

Deprecated. Use setDefaultAppearance() instead. This method will be removed Sept 2007.

getDefaultNodeWidth

public double getDefaultNodeWidth()

Deprecated. Use setDefaultAppearance() instead. This method will be removed Sept 2007.

getDefaultNodeHeight

public double getDefaultNodeHeight()

Deprecated. Use setDefaultAppearance() instead. This method will be removed Sept 2007.

getDefaultNodeLabel

public String getDefaultNodeLabel()

Deprecated. Use setDefaultAppearance() instead. This method will be removed Sept 2007.

getDefaultNodeToolTip

public String getDefaultNodeToolTip()

Deprecated. Use setDefaultAppearance() instead. This method will be removed Sept 2007.

getDefaultNodeFont

public Font getDefaultNodeFont()

Deprecated. Use setDefaultAppearance() instead. This method will be removed Sept 2007.

getDefaultNodeFontFace

public Font getDefaultNodeFontFace()

Deprecated. Use setDefaultAppearance() instead. This method will be removed Sept 2007.

getDefaultNodeFontSize

public float getDefaultNodeFontSize()

Deprecated. Use setDefaultAppearance() instead. This method will be removed Sept 2007.

getDefaultNodeLabelColor

public Color getDefaultNodeLabelColor()

Deprecated. Use setDefaultAppearance() instead. This method will be removed Sept 2007.

calculateNodeFillColor

public Color calculateNodeFillColor(Node node,
                                    CyNetwork network)

Deprecated. Use calculateNodeAppearance() and get the value from the NodeAppearance. This method will be removed Sept 2007.

calculateNodeBorderColor

public Color calculateNodeBorderColor(Node node,
                                      CyNetwork network)

Deprecated. Use calculateNodeAppearance() and get the value from the NodeAppearance. This method will be removed Sept 2007.

calculateNodeLineType

public LineType calculateNodeLineType(Node node,
                                      CyNetwork network)

Deprecated. Use calculateNodeAppearance() and get the value from the NodeAppearance. This method will be removed Sept 2007.

calculateNodeShape

public byte calculateNodeShape(Node node,
                               CyNetwork network)

Deprecated. Use calculateNodeAppearance() and get the value from the NodeAppearance. This method will be removed Sept 2007.

calculateNodeWidth

public double calculateNodeWidth(Node node,
                                 CyNetwork network)

Deprecated. Use calculateNodeAppearance() and get the value from the NodeAppearance. This method will be removed Sept 2007.

calculateNodeHeight

public double calculateNodeHeight(Node node,
                                  CyNetwork network)

Deprecated. Use calculateNodeAppearance() and get the value from the NodeAppearance. This method will be removed Sept 2007.

calculateNodeLabel

public String calculateNodeLabel(Node node,
                                 CyNetwork network)

Deprecated. Use calculateNodeAppearance() and get the value from the NodeAppearance. This method will be removed Sept 2007.

calculateNodeToolTip

public String calculateNodeToolTip(Node node,
                                   CyNetwork network)

Deprecated. Use calculateNodeAppearance() and get the value from the NodeAppearance. This method will be removed Sept 2007.

calculateNodeFont

public Font calculateNodeFont(Node node,
                              CyNetwork network)

Deprecated. Use calculateNodeAppearance() and get the value from the NodeAppearance. This method will be removed Sept 2007.

calculateNodeLabelColor

public Color calculateNodeLabelColor(Node node,
                                     CyNetwork network)

Deprecated. Use calculateNodeAppearance() and get the value from the NodeAppearance. This method will be removed Sept 2007.

getNodeFillColorCalculator

public NodeColorCalculator getNodeFillColorCalculator()

Deprecated. Use getCalculator(type) instead. This method will be removed Sept 2007.

getNodeBorderColorCalculator

public NodeColorCalculator getNodeBorderColorCalculator()

Deprecated. Use getCalculator(type) instead. This method will be removed Sept 2007.

getNodeLineTypeCalculator

public NodeLineTypeCalculator getNodeLineTypeCalculator()

Deprecated. Use getCalculator(type) instead. This method will be removed Sept 2007.

getNodeShapeCalculator

public NodeShapeCalculator getNodeShapeCalculator()

Deprecated. Use getCalculator(type) instead. This method will be removed Sept 2007.

getNodeWidthCalculator

public NodeSizeCalculator getNodeWidthCalculator()

Deprecated. Use getCalculator(type) instead. This method will be removed Sept 2007.

getNodeHeightCalculator

public NodeSizeCalculator getNodeHeightCalculator()

Deprecated. Use getCalculator(type) instead. This method will be removed Sept 2007.

getNodeLabelCalculator

public NodeLabelCalculator getNodeLabelCalculator()

Deprecated. Use getCalculator(type) instead. This method will be removed Sept 2007.

getNodeToolTipCalculator

public NodeToolTipCalculator getNodeToolTipCalculator()

Deprecated. Use getCalculator(type) instead. This method will be removed Sept 2007.

getNodeFontFaceCalculator

public NodeFontFaceCalculator getNodeFontFaceCalculator()

Deprecated. Use getCalculator(type) instead. This method will be removed Sept 2007.

getNodeFontSizeCalculator

public NodeFontSizeCalculator getNodeFontSizeCalculator()

Deprecated. Use getCalculator(type) instead. This method will be removed Sept 2007.

getNodeLabelColorCalculator

public NodeLabelColorCalculator getNodeLabelColorCalculator()

Deprecated. Use getCalculator(type) instead. This method will be removed Sept 2007.

setNodeFillColorCalculator

public void setNodeFillColorCalculator(NodeColorCalculator c)

Deprecated. Use setCalculator(calc) instead. This method will be removed Sept 2007.

setNodeBorderColorCalculator

public void setNodeBorderColorCalculator(NodeColorCalculator c)

Deprecated. Use setCalculator(calc) instead. This method will be removed Sept 2007.

setNodeLineTypeCalculator

public void setNodeLineTypeCalculator(NodeLineTypeCalculator c)

Deprecated. Use setCalculator(calc) instead. This method will be removed Sept 2007.

setNodeShapeCalculator

public void setNodeShapeCalculator(NodeShapeCalculator c)

Deprecated. Use setCalculator(calc) instead. This method will be removed Sept 2007.

setNodeWidthCalculator

public void setNodeWidthCalculator(NodeSizeCalculator c)

Deprecated. Use setCalculator(calc) instead. This method will be removed Sept 2007.

setNodeHeightCalculator

public void setNodeHeightCalculator(NodeSizeCalculator c)

Deprecated. Use setCalculator(calc) instead. This method will be removed Sept 2007.

setNodeLabelCalculator

public void setNodeLabelCalculator(NodeLabelCalculator c)

Deprecated. Use setCalculator(calc) instead. This method will be removed Sept 2007.

setNodeToolTipCalculator

public void setNodeToolTipCalculator(NodeToolTipCalculator c)

Deprecated. Use setCalculator(calc) instead. This method will be removed Sept 2007.

setNodeFontFaceCalculator

public void setNodeFontFaceCalculator(NodeFontFaceCalculator c)

Deprecated. Use setCalculator(calc) instead. This method will be removed Sept 2007.

setNodeFontSizeCalculator

public void setNodeFontSizeCalculator(NodeFontSizeCalculator c)

Deprecated. Use setCalculator(calc) instead. This method will be removed Sept 2007.

setNodeLabelColorCalculator

public void setNodeLabelColorCalculator(NodeLabelColorCalculator c)

Deprecated. Use setCalculator(calc) instead. This method will be removed Sept 2007.

clone

public Object clone()

Make shallow copy of this object

Overrides:

clone in class Object

getCalculator

public Calculator getCalculator(byte type)

getCalculators

public List<Calculator> getCalculators()

removeCalculator

public void removeCalculator(byte type)

setCalculator

public void setCalculator(Calculator c)