ConForM.CoopnTools.CoKer.Visual
Interface GraphicalVisualArc

All Superinterfaces:
GraphicalVisualEditable, GraphicalVisualElement, GraphicalVisualRenderable, javax.swing.undo.StateEditable
All Known Implementing Classes:
AbstractGraphicalArc

public interface GraphicalVisualArc
extends GraphicalVisualElement

Graphical visual arc. This interface defines the elements of graphical visual which are arc, by extending graphical visual elements. Arcs are attched to two shapes.


Fields inherited from interface javax.swing.undo.StateEditable
RCSID
 
Method Summary
 void addIntermediaryPoint(java.awt.Point point)
          Add an intermediary point at the best index.
 void addIntermediaryPoint(java.awt.Point point, int index)
          Add an intermediary point at a specific index.
 void attachmentPointMoved(GraphicalVisualShape shape)
          Notification of the move of an attachment point.
 GraphicalVisualShape end()
          Get the ending shape of the element.
 java.awt.Point[] getIntermediaryPoints()
          Get the intermediary points.
 int getType()
          Get the type of the arc.
 void moveIntermediaryPoint(java.awt.Dimension dim, int index)
          Try to move an intermediary point.
 void removeIntermediaryPoint(int index)
          Remove an intermediary point at a specific index.
 void removeIntermediaryPoint(java.awt.Point point)
          Remove an intermediary point at the best index.
 void setLayoutIntermediaryPoints(java.awt.Point[] newIp)
          Set the intermediary points according to a layout.
 void setType(int type)
          Specifiy the type of the arc.
 GraphicalVisualShape start()
          Get the starting shape of the element.
 
Methods inherited from interface ConForM.CoopnTools.CoKer.Visual.GraphicalVisualElement
attachToParent, description, externalBox, externalInfoBox, externalLabelBox, getInfo, getLocation, getShown, getShownInfo, getShownLabel, getStringTransfer, getTransferable, inducedSelection, induceSelection, inside, label, parent, parentMoved, partOfParent, selected, setLayoutLocation
 
Methods inherited from interface ConForM.CoopnTools.CoKer.Visual.GraphicalVisualEditable
abortMove, commitMove, inChange, move, move, moveInfo, moveInfo, moveLabel, moveLabel, restoreCompleteState, setColor, setInfo, setShown, setShownInfo, setShownLabel, storeCompleteState
 
Methods inherited from interface javax.swing.undo.StateEditable
restoreState, storeState
 
Methods inherited from interface ConForM.CoopnTools.CoKer.Visual.GraphicalVisualRenderable
actionOnMultipleClick, boundingBox, deselect, export, paint, pointedElement, print, saveAspect, saveAspectAs, saveAspectAsPossible, saveAspectPossible, selectElement, selectInfo, selectLabel, specificPopup
 

Method Detail

start

public GraphicalVisualShape start()
Get the starting shape of the element. Every arc element in a graphics has exactly 1 starting shape.
Returns:
the starting shape of this arc; never null

end

public GraphicalVisualShape end()
Get the ending shape of the element. Every arc element in a graphics has exactly 1 ending shape.
Returns:
the ending shape of this arc; never null

getIntermediaryPoints

public java.awt.Point[] getIntermediaryPoints()
Get the intermediary points.
Returns:
The intermediary points, as an array of points, never null. If no intermediary points are defined, it returns an array of size 0.

setLayoutIntermediaryPoints

public void setLayoutIntermediaryPoints(java.awt.Point[] newIp)
Set the intermediary points according to a layout. This method is intended to be used by layouters only; it should not be called by external objects.
Parameters:
newIp - the new ip, in absolute coordinates

addIntermediaryPoint

public void addIntermediaryPoint(java.awt.Point point,
                                 int index)
Add an intermediary point at a specific index.
Parameters:
point - the location of the new point; cannot be null
index - the index; must be valid
Throws:
java.lang.IllegalArgumentException - The index is not valid, or the point is null.

addIntermediaryPoint

public void addIntermediaryPoint(java.awt.Point point)
Add an intermediary point at the best index. The index is determined such that the closest path segment is broken.
Parameters:
point - the location of the new point; cannot be null
Throws:
java.lang.IllegalArgumentException - The point is null.

removeIntermediaryPoint

public void removeIntermediaryPoint(int index)
Remove an intermediary point at a specific index.
Parameters:
index - the index; must be valid
Throws:
java.lang.IllegalArgumentException - The index is not valid.

removeIntermediaryPoint

public void removeIntermediaryPoint(java.awt.Point point)
Remove an intermediary point at the best index. The index is determined such that the closest intermediary point to the parameter point is removed.
Parameters:
point - the approximative location of the point to remove; cannot be null
Throws:
java.lang.IllegalArgumentException - The point is null.

moveIntermediaryPoint

public void moveIntermediaryPoint(java.awt.Dimension dim,
                                  int index)
Try to move an intermediary point.
Parameters:
dim - the difference of position
index - the index; must be valid
Throws:
java.lang.IllegalArgumentException - The index is not valid.

getType

public int getType()
Get the type of the arc.
Returns:
the type of the arc.

setType

public void setType(int type)
Specifiy the type of the arc.
Parameters:
type - the type of the arc

attachmentPointMoved

public void attachmentPointMoved(GraphicalVisualShape shape)
Notification of the move of an attachment point.
Parameters:
shape - the shape involved in the move