cytoscape.visual
Class EdgeAppearanceCalculator

java.lang.Object
  cytoscape.visual.EdgeAppearanceCalculator

All Implemented Interfaces:

Cloneable

public class EdgeAppearanceCalculator
extends Object
implements Cloneable

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

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) This method customizes this object by searching the supplied properties object for keys identifying default values and calculators.
void	calculateEdgeAppearance(EdgeAppearance appr, giny.model.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(giny.model.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(giny.model.Edge edge, CyNetwork network)
Font	calculateEdgeFont(giny.model.Edge edge, CyNetwork network)
String	calculateEdgeLabel(giny.model.Edge edge, CyNetwork network)
LineType	calculateEdgeLineType(giny.model.Edge edge, CyNetwork network)
Arrow	calculateEdgeSourceArrow(giny.model.Edge edge, CyNetwork network)
Arrow	calculateEdgeTargetArrow(giny.model.Edge edge, CyNetwork network)
String	calculateEdgeToolTip(giny.model.Edge edge, CyNetwork network)
Object	clone() Make shallow copy of this object
Color	getDefaultEdgeColor()
Font	getDefaultEdgeFont()
Font	getDefaultEdgeFontFace()
float	getDefaultEdgeFontSize()
String	getDefaultEdgeLabel()
LineType	getDefaultEdgeLineType()
Arrow	getDefaultEdgeSourceArrow()
Arrow	getDefaultEdgeTargetArrow()
String	getDefaultEdgeToolTip()
String	getDescription() Returns a text description of the current default values and calculator names.
EdgeColorCalculator	getEdgeColorCalculator()
EdgeFontFaceCalculator	getEdgeFontFaceCalculator()
EdgeFontSizeCalculator	getEdgeFontSizeCalculator()
EdgeLabelCalculator	getEdgeLabelCalculator()
EdgeLineTypeCalculator	getEdgeLineTypeCalculator()
EdgeArrowCalculator	getEdgeSourceArrowCalculator()
EdgeArrowCalculator	getEdgeTargetArrowCalculator()
EdgeToolTipCalculator	getEdgeToolTipCalculator()
Properties	getProperties(String baseKey)
void	setDefaultEdgeColor(Color c)
void	setDefaultEdgeFont(Font f)
void	setDefaultEdgeFontFace(Font f)
void	setDefaultEdgeFontSize(float f)
void	setDefaultEdgeLabel(String s)
void	setDefaultEdgeLineType(LineType lt)
void	setDefaultEdgeSourceArrow(Arrow a)
void	setDefaultEdgeTargetArrow(Arrow a)
void	setDefaultEdgeToolTip(String s)
void	setEdgeColorCalculator(EdgeColorCalculator c)
void	setEdgeFontFaceCalculator(EdgeFontFaceCalculator c)
void	setEdgeFontSizeCalculator(EdgeFontSizeCalculator c)
void	setEdgeLabelCalculator(EdgeLabelCalculator c)
void	setEdgeLineTypeCalculator(EdgeLineTypeCalculator c)
void	setEdgeSourceArrowCalculator(EdgeArrowCalculator c)
void	setEdgeTargetArrowCalculator(EdgeArrowCalculator c)
void	setEdgeToolTipCalculator(EdgeToolTipCalculator c)

Methods inherited from class java.lang.Object

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

Constructor Detail

EdgeAppearanceCalculator

public EdgeAppearanceCalculator()

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

Make shallow copy of this object

Overrides:

clone in class Object

Throws:

CloneNotSupportedException

calculateEdgeAppearance

public EdgeAppearance calculateEdgeAppearance(giny.model.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,
                                    giny.model.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.

getDefaultEdgeColor

public Color getDefaultEdgeColor()

setDefaultEdgeColor

public void setDefaultEdgeColor(Color c)

getEdgeColorCalculator

public EdgeColorCalculator getEdgeColorCalculator()

setEdgeColorCalculator

public void setEdgeColorCalculator(EdgeColorCalculator c)

calculateEdgeColor

public Color calculateEdgeColor(giny.model.Edge edge,
                                CyNetwork network)

getDefaultEdgeLineType

public LineType getDefaultEdgeLineType()

setDefaultEdgeLineType

public void setDefaultEdgeLineType(LineType lt)

getEdgeLineTypeCalculator

public EdgeLineTypeCalculator getEdgeLineTypeCalculator()

setEdgeLineTypeCalculator

public void setEdgeLineTypeCalculator(EdgeLineTypeCalculator c)

calculateEdgeLineType

public LineType calculateEdgeLineType(giny.model.Edge edge,
                                      CyNetwork network)

getDefaultEdgeSourceArrow

public Arrow getDefaultEdgeSourceArrow()

setDefaultEdgeSourceArrow

public void setDefaultEdgeSourceArrow(Arrow a)

getEdgeSourceArrowCalculator

public EdgeArrowCalculator getEdgeSourceArrowCalculator()

setEdgeSourceArrowCalculator

public void setEdgeSourceArrowCalculator(EdgeArrowCalculator c)

calculateEdgeSourceArrow

public Arrow calculateEdgeSourceArrow(giny.model.Edge edge,
                                      CyNetwork network)

getDefaultEdgeTargetArrow

public Arrow getDefaultEdgeTargetArrow()

setDefaultEdgeTargetArrow

public void setDefaultEdgeTargetArrow(Arrow a)

getEdgeTargetArrowCalculator

public EdgeArrowCalculator getEdgeTargetArrowCalculator()

setEdgeTargetArrowCalculator

public void setEdgeTargetArrowCalculator(EdgeArrowCalculator c)

calculateEdgeTargetArrow

public Arrow calculateEdgeTargetArrow(giny.model.Edge edge,
                                      CyNetwork network)

getDefaultEdgeLabel

public String getDefaultEdgeLabel()

setDefaultEdgeLabel

public void setDefaultEdgeLabel(String s)

getEdgeLabelCalculator

public EdgeLabelCalculator getEdgeLabelCalculator()

setEdgeLabelCalculator

public void setEdgeLabelCalculator(EdgeLabelCalculator c)

calculateEdgeLabel

public String calculateEdgeLabel(giny.model.Edge edge,
                                 CyNetwork network)

getDefaultEdgeFont

public Font getDefaultEdgeFont()

setDefaultEdgeFont

public void setDefaultEdgeFont(Font f)

getDefaultEdgeFontFace

public Font getDefaultEdgeFontFace()

setDefaultEdgeFontFace

public void setDefaultEdgeFontFace(Font f)

getEdgeFontFaceCalculator

public EdgeFontFaceCalculator getEdgeFontFaceCalculator()

setEdgeFontFaceCalculator

public void setEdgeFontFaceCalculator(EdgeFontFaceCalculator c)

getDefaultEdgeFontSize

public float getDefaultEdgeFontSize()

setDefaultEdgeFontSize

public void setDefaultEdgeFontSize(float f)

getEdgeFontSizeCalculator

public EdgeFontSizeCalculator getEdgeFontSizeCalculator()

setEdgeFontSizeCalculator

public void setEdgeFontSizeCalculator(EdgeFontSizeCalculator c)

calculateEdgeFont

public Font calculateEdgeFont(giny.model.Edge edge,
                              CyNetwork network)

getDefaultEdgeToolTip

public String getDefaultEdgeToolTip()

setDefaultEdgeToolTip

public void setDefaultEdgeToolTip(String s)

getEdgeToolTipCalculator

public EdgeToolTipCalculator getEdgeToolTipCalculator()

setEdgeToolTipCalculator

public void setEdgeToolTipCalculator(EdgeToolTipCalculator c)

calculateEdgeToolTip

public String calculateEdgeToolTip(giny.model.Edge edge,
                                   CyNetwork network)

getDescription

public String getDescription()

Returns a text description of the current default values and calculator names.

applyProperties

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

This method customizes this object by searching the supplied properties object for keys identifying default values and calculators. Recognized keys are of the form "nodeAppearanceCalculator." + name + ident, where name is a supplied argument and ident is a String indicating a default value or a calculator for a specific visual attribute. The specified calculators are aquired by name from the supplied catalog.

getProperties

public Properties getProperties(String baseKey)