Package ro.sync.ecss.extensions.api

Class AuthorImageDecorator

java.lang.Object

ro.sync.ecss.extensions.api.AuthorImageDecorator

All Implemented Interfaces:

Extension

Direct Known Subclasses:

AuthorImageMapDecorator

@API(type=EXTENDABLE,
     src=PUBLIC)
public abstract class AuthorImageDecorator
extends java.lang.Object
implements Extension

Permits decoration of the images that are displayed in the Author view. For instance it can overlay some meta-information over the image.

It receives the graphics device, the size and position of the underlying image.

Since:

18

Constructor Summary

Constructors

Constructor	Description
AuthorImageDecorator()

Method Summary

Modifier and Type	Method	Description
java.lang.String	getDescription()
abstract void	paint(Graphics g, int x, int y, int imageWidth, int imageHeight, Rectangle originalSize, AuthorNode element, AuthorAccess authorAccess, boolean wasAnnotated)	Decorates an image.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AuthorImageDecorator

public AuthorImageDecorator()

Method Detail

paint

public abstract void paint(Graphics g,
                           int x,
                           int y,
                           int imageWidth,
                           int imageHeight,
                           Rectangle originalSize,
                           AuthorNode element,
                           AuthorAccess authorAccess,
                           boolean wasAnnotated)

Decorates an image. The image was already painted in the provided Graphics.

Parameters:

g - The graphics.

x - The X of the area to be painted. It is the top left corner of the image.

y - The Y of the area to be painted. It is the top left corner of the image.

imageWidth - The image width.

imageHeight - The image height.

originalSize - The original size of the image.

element - The element to be painted.

authorAccess - The author access.

wasAnnotated - If true the image was annotated with previous dimensions.

getDescription

public java.lang.String getDescription()

Specified by:

getDescription in interface Extension

Returns:

The description of the extension.

See Also:

Extension.getDescription()