Package org.eclipse.draw2d.graph
Class Edge
java.lang.Object
org.eclipse.draw2d.graph.Edge
A directed Edge joining a source and target Node. Edges indicate the
 dependencies between nodes. An Edge provides the information needed to
 perform a graph layout, and it stores the result of the layout in its various
 field. Therefore, it functions both as input and output. The input data
 consists of:
 
- source- the source Node
- target- the target Node
- delta- the minimum number of rows the edge should span
- weight- a hint indicating this edge's importance
- width- the edge's width
- padding- the amount of space to leave on either side of the edge
- [offsetSource] - the edge's attachment point at the source node
- [offsetTarget] - the edge's attachment point at the target node
The output of a layout consists of bending longer edges, and potentially inverting edges to remove cycles in the graph. The output consists of:
- vNodes- the virtual nodes (if any) which make up the bendpoints
- isFeedback-- trueif the edge points backwards
- Since:
- 2.1.2
- 
Field SummaryFieldsModifier and TypeFieldDescriptionAn arbitrary data field for use by clients.intDeprecated.use accessors insteadDeprecated.usegetPoints()booleanDeprecated.INTERNAL field, use accessor method Indicates an edge was inverted during the layoutintDeprecated.use accessors insteadintDeprecated.use accessors insteadintDeprecated.use accessors insteadThe source Node.Deprecated.usegetPoints()The target Node.The virtual nodes used to bend edges which go across one or more ranks.intA hint indicating how straight and short the edge should be relative to other edges in the graph.intDeprecated.use accessors instead
- 
Constructor SummaryConstructorsConstructorDescriptionConstructs a new edge with the given data object, source, and target node.Constructs a new edge with the given source and target nodes.Constructs a new edge with the given source, target, delta, and weight.
- 
Method SummaryModifier and TypeMethodDescriptionintgetDelta()Returns the delta value.intFor internal use only.intReturns the path connecting the edge's source and target.intReturns the effective source offset for this edge.intReturns the effective target offset for this edge.intgetWidth()voidinvert()Swaps the source and target nodes.booleanReturnstrueif the edge was a feedback edge.For internal use only.voidsetDelta(int delta) Sets the delta value.voidsetPadding(int padding) Sets the padding for this edge.voidSets the source node and adds this edge to the new source's outgoing edges.voidsetSourceOffset(int offset) voidSets the target node and adds this edge to the new target's incoming edges.voidsetTargetOffset(int offset) voidsetWidth(int width) Sets the width of the edge.
- 
Field Details- 
dataAn arbitrary data field for use by clients.
- 
deltaDeprecated.use accessors insteadThe minimum rank separation between the source and target nodes. The default value is 1.
- 
endDeprecated.usegetPoints()The ending point.
- 
isFeedbackDeprecated.INTERNAL field, use accessor method Indicates an edge was inverted during the layout
- 
offsetSourceDeprecated.use accessors insteadThe edge's attachment point at the source node. The default value is -1, which indicates that the edge should use the node's defaultoutgoingattachment point.
- 
offsetTargetDeprecated.use accessors insteadThe edge's attachment point at the target node. The default value is -1, which indicates that the edge should use the node's defaultincomingattachment point.
- 
paddingDeprecated.use accessors insteadThe minimum amount of space to leave on both the left and right sides of the edge.
- 
sourceThe source Node.
- 
startDeprecated.usegetPoints()The starting point.
- 
targetThe target Node.
- 
vNodesThe virtual nodes used to bend edges which go across one or more ranks. Each virtual node is just a regular node which occupies some small amount of space on a row. It's width is equivalent to the edge's width. Clients can use each virtual node's location (x, y, width, and height) as the way to position an edge which spans multiple rows.
- 
weightpublic int weightA hint indicating how straight and short the edge should be relative to other edges in the graph. The default value is1.
- 
widthDeprecated.use accessors instead
 
- 
- 
Constructor Details- 
EdgeConstructs a new edge with the given source and target nodes. All other fields will have their default values.- Parameters:
- source- the source Node
- target- the target Node
 
- 
EdgeConstructs a new edge with the given source, target, delta, and weight.- Parameters:
- source- the source Node
- target- the target Node
- delta- the minimum edge span
- weight- the weight hint
 
- 
EdgeConstructs a new edge with the given data object, source, and target node.- Parameters:
- data- an arbitrary data object
- source- the source node
- target- the target node
 
 
- 
- 
Method Details- 
getDeltapublic int getDelta()Returns the delta value. The delta is the minimum rank separation for the edge's source and target nodes.- Returns:
- the delta.
- Since:
- 3.2
 
- 
getLengthpublic int getLength()For internal use only. Returns the target node's row minus the source node's row.- Returns:
- the distance from the source to target ranks
 
- 
getPaddingpublic int getPadding()
- 
getPointsReturns the path connecting the edge's source and target.- Returns:
- a point list
- Since:
- 3.2
 
- 
getSourceOffsetpublic int getSourceOffset()Returns the effective source offset for this edge. The effective source offset is either theoffsetSourcefield, or the source node's default outgoing offset if that field's value is -1.- Returns:
- the source offset
 
- 
getTargetOffsetpublic int getTargetOffset()Returns the effective target offset for this edge. The effective target offset is either theoffsetTargetfield, or the target node's default incoming offset if that field's value is -1.- Returns:
- the target offset
 
- 
getWidthpublic int getWidth()
- 
invertpublic void invert()Swaps the source and target nodes. If any positional data has been calculated, it is inverted as well to reflect the new direction.- Since:
- 2.1.2
 
- 
isFeedbackpublic boolean isFeedback()Returnstrueif the edge was a feedback edge. The layout algorithm may invert one or more edges to remove all cycles from the input. The set of edges that are inverted are referred to as the "feedback" set.- Returns:
- trueif the edge is feedback
- Since:
- 3.2
 
- 
oppositeFor internal use only. Returns the node opposite the given node on this edge.- Parameters:
- end- one end
- Returns:
- the other end
 
- 
setDeltapublic void setDelta(int delta) Sets the delta value.- Parameters:
- delta- the new delta value
- Since:
- 3.2
 
- 
setPaddingpublic void setPadding(int padding) Sets the padding for this edge.- Parameters:
- padding- the padding
- Since:
- 3.2
 
- 
setSourceSets the source node and adds this edge to the new source's outgoing edges. If the source node is previously set, removes this edge from the old source's outgoing edges.- Parameters:
- node- the new source
- Since:
- 3.2
 
- 
setSourceOffsetpublic void setSourceOffset(int offset) 
- 
setTargetSets the target node and adds this edge to the new target's incoming edges. If the target node is previously set, removes this edge from the old target's incoming edges.- Parameters:
- node- the new target
- Since:
- 3.2
 
- 
setTargetOffsetpublic void setTargetOffset(int offset) 
- 
setWidthpublic void setWidth(int width) Sets the width of the edge.- Parameters:
- width- the new width
- Since:
- 3.2
 
 
-