Package org.eclipse.draw2d
Class PolygonDecoration
java.lang.Object
org.eclipse.draw2d.Figure
org.eclipse.draw2d.Shape
org.eclipse.draw2d.AbstractPointListShape
org.eclipse.draw2d.Polyline
org.eclipse.draw2d.Polygon
org.eclipse.draw2d.PolygonDecoration
- All Implemented Interfaces:
IFigure
,RotatableDecoration
A rotatable, polygon shaped decoration most commonly used for decorating the
ends of
polylines
.-
Nested Class Summary
Nested classes/interfaces inherited from class org.eclipse.draw2d.Figure
Figure.FigureIterator, Figure.IdentitySearch, Figure.ReverseFigureChildrenIterator
Nested classes/interfaces inherited from interface org.eclipse.draw2d.IFigure
IFigure.NoInsets
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final PointList
Template for a triangle that points to the left when the rotation angle is 0static final PointList
Template for a triangle that points to the right when the rotation angle is 0Fields inherited from class org.eclipse.draw2d.Figure
bgColor, border, bounds, fgColor, flags, font, MAX_FLAG, maxSize, minSize, NO_MANAGER, prefSize, toolTip
Fields inherited from interface org.eclipse.draw2d.IFigure
MAX_DIMENSION, MIN_DIMENSION, NO_INSETS
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionReturnsnull
or the local background Color of this Figure.Returns the points in the PolygonDecoration as a PointList.void
setLocation
(Point p) Sets the location of this PolygonDecoration.void
setReferencePoint
(Point ref) Sets the rotation of this decoration so that the decoration points toward the given reference point.void
setRotation
(double angle) Sets the angle by which rotation is to be done on the PolygonDecoration.void
setScale
(double x, double y) Sets the amount of scaling to be done along X and Y axes on the PolygonDecoration's template.void
setTemplate
(PointList pl) Sets the PolygonDecorations point template to the passed PointList.Methods inherited from class org.eclipse.draw2d.Polygon
containsPoint, fillShape, outlineShape, shapeContainsPoint
Methods inherited from class org.eclipse.draw2d.Polyline
getBounds, isOpaque, primTranslate, removeAllPoints, repaint, setLineWidth, setPoints, setTolerance
Methods inherited from class org.eclipse.draw2d.AbstractPointListShape
addPoint, childrenContainsPoint, getEnd, getStart, insertPoint, removePoint, setEnd, setEndpoints, setPoint, setStart
Methods inherited from class org.eclipse.draw2d.Shape
getAlpha, getAntialias, getLineAttributes, getLineCap, getLineDash, getLineDashOffset, getLineJoin, getLineMiterLimit, getLineStyle, getLineWidth, getLineWidthFloat, paintFigure, setAlpha, setAlpha, setAntialias, setAntialias, setFill, setFillXOR, setLineAttributes, setLineCap, setLineDash, setLineDashOffset, setLineJoin, setLineMiterLimit, setLineStyle, setLineWidthFloat, setOutline, setOutlineXOR, setXOR
Methods inherited from class org.eclipse.draw2d.Figure
add, add, add, add, addAncestorListener, addCoordinateListener, addFigureListener, addFocusListener, addKeyListener, addLayoutListener, addListener, addMouseListener, addMouseMotionListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, containsPoint, erase, findDescendantAtExcluding, findFigureAt, findFigureAt, findFigureAt, findFigureAtExcluding, findMouseEventTargetAt, findMouseEventTargetInDescendantsAt, fireCoordinateSystemChanged, fireFigureMoved, fireMoved, firePropertyChange, firePropertyChange, firePropertyChange, getBackgroundColor, getBorder, getChildren, getChildrenRevIterable, getClientArea, getClientArea, getClippingStrategy, getCursor, getFlag, getFont, getForegroundColor, getInsets, getLayoutManager, getListeners, getListenersIterable, getLocalFont, getLocalForegroundColor, getLocation, getMaximumSize, getMinimumSize, getMinimumSize, getParent, getPreferredSize, getPreferredSize, getSize, getToolTip, getUpdateManager, handleFocusGained, handleFocusLost, handleKeyPressed, handleKeyReleased, handleMouseDoubleClicked, handleMouseDragged, handleMouseEntered, handleMouseExited, handleMouseHover, handleMouseMoved, handleMousePressed, handleMouseReleased, hasFocus, internalGetEventDispatcher, intersects, invalidate, invalidateTree, isCoordinateSystem, isEnabled, isFocusTraversable, isMirrored, isMouseEventTarget, isRequestFocusEnabled, isShowing, isValid, isValidationRoot, isVisible, layout, optimizeClip, paint, paintBorder, paintChildren, paintClientArea, remove, removeAll, removeAncestorListener, removeCoordinateListener, removeFigureListener, removeFocusListener, removeKeyListener, removeLayoutListener, removeListener, removeMouseListener, removeMouseMotionListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, requestFocus, revalidate, setBackgroundColor, setBorder, setBounds, setChildrenDirection, setChildrenEnabled, setChildrenOrientation, setClippingStrategy, setConstraint, setCursor, setEnabled, setFlag, setFocusTraversable, setFont, setForegroundColor, setLayoutManager, setMaximumSize, setMinimumSize, setOpaque, setParent, setPreferredSize, setPreferredSize, setRequestFocusEnabled, setSize, setSize, setToolTip, setValid, setVisible, translate, translateFromParent, translateToAbsolute, translateToParent, translateToRelative, useLocalCoordinates, validate
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.eclipse.draw2d.IFigure
add, add, add, add, addAncestorListener, addCoordinateListener, addFigureListener, addFocusListener, addKeyListener, addLayoutListener, addMouseListener, addMouseMotionListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, containsPoint, containsPoint, erase, findFigureAt, findFigureAt, findFigureAt, findFigureAtExcluding, findMouseEventTargetAt, getBackgroundColor, getBorder, getBounds, getChildren, getClientArea, getClientArea, getClippingStrategy, getCursor, getFont, getForegroundColor, getInsets, getLayoutManager, getLocalForegroundColor, getLocation, getMaximumSize, getMinimumSize, getMinimumSize, getParent, getPreferredSize, getPreferredSize, getSize, getToolTip, getUpdateManager, handleFocusGained, handleFocusLost, handleKeyPressed, handleKeyReleased, handleMouseDoubleClicked, handleMouseDragged, handleMouseEntered, handleMouseExited, handleMouseHover, handleMouseMoved, handleMousePressed, handleMouseReleased, hasFocus, internalGetEventDispatcher, intersects, invalidate, invalidateTree, isCoordinateSystem, isEnabled, isFocusTraversable, isMirrored, isOpaque, isRequestFocusEnabled, isShowing, isVisible, paint, remove, removeAncestorListener, removeCoordinateListener, removeFigureListener, removeFocusListener, removeKeyListener, removeLayoutListener, removeMouseListener, removeMouseMotionListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, revalidate, setBackgroundColor, setBorder, setBounds, setClippingStrategy, setConstraint, setCursor, setEnabled, setFocusTraversable, setFont, setForegroundColor, setLayoutManager, setMaximumSize, setMinimumSize, setOpaque, setParent, setPreferredSize, setRequestFocusEnabled, setSize, setSize, setToolTip, setVisible, translate, translateFromParent, translateToAbsolute, translateToParent, translateToRelative, validate
-
Field Details
-
TRIANGLE_TIP
Template for a triangle that points to the right when the rotation angle is 0 -
INVERTED_TRIANGLE_TIP
Template for a triangle that points to the left when the rotation angle is 0
-
-
Constructor Details
-
PolygonDecoration
public PolygonDecoration()Constructs a PolygonDecoration. Defaults the PolygonDecoration to fill its region with black.- Since:
- 2.0
-
-
Method Details
-
getLocalBackgroundColor
Description copied from class:Figure
Returnsnull
or the local background Color of this Figure. Does not inherit this Color from the parent.- Specified by:
getLocalBackgroundColor
in interfaceIFigure
- Overrides:
getLocalBackgroundColor
in classFigure
- Returns:
- bgColor
null
or the local background Color - See Also:
-
getPoints
Returns the points in the PolygonDecoration as a PointList.- Overrides:
getPoints
in classAbstractPointListShape
- Returns:
- the points in this PolygonDecoration
- Since:
- 2.0
-
setLocation
Sets the location of this PolygonDecoration.- Specified by:
setLocation
in interfaceIFigure
- Specified by:
setLocation
in interfaceRotatableDecoration
- Overrides:
setLocation
in classFigure
- Parameters:
p
- the new location- See Also:
-
setTemplate
Sets the PolygonDecorations point template to the passed PointList. This template is an outline of the PolygonDecoration's region. (The default value is TRIANGLE_TIP which is a triangle whose tip is pointing to the right).- Parameters:
pl
- the PointList outline to use as the PolygonDecoration's region- Since:
- 2.0
-
setScale
public void setScale(double x, double y) Sets the amount of scaling to be done along X and Y axes on the PolygonDecoration's template.- Parameters:
x
- X scalingy
- Y scaling- Since:
- 2.0
-
setReferencePoint
Sets the rotation of this decoration so that the decoration points toward the given reference point.- Specified by:
setReferencePoint
in interfaceRotatableDecoration
- Parameters:
ref
- the reference point
-
setRotation
public void setRotation(double angle) Sets the angle by which rotation is to be done on the PolygonDecoration.- Parameters:
angle
- Angle of rotation- Since:
- 2.0
-