org.modelio.api.modelio.model

Interface IImageService

public interface IImageService

This class provide the API to get the image of a model element.

Method Summary

Modifier and Type	Method and Description
org.eclipse.swt.graphics.Image	getMetaclassImage(Class<? extends MObject> metaclass) Get the small icon (16x16 pixels) representing the given metaclass.
org.eclipse.swt.graphics.Image	getStereotypedImage(MObject element, IPeerModule filter, boolean useCmsDecoration) Get the stereotyped image of an element.
org.eclipse.swt.graphics.Image	getUmlImage(MObject element, boolean useCmsDecoration) Get the UML standard image of an model object.

Method Detail

getMetaclassImage

org.eclipse.swt.graphics.Image getMetaclassImage(Class<? extends MObject> metaclass)

Get the small icon (16x16 pixels) representing the given metaclass.

Parameters:

metaclass - A metamodel metaclass.

Returns:

The representing icon.

getStereotypedImage

org.eclipse.swt.graphics.Image getStereotypedImage(MObject element,
                                                   IPeerModule filter,
                                                   boolean useCmsDecoration)

Get the stereotyped image of an element.

The returned image depends on the filter:

• if filter is not null, the first stereotype belonging to that module having an image is used.
  If no such stereotype is found, the method returns null
• otherwise, the first stereotype with an image is used.
  If no such stereotype is found, the method returns the UML image for this element.

Parameters:

element - the element for which the image must be returned.

filter - the module to use as filter.

useCmsDecoration - if true the image will be decorated with the CMS state.

Returns:

the image or null.

getUmlImage

org.eclipse.swt.graphics.Image getUmlImage(MObject element,
                                           boolean useCmsDecoration)

Get the UML standard image of an model object.

This method return the standard image of the model object ignoring the stereotypes owned by the object.

The returned image can be decorated with CMS state image depending on the useCmsDecoration parameter.

Parameters:

element - the model object for which the image must be displayed.

useCmsDecoration - true if the image must be decorated with the CMS state, false otherwise.

Returns:

the image corresponding to the model element.