ProcessEdge

java.lang.Object
- net.frapu.code.visualization.SerializableProcessObject
- - net.frapu.code.visualization.ProcessObject
  - - net.frapu.code.visualization.ProcessEdge

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

Aggregation, Aggregation, Assignment, Association, Association, Association, Association, Association, Association, Association, CommentEdge, Connection, Connection, Connection, Connection, ContainmentEdge, ConversationLink, Edge, EquivalentClassEdge, Inheritance, Inheritance, InhibitorEdge, MessageFlow, Realization, ResetEdge, Sequence, SequenceFlow, SubClassEdge, Transition, UsedBy, VirtualXFormsEdge
```
public abstract class ProcessEdge
extends ProcessObject
```
This class provides an abstract representation of a process edge.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`PROP_COLOR_ARC` The color of the arc in jawa.awt.Color
`static java.lang.String`	`PROP_LABEL` The label of the edge
`static java.lang.String`	`PROP_LABELOFFSET` The offset of the label from the source (in percent as double)
`static java.lang.String`	`PROP_POINTS` The list of intermediate routing points in format x1,y1+x2,y2+x3,y3
`static java.lang.String`	`PROP_SOURCE_DOCKPOINT` The source docking point (offset from source node)
`static java.lang.String`	`PROP_SOURCENODE`
`static java.lang.String`	`PROP_TARGET_DOCKPOINT` The target docking point (offset from target node)
`static java.lang.String`	`PROP_TARGETNODE`
`protected java.util.List<java.awt.Point>`	`routingPointCache`
`static java.lang.String`	`TAG_EDGE` Serialization properties

Fields inherited from class net.frapu.code.visualization.ProcessObject
contexts, FALSE, PROP_CLASS_TYPE, PROP_ID, TRUE

Constructor Summary

Constructors
Constructor and Description

ProcessEdge()

ProcessEdge(ProcessNode source, ProcessNode target)

