Domain Modeling Layer

com.ibm.xtools.presentation.services.decorator
Interface IDecoratorTarget

All Superinterfaces:
IAdaptable

Deprecated. Use the org.eclipse.gmf.runtime.diagram.ui IDecoratorTarget instead. The diagram.ui should be used in place of the presentation plugin whenever possible.

public interface IDecoratorTarget
extends IAdaptable

This is here for backwards compatibility only.

See Also:
IDecoratorTarget

Nested Class Summary
static class IDecoratorTarget.Direction
          Deprecated. Use the org.eclipse.gmf.runtime.diagram.ui.services.decorator.IDecoratorTarget.Direction
 
Method Summary
 IDecoration addConnectionDecoration(Image image, int percentageFromSource, boolean isVolatile)
          Deprecated. Adds an image as a decoration on a connection.
 IDecoration addShapeDecoration(Image image, IDecoratorTarget.Direction direction, int margin, boolean isVolatile)
          Deprecated. Adds an image as a decoration on a shape.
 void installDecorator(Object key, IDecorator decorator)
          Deprecated. Installs a decorator on this decorator target using a key (a String identifier).
 void removeDecoration(IDecoration decoration)
          Deprecated. Removes the decoration from the shape or connection it has been added to.
 
Methods inherited from interface org.eclipse.core.runtime.IAdaptable
getAdapter
 

Method Detail

installDecorator

void installDecorator(Object key,
                      IDecorator decorator)
Deprecated. 
Installs a decorator on this decorator target using a key (a String identifier). If another decorator is installed on the same target with the same key then it will override the previous one installed.

Parameters:
key - the key for the decorator, used to override a decorator previously installed on this decoratorTarget object
decorator - the decorator to install

addShapeDecoration

IDecoration addShapeDecoration(Image image,
                               IDecoratorTarget.Direction direction,
                               int margin,
                               boolean isVolatile)
Deprecated. 
Adds an image as a decoration on a shape.

Parameters:
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.
Returns:
The decoration object, which will be needed to remove the decoration from the shape.

addConnectionDecoration

IDecoration addConnectionDecoration(Image image,
                                    int percentageFromSource,
                                    boolean isVolatile)
Deprecated. 
Adds an image as a decoration on a connection.

Parameters:
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.
Returns:
The decoration object, which will be needed to remove the decoration from the connection.

removeDecoration

void removeDecoration(IDecoration decoration)
Deprecated. 
Removes the decoration from the shape or connection it has been added to.

Parameters:
decoration - The decoration to be removed.

Domain Modeling Layer

© Copyright IBM Corp. 2009. All rights reserved.