cytoscape.visual
Class EdgeAppearanceCalculator

java.lang.Object
  cytoscape.visual.EdgeAppearanceCalculator

All Implemented Interfaces:

Cloneable

public class EdgeAppearanceCalculator
extends Object

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

Constructor Summary

EdgeAppearanceCalculator()
Creates a new EdgeAppearanceCalculator object.

EdgeAppearanceCalculator(EdgeAppearanceCalculator toCopy)
Copy constructor.

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

Method Summary

void	applyProperties(String name, Properties eacProps, String baseKey, CalculatorCatalog catalog) DOCUMENT ME!
void	calculateEdgeAppearance(EdgeAppearance appr, Edge edge, CyNetwork network) Using the rules defined by the default values and calculators in this object, compute an appearance for the requested Edge in the supplied CyNetwork.
EdgeAppearance	calculateEdgeAppearance(Edge edge, CyNetwork network) Using the rules defined by the default values and calculators in this object, compute an appearance for the requested Edge in the supplied CyNetwork.
Color	calculateEdgeColor(Edge edge, CyNetwork network) Deprecated. Use calculateEdgeAppearance() instead. This method will be removed Sept. 2007.
Font	calculateEdgeFont(Edge edge, CyNetwork network) Deprecated. Use calculateEdgeAppearance() instead. This method will be removed Sept. 2007.
String	calculateEdgeLabel(Edge edge, CyNetwork network) Deprecated. Use calculateEdgeAppearance() instead. This method will be removed Sept. 2007.
LineType	calculateEdgeLineType(Edge edge, CyNetwork network) Deprecated. Use calculateEdgeAppearance() instead. This method will be removed Sept. 2007.
Arrow	calculateEdgeSourceArrow(Edge edge, CyNetwork network) Deprecated. Use calculateEdgeAppearance() instead. This method will be removed Sept. 2007.
Arrow	calculateEdgeTargetArrow(Edge edge, CyNetwork network) Deprecated. Use calculateEdgeAppearance() instead. This method will be removed Sept. 2007.
String	calculateEdgeToolTip(Edge edge, CyNetwork network) Deprecated. Use calculateEdgeAppearance() instead. This method will be removed Sept. 2007.
Object	clone() Create deep copy of the object.
Object	clone(String vsName) Make deep copy of this object
Calculator	getCalculator(byte type) Deprecated.
Calculator	getCalculator(VisualPropertyType type) DOCUMENT ME!
List<Calculator>	getCalculators() DOCUMENT ME!
EdgeAppearance	getDefaultAppearance() DOCUMENT ME!
Color	getDefaultEdgeColor() Deprecated. Use getDefaultAppearance() instead. This method will be removed Sept. 2007.
Font	getDefaultEdgeFont() Deprecated. Use getDefaultAppearance() instead. This method will be removed Sept. 2007.
Font	getDefaultEdgeFontFace() Deprecated. Use getDefaultAppearance() instead. This method will be removed Sept. 2007.
float	getDefaultEdgeFontSize() Deprecated. Use getDefaultAppearance() instead. This method will be removed Sept. 2007.
String	getDefaultEdgeLabel() Deprecated. Use getDefaultAppearance() instead. This method will be removed Sept. 2007.
LineType	getDefaultEdgeLineType() Deprecated. Use getDefaultAppearance() instead. This method will be removed Sept. 2007.
Arrow	getDefaultEdgeSourceArrow() Deprecated. Use getDefaultAppearance() instead. This method will be removed Sept. 2007.
Arrow	getDefaultEdgeTargetArrow() Deprecated. Use getDefaultAppearance() instead. This method will be removed Sept. 2007.
String	getDefaultEdgeToolTip() Deprecated. Use getDefaultAppearance() instead. This method will be removed Sept. 2007.
String	getDescription() DOCUMENT ME!
EdgeColorCalculator	getEdgeColorCalculator() Deprecated. Use getCalculator(type) instead. This method will be removed Sept. 2007.
EdgeFontFaceCalculator	getEdgeFontFaceCalculator() Deprecated. Use getCalculator(type) instead. This method will be removed Sept. 2007.
EdgeFontSizeCalculator	getEdgeFontSizeCalculator() Deprecated. Use getCalculator(type) instead. This method will be removed Sept. 2007.
EdgeLabelCalculator	getEdgeLabelCalculator() Deprecated. Use getCalculator(type) instead. This method will be removed Sept. 2007.
EdgeLineTypeCalculator	getEdgeLineTypeCalculator() Deprecated. Use getCalculator(type) instead. This method will be removed Sept. 2007.
EdgeArrowCalculator	getEdgeSourceArrowCalculator() Deprecated. Use getCalculator(type) instead. This method will be removed Sept. 2007.
EdgeArrowCalculator	getEdgeTargetArrowCalculator() Deprecated. Use getCalculator(type) instead. This method will be removed Sept. 2007.
EdgeToolTipCalculator	getEdgeToolTipCalculator() Deprecated. Use getCalculator(type) instead. This method will be removed Sept. 2007.
Properties	getProperties(String baseKey) DOCUMENT ME!
void	removeCalculator(byte type) Deprecated.
void	removeCalculator(VisualPropertyType type) DOCUMENT ME!
void	setCalculator(Calculator c) DOCUMENT ME!
void	setDefaultAppearance(EdgeAppearance appr) DOCUMENT ME!
void	setDefaultEdgeColor(Color c) Deprecated. Use setDefaultAppearance() instead. This method will be removed Sept. 2007.
void	setDefaultEdgeFont(Font f) Deprecated. Use setDefaultAppearance() instead. This method will be removed Sept. 2007.
void	setDefaultEdgeFontFace(Font f) Deprecated. Use setDefaultAppearance() instead. This method will be removed Sept. 2007.
void	setDefaultEdgeFontSize(float f) Deprecated. Use setDefaultAppearance() instead. This method will be removed Sept. 2007.
void	setDefaultEdgeLabel(String s) Deprecated. Use setDefaultAppearance() instead. This method will be removed Sept. 2007.
void	setDefaultEdgeLineType(LineType lt) Deprecated. Use setDefaultAppearance() instead. This method will be removed Sept. 2007.
void	setDefaultEdgeSourceArrow(Arrow a) Deprecated. Use setDefaultAppearance() instead. This method will be removed Sept. 2007.
void	setDefaultEdgeTargetArrow(Arrow a) Deprecated. Use setDefaultAppearance() instead. This method will be removed Sept. 2007.
void	setDefaultEdgeToolTip(String s) Deprecated. Use setDefaultAppearance() instead. This method will be removed Sept. 2007.
void	setEdgeColorCalculator(EdgeColorCalculator c) Deprecated. Use setCalculator(calc) instead. This method will be removed Sept. 2007.
void	setEdgeFontFaceCalculator(EdgeFontFaceCalculator c) Deprecated. Use setCalculator(calc) instead. This method will be removed Sept. 2007.
void	setEdgeFontSizeCalculator(EdgeFontSizeCalculator c) Deprecated. Use setCalculator(calc) instead. This method will be removed Sept. 2007.
void	setEdgeLabelCalculator(EdgeLabelCalculator c) Deprecated. Use setCalculator(calc) instead. This method will be removed Sept. 2007.
void	setEdgeLineTypeCalculator(EdgeLineTypeCalculator c) Deprecated. Use setCalculator(calc) instead. This method will be removed Sept. 2007.
void	setEdgeSourceArrowCalculator(EdgeArrowCalculator c) Deprecated. Use setCalculator(calc) instead. This method will be removed Sept. 2007.
void	setEdgeTargetArrowCalculator(EdgeArrowCalculator c) Deprecated. Use setCalculator(calc) instead. This method will be removed Sept. 2007.
void	setEdgeToolTipCalculator(EdgeToolTipCalculator 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

Constructor Detail

EdgeAppearanceCalculator

public EdgeAppearanceCalculator()

Creates a new EdgeAppearanceCalculator object.

EdgeAppearanceCalculator

public EdgeAppearanceCalculator(EdgeAppearanceCalculator toCopy)

Copy constructor. Returns a default object if the argument is null.

EdgeAppearanceCalculator

public EdgeAppearanceCalculator(String name,
                                Properties eacProps,
                                String baseKey,
                                CalculatorCatalog catalog)

Creates a new EdgeAppearanceCalculator and immediately customizes it by calling applyProperties with the supplied arguments.

Method Detail

clone

public Object clone()

Create deep copy of the object.

calculateEdgeAppearance

public EdgeAppearance calculateEdgeAppearance(Edge edge,
                                              CyNetwork network)

Using the rules defined by the default values and calculators in this object, compute an appearance for the requested Edge in the supplied CyNetwork. A new EdgeApperance object will be created.

calculateEdgeAppearance

public void calculateEdgeAppearance(EdgeAppearance appr,
                                    Edge edge,
                                    CyNetwork network)

Using the rules defined by the default values and calculators in this object, compute an appearance for the requested Edge in the supplied CyNetwork. The supplied EdgeAppearance object will be changed to hold the new values.

getDefaultAppearance

public EdgeAppearance getDefaultAppearance()

DOCUMENT ME!

Returns:

DOCUMENT ME!

setDefaultAppearance

public void setDefaultAppearance(EdgeAppearance appr)

DOCUMENT ME!

Parameters:

appr - DOCUMENT ME!

getDescription

public String getDescription()

DOCUMENT ME!

Returns:

DOCUMENT ME!

applyProperties

public void applyProperties(String name,
                            Properties eacProps,
                            String baseKey,
                            CalculatorCatalog catalog)

DOCUMENT ME!

Parameters:

name - DOCUMENT ME!

eacProps - DOCUMENT ME!

baseKey - DOCUMENT ME!

catalog - DOCUMENT ME!

getProperties

public Properties getProperties(String baseKey)

DOCUMENT ME!

Parameters:

baseKey - DOCUMENT ME!

Returns:

DOCUMENT ME!

getEdgeColorCalculator

public EdgeColorCalculator getEdgeColorCalculator()

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

getEdgeLineTypeCalculator

public EdgeLineTypeCalculator getEdgeLineTypeCalculator()

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

getEdgeSourceArrowCalculator

public EdgeArrowCalculator getEdgeSourceArrowCalculator()

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

getEdgeTargetArrowCalculator

public EdgeArrowCalculator getEdgeTargetArrowCalculator()

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

getEdgeLabelCalculator

public EdgeLabelCalculator getEdgeLabelCalculator()

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

getEdgeFontFaceCalculator

public EdgeFontFaceCalculator getEdgeFontFaceCalculator()

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

getEdgeFontSizeCalculator

public EdgeFontSizeCalculator getEdgeFontSizeCalculator()

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

getEdgeToolTipCalculator

public EdgeToolTipCalculator getEdgeToolTipCalculator()

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

setDefaultEdgeColor

public void setDefaultEdgeColor(Color c)

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

setDefaultEdgeLineType

public void setDefaultEdgeLineType(LineType lt)

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

setDefaultEdgeSourceArrow

public void setDefaultEdgeSourceArrow(Arrow a)

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

setDefaultEdgeTargetArrow

public void setDefaultEdgeTargetArrow(Arrow a)

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

setDefaultEdgeLabel

public void setDefaultEdgeLabel(String s)

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

setDefaultEdgeFont

public void setDefaultEdgeFont(Font f)

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

setDefaultEdgeFontFace

public void setDefaultEdgeFontFace(Font f)

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

setDefaultEdgeFontSize

public void setDefaultEdgeFontSize(float f)

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

setDefaultEdgeToolTip

public void setDefaultEdgeToolTip(String s)

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

getDefaultEdgeColor

public Color getDefaultEdgeColor()

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

getDefaultEdgeLineType

public LineType getDefaultEdgeLineType()

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

getDefaultEdgeSourceArrow

public Arrow getDefaultEdgeSourceArrow()

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

getDefaultEdgeTargetArrow

public Arrow getDefaultEdgeTargetArrow()

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

getDefaultEdgeLabel

public String getDefaultEdgeLabel()

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

getDefaultEdgeFont

public Font getDefaultEdgeFont()

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

getDefaultEdgeFontFace

public Font getDefaultEdgeFontFace()

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

getDefaultEdgeFontSize

public float getDefaultEdgeFontSize()

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

getDefaultEdgeToolTip

public String getDefaultEdgeToolTip()

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

calculateEdgeColor

public Color calculateEdgeColor(Edge edge,
                                CyNetwork network)

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

calculateEdgeLineType

public LineType calculateEdgeLineType(Edge edge,
                                      CyNetwork network)

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

calculateEdgeSourceArrow

public Arrow calculateEdgeSourceArrow(Edge edge,
                                      CyNetwork network)

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

calculateEdgeTargetArrow

public Arrow calculateEdgeTargetArrow(Edge edge,
                                      CyNetwork network)

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

calculateEdgeLabel

public String calculateEdgeLabel(Edge edge,
                                 CyNetwork network)

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

calculateEdgeFont

public Font calculateEdgeFont(Edge edge,
                              CyNetwork network)

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

calculateEdgeToolTip

public String calculateEdgeToolTip(Edge edge,
                                   CyNetwork network)

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

setEdgeColorCalculator

public void setEdgeColorCalculator(EdgeColorCalculator c)

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

setEdgeLineTypeCalculator

public void setEdgeLineTypeCalculator(EdgeLineTypeCalculator c)

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

setEdgeSourceArrowCalculator

public void setEdgeSourceArrowCalculator(EdgeArrowCalculator c)

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

setEdgeTargetArrowCalculator

public void setEdgeTargetArrowCalculator(EdgeArrowCalculator c)

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

setEdgeLabelCalculator

public void setEdgeLabelCalculator(EdgeLabelCalculator c)

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

setEdgeFontFaceCalculator

public void setEdgeFontFaceCalculator(EdgeFontFaceCalculator c)

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

setEdgeFontSizeCalculator

public void setEdgeFontSizeCalculator(EdgeFontSizeCalculator c)

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

setEdgeToolTipCalculator

public void setEdgeToolTipCalculator(EdgeToolTipCalculator c)

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

clone

public Object clone(String vsName)

Make deep copy of this object

getCalculator

@Deprecated
public Calculator getCalculator(byte type)

Deprecated.

Use Calculator getCalculator(final VisualPropertyType type) instead.

Parameters:

type -

Returns:

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

@Deprecated
public void removeCalculator(byte type)

Deprecated.

Use removeCalculator(final VisualPropertyType type) instead.

Parameters:

type -

removeCalculator

public void removeCalculator(VisualPropertyType type)

DOCUMENT ME!

Parameters:

type - DOCUMENT ME!

setCalculator

public void setCalculator(Calculator c)

DOCUMENT ME!

Parameters:

c - DOCUMENT ME!