Constructors
Constructor and Description
`ProcessEdge()`
`ProcessEdge(ProcessNode source, ProcessNode target)`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addRoutingPoint(int pos, java.awt.Point p)` Adds a new routing point at a specific location (0=first index)
`void`	`addRoutingPoint(java.awt.Point p)` Adds a routing point (detects the position automatically).
`void`	`clearRoutingPoints()` removes all routing points of that edge
`void`	`clearSourceDockPointOffset()` resets the target docking point offset and returns to the usage of automatic determination
`void`	`clearTargetDockPointOffset()` resets the target docking point offset and returns to the usage of automatic determination
`ProcessEdge`	`clone()`
`void`	`clonePropertiesFrom(ProcessEdge edge)` Clones all properties from this ProcessEdge, including ID and TYPE.
`void`	`copyPropertiesFrom(ProcessEdge edge)` Copies the properties from this ProcessEdge, without ID and Type.
`int`	`distanceToEdge(java.awt.Point p)` Returns the closest distance of a certain point to the lines of this edge.
`protected void`	`drawSourceArrow(java.awt.Graphics2D g2)` This method draws the source arrow.
`protected void`	`drawTargetArrow(java.awt.Graphics2D g2)` This method draws the target arrow.
`java.awt.Color`	`getColor()` Returns the Color of the Edge.
`protected java.awt.geom.QuadCurve2D`	`getCurve(java.awt.Point p1, java.awt.Point p2, boolean direction)`
`java.awt.Point`	`getDockPointOffset(boolean fromSource)`
`java.lang.String`	`getLabel()`
`ProcessHelper`	`getLabelHelper()`
`double`	`getLabelOffset()`
`java.awt.Point`	`getLabelPosition()` Returns the center position of the label.
`abstract java.awt.Stroke`	`getLineStroke()`
`java.lang.String`	`getName()` Returns the Name of this ProcessObject
`java.awt.Point`	`getRoutingPoint(int index)` Returns the routing Point with the given Index.
`java.util.List<java.awt.Point>`	`getRoutingPoints()` Returns the list of Points the edge goes through.
`java.util.List<java.awt.Shape>`	`getRoutingPointShapes()` Returns a list of Shapes representing the routing points.
`ProcessNode`	`getSource()`
`java.awt.Point`	`getSourceDockPointOffset()` Gets the relative dock point for the source node, based on the source node's position.
`abstract java.awt.Shape`	`getSourceShape()`
`ProcessNode`	`getTarget()`
`java.awt.Point`	`getTargetDockPointOffset()` Gets the relative dock point for the target node, based on the target node's position.
`abstract java.awt.Shape`	`getTargetShape()`
`protected java.lang.String`	`getXmlTag()`
`protected boolean`	`isDockingSupported()` Returns if this edge supports docking (might be overwritten by subclasses).
`boolean`	`isOutlineSourceArrow()` Determines whether the source arrow should be outlined or not.
`boolean`	`isOutlineTargetArrow()` Determines whether the target arrow should be outlined or not.
`void`	`moveRoutingPoint(int pos, java.awt.Point p)` sets the coordiantes of the point with index pos to the position p.
`static ProcessEdge`	`newInstanceFromSerialization(org.w3c.dom.Node XMLnode, java.util.HashMap<java.lang.String,ProcessNode> nodesInModel)`
`protected void`	`paint(java.awt.Graphics g)` Draws the edge.
`protected void`	`paintInternal(java.awt.Graphics g)` Paints the flow object on the given graphics.
`protected void`	`paintSelection(java.awt.Graphics g)` Paints the selection around the edge (if selected).
`void`	`removeRoutingPoint(int pos)` Removes a routing point at a specific location (0=first index)
`void`	`setColor(java.awt.Color color)` Sets the Color of the Edge.
`void`	`setDockPointOffset(java.awt.Point p, boolean forSource)` Sets source or target dock point offset depending on forSource.
`void`	`setLabel(java.lang.String label)`
`void`	`setLabelOffset(double offset)`
`void`	`setRoutingPoints(java.util.List<java.awt.Point> _rps)`
`void`	`setSource(ProcessNode source)`
`void`	`setSourceDockPointOffset(java.awt.Point p)` Sets the relative dock point for the source node, based on the source node's position.
`void`	`setTarget(ProcessNode target)`
`void`	`setTargetDockPointOffset(java.awt.Point p)` Sets the relative dock point for the target node, based on the target node's position.
`java.lang.String`	`toString()`
`protected void`	`updateCache()`

Methods inherited from class net.frapu.code.visualization.ProcessObject
addContext, addListener, equals, getAlpha, getContexts, getId, getPropertyEditor, isHighlighted, isSelected, removeContext, removeListener, setAlpha, setHighlighted, setId, setProperty, setPropertyEditor, setSelected

Methods inherited from class net.frapu.code.visualization.SerializableProcessObject
getProperty, getPropertyKeys, getSerialization, removeProperty

Methods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - TAG_EDGE
```
public static final java.lang.String TAG_EDGE
```
    Serialization properties
    
    See Also:
    
    Constant Field Values
  - PROP_SOURCENODE
```
public static final java.lang.String PROP_SOURCENODE
```
    See Also:
    
    Constant Field Values
  - PROP_TARGETNODE
```
public static final java.lang.String PROP_TARGETNODE
```
    See Also:
    
    Constant Field Values
  - PROP_POINTS
```
public static final java.lang.String PROP_POINTS
```
    The list of intermediate routing points in format x1,y1+x2,y2+x3,y3
    
    See Also:
    
    Constant Field Values
  - PROP_COLOR_ARC
```
public static final java.lang.String PROP_COLOR_ARC
```
    The color of the arc in jawa.awt.Color
    
    See Also:
    
    Constant Field Values
  - PROP_LABEL
```
public static final java.lang.String PROP_LABEL
```
    The label of the edge
    
    See Also:
    
    Constant Field Values
  - PROP_LABELOFFSET
```
public static final java.lang.String PROP_LABELOFFSET
```
    The offset of the label from the source (in percent as double)
    
    See Also:
    
    Constant Field Values
  - PROP_SOURCE_DOCKPOINT
```
public static final java.lang.String PROP_SOURCE_DOCKPOINT
```
    The source docking point (offset from source node)
    
    See Also:
    
    Constant Field Values
  - PROP_TARGET_DOCKPOINT
```
public static final java.lang.String PROP_TARGET_DOCKPOINT
```
    The target docking point (offset from target node)
    
    See Also:
    
    Constant Field Values
  - routingPointCache
```
protected transient java.util.List<java.awt.Point> routingPointCache
```
- Constructor Detail
  - ProcessEdge
```
public ProcessEdge()
```
  - ProcessEdge
```
public ProcessEdge(ProcessNode source,
                   ProcessNode target)
```
- Method Detail
  - newInstanceFromSerialization
```
public static ProcessEdge newInstanceFromSerialization(org.w3c.dom.Node XMLnode,
                                                       java.util.HashMap<java.lang.String,ProcessNode> nodesInModel)
                                                throws java.lang.ClassNotFoundException,
                                                       java.lang.InstantiationException,
                                                       java.lang.IllegalAccessException,
                                                       java.lang.Exception
