com.sharkysoft.fig.core.doodle

Class ImageDoodle

java.lang.Object

com.sharkysoft.fig.core.doodle.ChildDoodle

com.sharkysoft.fig.core.doodle.FlatDoodle

com.sharkysoft.fig.core.doodle.ImageDoodle

All Implemented Interfaces:

DefaultOriginDoodle, Doodle, ToolTip, ImageObserver

public class ImageDoodle
extends FlatDoodle
implements ImageObserver

Image-based doodle.

Details: ImageDoodles allow you to include arbitrary images in a figure. ImageDoodle comprises a Java AWT Image and a bounding rectangle, called the "frame," which controls the position and size of the image in the figure. The image is automatically scaled to fit in the frame, fully justified. (Note that this means the image will be distorted if the aspect of the frame differs from the aspect ratio of the image.) Optionally, a clipping shape, called the "mask," can also be specified. This allows you to define image-based shapes that are non-rectangular subsets of the original image.

Several of the methods in this class refer to the "image area." This is defined as the intersection of the frame and the mask, or the confined region where image data is drawn.

Author:

Sharky

Field Summary

Fields inherited from class com.sharkysoft.fig.core.doodle.FlatDoodle

mToolTip, mZOrder

Fields inherited from class com.sharkysoft.fig.core.doodle.ChildDoodle

mParent

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
ImageDoodle(Rectangle2D iFrame, Image iImage) Sets frame and image.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	contains(AffineTransform iTransform, Point2D iP) Determines whether point is contained in image area.
boolean	draw(FigGraphics iG) Renders doodle.
Rectangle2D	getBounds(AffineTransform iTransform, Rectangle2D oBounds) Computes rectangular bounds.
Rectangle2D	getFrame() Returns the current frame.
Image	getImage() Returns current image.
Area	getMask() Returns current mask.
boolean	imageUpdate(Image iImage, int iInfoFlags, int iX, int iY, int iW, int iH)
void	setFrame(Rectangle2D iFrame) Sets current image frame.
void	setImage(Image iImage) Sets new image.
void	setMask(Area iMask) Sets image mask.
void	setZOrder(float iZOrder) Updates Z-order property.

Methods inherited from class com.sharkysoft.fig.core.doodle.FlatDoodle

getToolTip, getZOrder, setToolTip

Methods inherited from class com.sharkysoft.fig.core.doodle.ChildDoodle

getDefaultOrigin, getParent, redraw, setParent

Methods inherited from class java.lang.Object

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

Constructor Detail

ImageDoodle

public ImageDoodle(Rectangle2D iFrame,
           Image iImage)

Sets frame and image.

Details: This constructor sets the frame and the image. No mask is configured. The frame cannot be null, but the image may be.

Parameters:

iFrame - the frame

iImage - the image

Method Detail

getFrame

public Rectangle2D getFrame()

Returns the current frame.

Details: This method returns the current frame.

Returns:

the current frame

setFrame

public void setFrame(Rectangle2D iFrame)

Sets current image frame.

Details: This method sets the current frame. This value cannot be null.

Parameters:

iFrame - the new frame

getImage

public Image getImage()

Returns current image.

Details: This method returns the current image displayed by this shape. This value may be null.

Returns:

current image

setImage

public void setImage(Image iImage)

Sets new image.

Details: This method sets the image to be displayed by this shape. The new image may be null if no image is desired.

Parameters:

iImage - the new image

getMask

public Area getMask()

Returns current mask.

Details: This method returns the current mask applied to the image, if any. If no mask is set, this method returns null.

Returns:

current mask

setMask

public void setMask(Area iMask)

Sets image mask.

Details: This method sets the image's mask. By default, in a new ImageDoodle no mask is set. This method allows you to confine the displayed image to non-rectangular regions. Note that the mask works in conjunction with the frame. After the image is positioned and scaled by the frame, the mask is applied for clipping.

Parameters:

iMask - the new mask

draw

public boolean draw(FigGraphics iG)

Description copied from interface: Doodle

Renders doodle.

Details: Doodle.draw(FigGraphics) renders this doodle using the supplied graphics environment. When the host FigureView is repainting itself, it will probably call this method, albeit indirectly, to redraw its figure's components. This method returns true if drawing was successful, false otherwise.

Specified by:

draw in interface Doodle

Parameters:

iG - the graphics context

Returns:

true iff drawing was successful

setZOrder

public void setZOrder(float iZOrder)

Description copied from class: FlatDoodle

Updates Z-order property.

Details: FlatDoodle.setZOrder(float) updates the Z-order of this Doodle and instructs views to redraw.

Overrides:

setZOrder in class FlatDoodle

Parameters:

iZOrder - new property value

imageUpdate

public boolean imageUpdate(Image iImage,
                  int iInfoFlags,
                  int iX,
                  int iY,
                  int iW,
                  int iH)

Specified by:

imageUpdate in interface ImageObserver

contains

public boolean contains(AffineTransform iTransform,
               Point2D iP)

Determines whether point is contained in image area.

Details: This method returns true if the given point lies in the image area, false otherwise.

Specified by:

contains in interface Doodle

Parameters:

iTransform - ignored

iP - the point

Returns:

true iff point is contained

getBounds

public Rectangle2D getBounds(AffineTransform iTransform,
                    Rectangle2D oBounds)

Computes rectangular bounds.

Details: This method returns the rectangular bounds of the image area, according to the Shape interface contract.

Specified by:

getBounds in interface Doodle

Parameters:

iTransform - ignored

oBounds - existing instance to write result into

Returns:

the rectangular bounds