|
IBM Rational Software Modeler Release 6.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
An object that can be decorated. The decorator target is an adaptable,
minimally, it adapts to an EditPart
and
org.eclipse.uml2.Element
if the shape/connection has an
underlying element.
Nested Class Summary | |
static class |
IDecoratorTarget.Direction
Enumeration of directions for location of shape decorations. |
Method Summary | |
IDecoration |
addConnectionDecoration(org.eclipse.swt.graphics.Image image,
int percentageFromSource,
boolean isVolatile)
Adds an image as a decoration on a connection. |
IDecoration |
addShapeDecoration(org.eclipse.swt.graphics.Image image,
IDecoratorTarget.Direction direction,
int margin,
boolean isVolatile)
Adds an image as a decoration on a shape. |
void |
installDecorator(Object key,
IDecorator decorator)
Installs a decorator on this decorator target. |
void |
removeDecoration(IDecoration decoration)
Removes the decoration from the shape or connector it has been added to. |
Methods inherited from interface org.eclipse.core.runtime.IAdaptable |
getAdapter |
Method Detail |
public void installDecorator(Object key, IDecorator decorator)
key
- the key for the decorator, used to override a decorator
previously installed on the decoratorTarget objectdecorator
- the decorator to installpublic IDecoration addShapeDecoration(org.eclipse.swt.graphics.Image image, IDecoratorTarget.Direction direction, int margin, boolean isVolatile)
image
- The image to be used as the decoration.direction
- The direction relative to the shape to place the decoration.margin
- The margin is the space, in himetric units, between the
shape's edge and the decoration. A positive margin will place
the figure outside the shape, a negative margin will place the
decoration inside the shape.isVolatile
- True if this decoration is volatile (i.e. not to be included
in the printed output of a diagram); false otherwise.
public IDecoration addConnectionDecoration(org.eclipse.swt.graphics.Image image, int percentageFromSource, boolean isVolatile)
image
- The image to be used as the decoration.percentageFromSource
- The percentage of the connector length away from the source
end (range is from 0 to 100) where the decoration should be
positioned.isVolatile
- True if this decoration is volatile (i.e. not to be included
in the printed output of a diagram); false otherwise.
public void removeDecoration(IDecoration decoration)
decoration
- The decoration to be removed.
|
IBM Rational Software Modeler Release 6.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2004. All rights reserved.