Interface ArrowAnnotation
-
- All Superinterfaces:
Annotation
public interface ArrowAnnotation extends Annotation
This is the interface for an arrow annotation. In general, an arrow connects to a source (an existing annotation) and is drawn to a target, which is either another annotation, aCyNode
or a point on the canvas. The end of the arrow will move with its source annotation or its target (unless it's target is a point).Module:
presentation-api
To use this in your app, include the following dependency in your POM:
<dependency> <groupId>org.cytoscape</groupId> <artifactId>presentation-api</artifactId> </dependency>
Cytoscape Backwards Compatibility (API Interface): We expect that this interface will be used but not implemented by developers using this interface. As such, we reserve the right to add methods to the interface as part of minor version upgrades. We will not remove methods for any changes other than major version upgrades.
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
ArrowAnnotation.AnchorType
This enum is used to indicate how the arrow is anchored to the source or target.static class
ArrowAnnotation.ArrowEnd
This enum is used to indicate which end of the arrow the operation is referring to.
-
Field Summary
-
Fields inherited from interface org.cytoscape.view.presentation.annotations.Annotation
BACKGROUND, CANVAS, FOREGROUND, NAME, X, Y, Z, ZOOM
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ArrowAnnotation.AnchorType
getAnchorType(ArrowAnnotation.ArrowEnd end)
Get the anchor type for one end of the arrowPaint
getArrowColor(ArrowAnnotation.ArrowEnd end)
Get the color of one end of the arrowdouble
getArrowSize(ArrowAnnotation.ArrowEnd end)
Get the size of one end of the arrowString
getArrowType(ArrowAnnotation.ArrowEnd end)
Get the type of one end of the arrowPaint
getLineColor()
Set the line color for this arrowdouble
getLineWidth()
Get the line width for this arrowAnnotation
getSource()
Return the sourceAnnotation
for this arrow.List<String>
getSupportedArrows()
Get the list of supported arrow shapesObject
getTarget()
Return the target object for this arrow.void
setAnchorType(ArrowAnnotation.ArrowEnd end, ArrowAnnotation.AnchorType type)
Set the anchor type for one end of the arrowvoid
setArrowColor(ArrowAnnotation.ArrowEnd end, Paint color)
Set the color of one end of the arrowvoid
setArrowSize(ArrowAnnotation.ArrowEnd end, double width)
Set the size of one end of the arrowvoid
setArrowType(ArrowAnnotation.ArrowEnd end, String type)
Set the type of one end of the arrowvoid
setLineColor(Paint color)
Set the line color for this arrowvoid
setLineWidth(double width)
Set the line width for this arrowvoid
setSource(Annotation source)
Set the sourceAnnotation
for this arrow.void
setTarget(Point2D target)
Set the target for this arrow assuming the target is a point on the canvasvoid
setTarget(CyNode target)
Set the target for this arrow assuming the target is aCyNode
void
setTarget(Annotation target)
Set the target for this arrow assuming the target is anAnnotation
-
Methods inherited from interface org.cytoscape.view.presentation.annotations.Annotation
addArrow, getArgMap, getArrows, getCanvasName, getName, getNetworkView, getSpecificZoom, getUUID, getZoom, isSelected, moveAnnotation, removeAnnotation, removeArrow, setCanvas, setName, setSelected, setSpecificZoom, setZoom, update
-
-
-
-
Method Detail
-
getSource
Annotation getSource()
Return the sourceAnnotation
for this arrow.- Returns:
- the source
Annotation
-
setSource
void setSource(Annotation source)
Set the sourceAnnotation
for this arrow.- Parameters:
source
- theAnnotation
for the arrow source
-
getTarget
Object getTarget()
Return the target object for this arrow. Currently supported targets includeAnnotation
s,CyNode
s, and arbitrary points on the canvas.- Returns:
- the the target. Callers should test to determine the appropriate type
-
setTarget
void setTarget(Annotation target)
Set the target for this arrow assuming the target is anAnnotation
- Parameters:
target
- the target for this arrow
-
setTarget
void setTarget(CyNode target)
Set the target for this arrow assuming the target is aCyNode
- Parameters:
target
- the target for this arrow
-
setTarget
void setTarget(Point2D target)
Set the target for this arrow assuming the target is a point on the canvas- Parameters:
target
- the target for this arrow
-
getLineWidth
double getLineWidth()
Get the line width for this arrow- Returns:
- line width as a double
-
setLineWidth
void setLineWidth(double width)
Set the line width for this arrow- Parameters:
width
- of the line as a double
-
getLineColor
Paint getLineColor()
Set the line color for this arrow- Returns:
- color of the line
-
setLineColor
void setLineColor(Paint color)
Set the line color for this arrow- Parameters:
color
- of the line
-
getArrowSize
double getArrowSize(ArrowAnnotation.ArrowEnd end)
Get the size of one end of the arrow- Parameters:
end
- the end of the arrow we're getting the size for- Returns:
- the arrow size
-
setArrowSize
void setArrowSize(ArrowAnnotation.ArrowEnd end, double width)
Set the size of one end of the arrow- Parameters:
end
- the end of the arrow we're setting the size forwidth
- the arrow size
-
getArrowColor
Paint getArrowColor(ArrowAnnotation.ArrowEnd end)
Get the color of one end of the arrow- Parameters:
end
- the end of the arrow we're getting the color for- Returns:
- the arrow color
-
setArrowColor
void setArrowColor(ArrowAnnotation.ArrowEnd end, Paint color)
Set the color of one end of the arrow- Parameters:
end
- the end of the arrow we're setting the color forcolor
- the arrow color
-
getSupportedArrows
List<String> getSupportedArrows()
Get the list of supported arrow shapes- Returns:
- the list of supported arrow types
-
getArrowType
String getArrowType(ArrowAnnotation.ArrowEnd end)
Get the type of one end of the arrow- Parameters:
end
- the end of the arrow we're getting the size for- Returns:
- the arrow type as a string.
-
setArrowType
void setArrowType(ArrowAnnotation.ArrowEnd end, String type)
Set the type of one end of the arrow- Parameters:
end
- the end of the arrow we're setting the type forwidth
- the arrow size
-
getAnchorType
ArrowAnnotation.AnchorType getAnchorType(ArrowAnnotation.ArrowEnd end)
Get the anchor type for one end of the arrow- Parameters:
end
- the end of the arrow we're getting the anchor type for- Returns:
- the anchor type
-
setAnchorType
void setAnchorType(ArrowAnnotation.ArrowEnd end, ArrowAnnotation.AnchorType type)
Set the anchor type for one end of the arrow- Parameters:
end
- the end of the arrow we're setting the anchor type fortype
- the anchor type for this end of the arrow
-
-