com.nomagic.magicdraw.uml.symbols.paths

Class PathRenderer

java.lang.Object

com.nomagic.magicdraw.uml.symbols.PresentationElementRenderer

com.nomagic.magicdraw.uml.symbols.paths.PathRenderer

@OpenApiAll
public abstract class PathRenderer
extends PresentationElementRenderer

Path element renderer allows to customize (change) the default view of PathElement.

See Also:

PresentationElementRenderer, ShapeRenderer

Constructor Summary

Constructors

Constructor and Description
PathRenderer()

Method Summary

Modifier and Type	Method and Description
protected void	drawPathAdornment(java.awt.Graphics g, PathElement pathElement) Draws the path adornment.
protected int	getClientEndPreferredSize(PathElement pathElement) The path client end preferred size.
protected PathEndRenderer	getClientEndRenderer(PathElement pathElement) Provides the path client end renderer.
int	getLineWidth(PresentationElement presentationElement) Returns path line width.
protected java.awt.BasicStroke	getPathStroke(PathElement pathElement) Stroke used to draw path.
protected int	getSupplierEndPreferredSize(PathElement pathElement) The path supplier end preferred size.
protected PathEndRenderer	getSupplierEndRenderer(PathElement pathElement) Provides the path supplier end renderer.
protected void	updateText(PresentationElement presentationElement) Update path text.

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

afterUpdate, beforeUpdate, getCenterlinePoint, getColor, getFontProvider, getText, propertiesChanged

Methods inherited from class java.lang.Object

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

Constructor Detail

PathRenderer

public PathRenderer()

Method Detail

getClientEndPreferredSize

protected int getClientEndPreferredSize(PathElement pathElement)

The path client end preferred size. End size is used when drawing adornment on path end (e.g. arrow on the end). Override to change the client end size.

Parameters:

pathElement - path element.

Returns:

end size, or 0 to use default end size.

getSupplierEndPreferredSize

protected int getSupplierEndPreferredSize(PathElement pathElement)

The path supplier end preferred size. End size is used when drawing adornment on path end (e.g. arrow on the end). Override to change the supplier end size.

Parameters:

pathElement - path element.

Returns:

end size, or 0 to use default end size.

getClientEndRenderer

@CheckForNull
protected PathEndRenderer getClientEndRenderer(PathElement pathElement)

Provides the path client end renderer. Override the method to return the custom path end renderer.

Parameters:

pathElement - path element.

Returns:

custom renderer, or null to use default end renderer.

See Also:

PathEndRenderer

getSupplierEndRenderer

@CheckForNull
protected PathEndRenderer getSupplierEndRenderer(PathElement pathElement)

Provides the path supplier end renderer. Override the method to return the custom path end renderer.

Parameters:

pathElement - path element.

Returns:

custom renderer, or null to use default end renderer.

See Also:

PathEndRenderer

getPathStroke

@CheckForNull
protected java.awt.BasicStroke getPathStroke(PathElement pathElement)

Stroke used to draw path. Override to change the stroke for path drawing.

Parameters:

pathElement - drawing path.

Returns:

custom stroke, or null to use the default stroke.

See Also:

PresentationElement.getStroke(int), PresentationElement.getStroke(int, int), PresentationElement.getStroke(java.awt.BasicStroke, int), PresentationElement.getStroke(int, int, int), PresentationElement.getStroke(float, int, int, float, float[], float)

getLineWidth

public int getLineWidth(PresentationElement presentationElement)

Returns path line width. Override to use the custom line width.

Parameters:

presentationElement - drawing path.

Returns:

line width, or 0 to use default line width.

drawPathAdornment

@OpenApi
protected void drawPathAdornment(java.awt.Graphics g,
                                          PathElement pathElement)

Draws the path adornment. By default draws no adornment. Override the method to add the custom adornment drawing.

Parameters:

g - graphics where path is drawn.

pathElement - path to draw adornment for.

updateText

protected final void updateText(PresentationElement presentationElement)

Update path text.

Specified by:

updateText in class PresentationElementRenderer

Parameters:

presentationElement - presentation element