Package com.nomagic.magicdraw.uml.symbols.paths

Class PathElement

java.lang.Object

com.nomagic.magicdraw.uml.core.impl.MDElementImpl

com.nomagic.magicdraw.uml.symbols.PresentationElement

com.nomagic.magicdraw.uml.symbols.paths.PathConnector

com.nomagic.magicdraw.uml.symbols.paths.PathElement

All Implemented Interfaces:

com.dassault_systemes.modeler.foundation.diagram.symbols.LineJumpDrawer, com.dassault_systemes.modeler.foundation.diagram.symbols.shapes.SuspendShapeAutoResizeModeProvider, com.dassault_systemes.modeler.foundation.project.ModelElementProjectProvider, BaseElement, MDElement, ModelElementProvider, NameOwner, PropertyChangeListener, Cloneable, Comparable, EventListener

Direct Known Subclasses:

com.nomagic.magicdraw.uml.symbols.paths.ContainerLinkView, ContainmentLinkView, LinkAttributeView, NoteAnchorView

@OpenApi
public abstract class PathElement
extends PathConnector
implements com.dassault_systemes.modeler.foundation.diagram.symbols.LineJumpDrawer, com.dassault_systemes.modeler.foundation.diagram.symbols.shapes.SuspendShapeAutoResizeModeProvider

Base class for all path kinds of symbols. Path is a symbol that connects two other symbols as a graphical path.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BEZIER	Bezier path line style.
static final List<String>	LINE_STYLE	All possible path line styles.
static final String	OBLIQUE	Oblique path line style.
static final String	RECTILINEAR	Path line style with rectilinear (90 degrees) breakpoint corners.

Fields inherited from class com.nomagic.magicdraw.uml.symbols.PresentationElement

DASHED_STROKE, DOTTED_STROKE, SOLID_STROKE

Method Summary

Modifier and Type	Method	Description
void	accept(BasePresentationElementVisitor visitor)
final List<Point>	getAllBreakPoints()	Returns a break points list with added supplier and client end point in the list as well.
final List<Point>	getBreakPoints()	Returns break points of the path.
PresentationElement	getClient()	Returns client of the path.
final Point	getClientPoint()	Returns point where path connects client end's element.
Point	getPointOnPath(Point supplierPoint, Point clientPoint, List<Point> breakpoints, double coefficient)
PresentationElement	getSupplier()	Returns supplier of the path.
final Point	getSupplierPoint()	Returns point where path connects supplier end's element.
final boolean	isConnectable(PresentationElement supplier, PresentationElement client)	Checks if this path can connect given two elements.

Methods inherited from class com.nomagic.magicdraw.uml.symbols.paths.PathConnector

getConnectedPathElementCount, getConnectedPathElements, getConnectedPathElements, getConnectedPathElements

Methods inherited from class com.nomagic.magicdraw.uml.symbols.PresentationElement

collectSubManipulatedElements, editName, editName, getBoundsShape, getElement, getManipulatedParent, getManipulatedPresentationElements, getObjectParent, getParent, getPreferredDimension, getPresentationElements, getPresentationElementStroke, getPresentationElementStroke, getSelected, getStroke, getStroke, getStroke, getStroke, getStroke, getStroke, hasManipulatedPresentationElements, isSelected, onFind, onFind, setAllSelected, setSelected, setSelected, useParentStyle

Methods inherited from class com.nomagic.magicdraw.uml.core.impl.MDElementImpl

addPropertyChangeListener, canAdd, canAddChild, canBeDeleted, canDeleteChild, compareTo, createSortKeys, getClassType, getID, getName, getResourceID, getSortKeys, hasListeners, isEditable, removeAllParents, removeAllPropertyChangeListeners, removePropertyChangeListener, setID, sGetID, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.nomagic.magicdraw.uml.BaseElement

canAdd, isSelfChangeable

Methods inherited from interface com.dassault_systemes.modeler.foundation.diagram.symbols.LineJumpDrawer

getLineWidth

Methods inherited from interface com.nomagic.magicdraw.utils.NameOwner

getName

Field Details

RECTILINEAR

@OpenApi
public static final String RECTILINEAR

Path line style with rectilinear (90 degrees) breakpoint corners.

See Also:

• Constant Field Values

OBLIQUE

@OpenApi
public static final String OBLIQUE

Oblique path line style.

See Also:

• Constant Field Values

BEZIER

@OpenApi
public static final String BEZIER

Bezier path line style.

See Also:

• Constant Field Values

LINE_STYLE

@OpenApi
public static final List<String> LINE_STYLE

All possible path line styles.

Method Details

getBreakPoints

@OpenApi
public final List<Point> getBreakPoints()

Returns break points of the path. The order of break points is from supplier to the client path's end. Use PresentationElementsManager to change the break points for the path.

Returns:

break points list.Points in the list are not cloned, so do not modify them directly. The List is unmodifiable.

getAllBreakPoints

@OpenApi
public final List<Point> getAllBreakPoints()

Returns a break points list with added supplier and client end point in the list as well. Use PresentationElementsManager to change the break points for the path.

Returns:

supplier point + break points + client point. Points in the list are not cloned, so do not modify them directly. The List is modifiable.

getSupplierPoint

@OpenApi
public final Point getSupplierPoint()

Returns point where path connects supplier end's element.

Returns:

supplier connection point. This method returns not cloned point, so do not modify it directly.

getClientPoint

@OpenApi
public final Point getClientPoint()

Returns point where path connects client end's element.

Returns:

client point. This method returns not cloned point, so do not modify it directly.

getClient

@OpenApi
public PresentationElement getClient()

Returns client of the path.

Returns:

client element.

getSupplier

@OpenApi
public PresentationElement getSupplier()

Returns supplier of the path.

Returns:

supplier end element.

isConnectable

@OpenApi
public final boolean isConnectable(@CheckForNull
 PresentationElement supplier,
 @CheckForNull
 PresentationElement client)

Checks if this path can connect given two elements.

Parameters:

supplier - candidate for path's supplier.

client - candidate for path's client.

Returns:

true, if path can connect given elements.

getPointOnPath

@OpenApi
public Point getPointOnPath(Point supplierPoint,
 Point clientPoint,
 List<Point> breakpoints,
 double coefficient)

Parameters:

supplierPoint - supplier end point

clientPoint - client end point

breakpoints - list of breakpoints between supplier and client in that order

coefficient - ratio between 0 and 1 describing position relative to the path length. Provide 0.5 for middle point.

Returns:

point on path

accept

@OpenApi
public void accept(BasePresentationElementVisitor visitor)
            throws Exception

Overrides:

accept in class PathConnector

Throws:

Exception