```
    Throws:
    
    java.lang.ClassNotFoundException
    
    java.lang.InstantiationException
    
    java.lang.IllegalAccessException
    
    java.lang.Exception
  - getSource
```
public ProcessNode getSource()
```
  - setSource
```
public void setSource(ProcessNode source)
```
  - getTarget
```
public ProcessNode getTarget()
```
  - setTarget
```
public void setTarget(ProcessNode target)
```
  - setLabel
```
public void setLabel(java.lang.String label)
```
  - getLabel
```
public java.lang.String getLabel()
```
  - getLabelPosition
```
public java.awt.Point getLabelPosition()
```
    Returns the center position of the label.
    
    Returns:
  - getLabelOffset
```
public double getLabelOffset()
```
  - setLabelOffset
```
public void setLabelOffset(double offset)
```
  - setColor
```
public void setColor(java.awt.Color color)
```
    Sets the Color of the Edge.
    
    Parameters:
    
    color -
  - getColor
```
public java.awt.Color getColor()
```
    Returns the Color of the Edge.
    
    Returns:
  - isDockingSupported
```
protected boolean isDockingSupported()
```
    Returns if this edge supports docking (might be overwritten by subclasses).
    
    Returns:
  - addRoutingPoint
```
public void addRoutingPoint(java.awt.Point p)
```
    Adds a routing point (detects the position automatically).
    
    Parameters:
    
    p -
  - addRoutingPoint
```
public void addRoutingPoint(int pos,
                            java.awt.Point p)
```
    Adds a new routing point at a specific location (0=first index)
    
    Parameters:
    
    p -
    
    pos -
  - moveRoutingPoint
```
public void moveRoutingPoint(int pos,
                             java.awt.Point p)
```
    sets the coordiantes of the point with index pos to the position p.
    
    Parameters:
    
    pos -
    
    p -
  - clearRoutingPoints
```
public void clearRoutingPoints()
```
    removes all routing points of that edge
  - removeRoutingPoint
```
public void removeRoutingPoint(int pos)
```
    Removes a routing point at a specific location (0=first index)
    
    Parameters:
    
    p -
    
    pos -
  - getRoutingPoints
```
public java.util.List<java.awt.Point> getRoutingPoints()
```
    Returns the list of Points the edge goes through. The initial and final Points are always contained (gathered from the source and target nodes via ProcessNode.getConnectionPoint().
  - getRoutingPoint
```
public java.awt.Point getRoutingPoint(int index)
```
    Returns the routing Point with the given Index. Negative Numbers can be used to count from the end. -1 Is the Index of the last element.
    
    Parameters:
    
    index -
    
    Returns:
    
    getRoutingPoints().get(index);
  - getRoutingPointShapes
```
public java.util.List<java.awt.Shape> getRoutingPointShapes()
```
    Returns a list of Shapes representing the routing points.
    
    Returns:
  - updateCache
```
protected void updateCache()
```
  - getSourceShape
```
public abstract java.awt.Shape getSourceShape()
```
  - getTargetShape
```
public abstract java.awt.Shape getTargetShape()
```
  - getLineStroke
```
public abstract java.awt.Stroke getLineStroke()
```
  - paint
```
protected void paint(java.awt.Graphics g)
```
    Draws the edge.
    
    Parameters:
    
    g -
  - paintSelection
```
protected void paintSelection(java.awt.Graphics g)
```
    Paints the selection around the edge (if selected). Might be implemented by a subclass.
    
    Parameters:
    
    g -
  - paintInternal
```
protected void paintInternal(java.awt.Graphics g)
```
    Paints the flow object on the given graphics. Might be overridden by a subclass for special purposes.
    
    Parameters:
    
    g -
  - getCurve
```
protected java.awt.geom.QuadCurve2D getCurve(java.awt.Point p1,
                                             java.awt.Point p2,
                                             boolean direction)
```
  - drawSourceArrow
```
protected void drawSourceArrow(java.awt.Graphics2D g2)
```
    This method draws the source arrow. Might be overwriten.
    
    Parameters:
    
    g -
  - drawTargetArrow
```
protected void drawTargetArrow(java.awt.Graphics2D g2)
```
    This method draws the target arrow. Might be overwriten.
    
    Parameters:
    
    g -
  - distanceToEdge
```
public int distanceToEdge(java.awt.Point p)
```
    Returns the closest distance of a certain point to the lines of this edge.
    
    Parameters:
    
    p -
    
    Returns:
  - setSourceDockPointOffset
```
public void setSourceDockPointOffset(java.awt.Point p)
```
    Sets the relative dock point for the source node, based on the source node's position.
    
    Parameters:
    
    p -
  - setDockPointOffset
```
public void setDockPointOffset(java.awt.Point p,
                               boolean forSource)
