oracle.cabo.image.painter
Class ImagePainter

java.lang.Object
  |
  +--oracle.cabo.image.painter.AbstractPainter
        |
        +--oracle.cabo.image.painter.ImagePainter

All Implemented Interfaces:

Painter

public class ImagePainter

extends AbstractPainter

A painter capable of painting an image.

Field Summary

static int	DONT_SCALE A scaling constant - the image will not be scaled at all.
static int	PRESERVE_ASPECT_RATIO A scaling constant - the image will be scaled, but its aspect ratio will be maintained.
static int	SCALE_TO_FIT A scaling constant - the image is scaled to fit the entire area.

Constructor Summary

ImagePainter()
Creates an ImagePainter object, using the default Image Data Key, scaling the Image to fit the area to be drawn.

ImagePainter(int scalingMode)
Creates an ImagePainter object, using the default Image Data Key and the specified scaling mode.

ImagePainter(java.lang.Object dataKey)
Creates an ImagePainter object, using the specified data key to retrieve its Image from its PaintContext and scaling the image to fit.

ImagePainter(java.lang.Object dataKey, int scalingMode)
Creates an ImagePainter object, using the specified data key to retrieve its Image from its PaintContext and scaling mode to specify how it handles scaling.

Method Summary

protected java.lang.Object	getData(PaintContext context)
protected java.lang.Object	getDataKey()
protected java.awt.Image	getImageData(PaintContext context) Typesafe method to return the Image to Paint.
java.awt.Dimension	getMinimumSize(PaintContext context) Returns the minimum size of the ImagePainter.
boolean	getProgressiveLoading() Returns whether the ImagePainter allows images to be progressively loaded.
boolean	isTransparent(PaintContext context) Returns true if the Painter doesn't paint all of its pixels.
void	paint(PaintContext context, java.awt.Graphics g, int x, int y, int width, int height) Paints the ImagePainter at the given location.
void	setProgressiveLoading(boolean progressive) Sets whether the ImagePainter always forces images to be fully loaded, or whether it allows progressive loading.

Methods inherited from class oracle.cabo.image.painter.AbstractPainter

getPreferredSize

Methods inherited from class java.lang.Object

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

Field Detail

DONT_SCALE

public static final int DONT_SCALE

A scaling constant - the image will not be scaled at all. Use this constant to allow tiling.

PRESERVE_ASPECT_RATIO

public static final int PRESERVE_ASPECT_RATIO

A scaling constant - the image will be scaled, but its aspect ratio will be maintained. The image will be scaled up until it occupies all of one dimension of its area.

SCALE_TO_FIT

public static final int SCALE_TO_FIT

A scaling constant - the image is scaled to fit the entire area. Aspect ratio is not preserved.

Constructor Detail

ImagePainter

public ImagePainter()

Creates an ImagePainter object, using the default Image Data Key, scaling the Image to fit the area to be drawn.

ImagePainter

public ImagePainter(int scalingMode)

Creates an ImagePainter object, using the default Image Data Key and the specified scaling mode.

ImagePainter

public ImagePainter(java.lang.Object dataKey)

Creates an ImagePainter object, using the specified data key to retrieve its Image from its PaintContext and scaling the image to fit.

ImagePainter

public ImagePainter(java.lang.Object dataKey,
                    int scalingMode)

Creates an ImagePainter object, using the specified data key to retrieve its Image from its PaintContext and scaling mode to specify how it handles scaling.

Method Detail

setProgressiveLoading

public void setProgressiveLoading(boolean progressive)

Sets whether the ImagePainter always forces images to be fully loaded, or whether it allows progressive loading. By default, forces images to fully load.

Parameters:

progressive - if true, uses progressive loading

getProgressiveLoading

public boolean getProgressiveLoading()

Returns whether the ImagePainter allows images to be progressively loaded.

getMinimumSize

public java.awt.Dimension getMinimumSize(PaintContext context)

Returns the minimum size of the ImagePainter.

Parameters:

context - Context for determining the minimum size.

Returns:

The minimum size of the Painter.

paint

public void paint(PaintContext context,
                  java.awt.Graphics g,
                  int x,
                  int y,
                  int width,
                  int height)

Paints the ImagePainter at the given location.

Parameters:

context - Context for painting.

g - Graphics object to draw into.

x - X position to draw at.

y - Y position to draw at.

width - Width to draw into.

height - Height to draw into.

isTransparent

public boolean isTransparent(PaintContext context)

Returns true if the Painter doesn't paint all of its pixels.

Parameters:

context - Context for determining transparency.

Returns:

True if the Painter is transparent.

getImageData

protected java.awt.Image getImageData(PaintContext context)

Typesafe method to return the Image to Paint. Subclasses that do not use data keys to retrieve their data should override this method, rather than getData(), as overriding getImageData() directly is more efficient.

Parameters:

context - PaintContext to use to retrieve the TextPainter's Image data.

Returns:

The Image to paint.

See Also:

getData(oracle.cabo.image.painter.PaintContext)

getDataKey

protected java.lang.Object getDataKey()

Overrides:

getDataKey in class AbstractPainter

getData

protected java.lang.Object getData(PaintContext context)

Overrides:

getData in class AbstractPainter