Eclipse Draw2d
2.1

org.eclipse.draw2d
Class PolygonDecoration

java.lang.Object
  |
  +--org.eclipse.draw2d.Figure
        |
        +--org.eclipse.draw2d.Shape
              |
              +--org.eclipse.draw2d.Polyline
                    |
                    +--org.eclipse.draw2d.Polygon
                          |
                          +--org.eclipse.draw2d.PolygonDecoration
All Implemented Interfaces:
IFigure, RotatableDecoration

public class PolygonDecoration
extends Polygon
implements RotatableDecoration

A rotatable, polygon shaped decoration most commonly used for decorating the ends of polylines.


Nested Class Summary
 
Nested classes inherited from class org.eclipse.draw2d.Figure
Figure.FigureIterator
 
Nested classes inherited from class org.eclipse.draw2d.IFigure
IFigure.NoInsets
 
Field Summary
static PointList INVERTED_TRIANGLE_TIP
          Template for a triangle that points to the left when the rotation angle is 0
static PointList TRIANGLE_TIP
          Template for a triangle that points to the right when the rotation angle is 0
 
Fields inherited from class org.eclipse.draw2d.Shape
lineStyle, lineWidth
 
Fields 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
PolygonDecoration()
          Constructs a PolygonDecoration.
 
Method Summary
 Color getLocalBackgroundColor()
          Returns the background Color of this Figure.
 PointList getPoints()
          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
 
Methods inherited from class org.eclipse.draw2d.Polyline
addPoint, getBounds, getEnd, getStart, insertPoint, isOpaque, primTranslate, removeAllPoints, removePoint, setEnd, setEndpoints, setLineWidth, setPoint, setPoints, setStart, useLocalCoordinates
 
Methods inherited from class org.eclipse.draw2d.Shape
getLineStyle, getLineWidth, paintFigure, setFill, setFillXOR, setLineStyle, setOutline, setOutlineXOR, setXOR
 
Methods inherited from class org.eclipse.draw2d.Figure
add, add, add, add, addAncestorListener, addFigureListener, addFocusListener, addKeyListener, addListener, addMouseListener, addMouseMotionListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, containsPoint, erase, findDescendantAtExcluding, findFigureAt, findFigureAt, findFigureAt, findFigureAtExcluding, findMouseEventTargetAt, findMouseEventTargetInDescendantsAt, fireMoved, firePropertyChange, firePropertyChange, firePropertyChange, getBackgroundColor, getBorder, getChildren, getClientArea, getClientArea, getCursor, getFlag, getFont, getForegroundColor, getInsets, getLayoutManager, getListeners, 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, isEnabled, isFocusTraversable, isMouseEventTarget, isRequestFocusEnabled, isShowing, isValid, isValidationRoot, isVisible, layout, paint, paintBorder, paintChildren, paintClientArea, remove, removeAll, removeAncestorListener, removeFigureListener, removeFocusListener, removeKeyListener, removeListener, removeMouseListener, removeMouseMotionListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, revalidate, setBackgroundColor, setBorder, setBounds, setChildrenDirection, setChildrenEnabled, setChildrenOrientation, 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, 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, addFigureListener, addFocusListener, addKeyListener, addMouseListener, addMouseMotionListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, containsPoint, containsPoint, erase, findFigureAt, findFigureAt, findFigureAt, findFigureAtExcluding, findMouseEventTargetAt, getBackgroundColor, getBorder, getBounds, getChildren, getClientArea, getClientArea, getCursor, getFont, getForegroundColor, getInsets, getLayoutManager, getLocalForegroundColor, 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, isEnabled, isFocusTraversable, isOpaque, isRequestFocusEnabled, isShowing, isVisible, paint, remove, removeAncestorListener, removeFigureListener, removeFocusListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, revalidate, setBackgroundColor, setBorder, setBounds, setConstraint, setCursor, setEnabled, setFocusTraversable, setFont, setForegroundColor, setLayoutManager, setMaximumSize, setMinimumSize, setOpaque, setParent, setPreferredSize, setRequestFocusEnabled, setSize, setSize, setToolTip, setVisible, translate, translateFromParent, translateToAbsolute, translateToParent, translateToRelative, validate
 

Field Detail

TRIANGLE_TIP

public static final PointList TRIANGLE_TIP
Template for a triangle that points to the right when the rotation angle is 0


INVERTED_TRIANGLE_TIP

public static final PointList INVERTED_TRIANGLE_TIP
Template for a triangle that points to the left when the rotation angle is 0

Constructor Detail

PolygonDecoration

public PolygonDecoration()
Constructs a PolygonDecoration. Defaults the PolygonDecoration to fill its region with black.

Since:
2.0
Method Detail

getLocalBackgroundColor

public Color getLocalBackgroundColor()
Description copied from interface: IFigure
Returns the background Color of this Figure. Does not inherit this Color from the parent, may return null.

Specified by:
getLocalBackgroundColor in interface IFigure
Overrides:
getLocalBackgroundColor in class Figure
Returns:
The local background Color
See Also:
IFigure.getBackgroundColor()

getPoints

public PointList getPoints()
Returns the points in the PolygonDecoration as a PointList.

Overrides:
getPoints in class Polyline
Returns:
the points in this PolygonDecoration
Since:
2.0

setLocation

public void setLocation(Point p)
Sets the location of this PolygonDecoration.

Specified by:
setLocation in interface RotatableDecoration
Overrides:
setLocation in class Figure
Parameters:
p - the new location

setTemplate

public void setTemplate(PointList pl)
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 scaling
y - Y scaling
Since:
2.0

setReferencePoint

public void setReferencePoint(Point ref)
Sets the rotation of this decoration so that the decoration points toward the given reference point.

Specified by:
setReferencePoint in interface RotatableDecoration
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

Eclipse Draw2d
2.1

Copyright (c) IBM Corp. and others 2000, 2003. All Rights Reserved.