```
    Sets source or target dock point offset depending on forSource.
    
    Parameters:
    
    p -
    
    forSource -
  - getSourceDockPointOffset
```
public java.awt.Point getSourceDockPointOffset()
```
    Gets the relative dock point for the source node, based on the source node's position. If it was not specified, null will be returned.
    
    Parameters:
    
    p -
  - clearSourceDockPointOffset
```
public void clearSourceDockPointOffset()
```
    resets the target docking point offset and returns to the usage of automatic determination
  - setTargetDockPointOffset
```
public void setTargetDockPointOffset(java.awt.Point p)
```
    Sets the relative dock point for the target node, based on the target node's position.
    
    Parameters:
    
    p -
  - getTargetDockPointOffset
```
public java.awt.Point getTargetDockPointOffset()
```
    Gets the relative dock point for the target node, based on the target node's position. If it was not specified, null will be returned.
    
    Parameters:
    
    p -
  - getDockPointOffset
```
public java.awt.Point getDockPointOffset(boolean fromSource)
```
  - clearTargetDockPointOffset
```
public void clearTargetDockPointOffset()
```
    resets the target docking point offset and returns to the usage of automatic determination
  - isOutlineSourceArrow
```
public boolean isOutlineSourceArrow()
```
    Determines whether the source arrow should be outlined or not. Might be overwritten by subclasses.
    
    Returns:
  - isOutlineTargetArrow
```
public boolean isOutlineTargetArrow()
```
    Determines whether the target arrow should be outlined or not. Might be overwritten by subclasses.
    
    Returns:
  - copyPropertiesFrom
```
public void copyPropertiesFrom(ProcessEdge edge)
```
    Copies the properties from this ProcessEdge, without ID and Type.
    
    Parameters:
    
    edge -
    
    See Also:
    
    clonePropertiesFrom()
  - clonePropertiesFrom
```
public void clonePropertiesFrom(ProcessEdge edge)
```
    Clones all properties from this ProcessEdge, including ID and TYPE.
    
    Parameters:
    
    edge -
    
    See Also:
    
    copyPropertiesFrom()
  - clone
```
public ProcessEdge clone()
```
    Overrides:
    
    clone in class ProcessObject
  - getXmlTag
```
protected java.lang.String getXmlTag()
```
    Specified by:
    
    getXmlTag in class SerializableProcessObject
  - getName
```
public java.lang.String getName()
```
    Description copied from class: ProcessObject
    
    Returns the Name of this ProcessObject
    
    Overrides:
    
    getName in class ProcessObject
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - getLabelHelper
```
public ProcessHelper getLabelHelper()
```
    Returns:
  - setRoutingPoints
```
public void setRoutingPoints(java.util.List<java.awt.Point> _rps)
```
    Parameters:
    
    _rps -

Class ProcessEdge

Field Summary

Fields inherited from class net.frapu.code.visualization.ProcessObject

Constructor Summary

Method Summary

Methods inherited from class net.frapu.code.visualization.ProcessObject

Methods inherited from class net.frapu.code.visualization.SerializableProcessObject

Methods inherited from class java.lang.Object

Field Detail

TAG_EDGE

PROP_SOURCENODE

PROP_TARGETNODE

PROP_POINTS

PROP_COLOR_ARC

PROP_LABEL

PROP_LABELOFFSET

PROP_SOURCE_DOCKPOINT

PROP_TARGET_DOCKPOINT

routingPointCache

Constructor Detail

ProcessEdge

ProcessEdge

Method Detail

newInstanceFromSerialization

getSource

setSource

getTarget

setTarget

setLabel

getLabel

getLabelPosition

getLabelOffset

setLabelOffset

setColor

getColor

isDockingSupported

addRoutingPoint

addRoutingPoint

moveRoutingPoint

clearRoutingPoints

removeRoutingPoint

getRoutingPoints

getRoutingPoint

getRoutingPointShapes

updateCache

getSourceShape

getTargetShape

getLineStroke

paint

paintSelection

paintInternal

getCurve

drawSourceArrow

drawTargetArrow

distanceToEdge

setSourceDockPointOffset

setDockPointOffset

getSourceDockPointOffset

clearSourceDockPointOffset

setTargetDockPointOffset

getTargetDockPointOffset

getDockPointOffset

clearTargetDockPointOffset

isOutlineSourceArrow

isOutlineTargetArrow

copyPropertiesFrom

clonePropertiesFrom

clone

getXmlTag

getName

toString

getLabelHelper

setRoutingPoints