oracle.cabo.image
Class PainterImageRenderer

java.lang.Object
  |
  +--oracle.cabo.image.AbstractImageRenderer
        |
        +--oracle.cabo.image.PainterImageRenderer

All Implemented Interfaces:

ImageConstants, java.awt.image.ImageObserver, ImageRenderer

Direct Known Subclasses:

ButtonImageRenderer, GlobalButtonImageRenderer, TabBarImageRenderer

public class PainterImageRenderer

extends AbstractImageRenderer

implements ImageConstants

ImageRenderer implementation that uses Painter objects to render an image. Clients must provide a Painter object in the constructor.

The PainterImageRenderer creates a PaintContext object in response to a call to renderImage(). The PaintContext object will obtain all its data about the state of the BufferedImage by using the Dictionary of properties. Clients should set the properties in the Dictionary using the given key constants described below.

Clients can pass custom properties by using their own key objects.

Fields inherited from interface oracle.cabo.image.ImageConstants

ACCESS_KEY_KEY, BACKGROUND_KEY, BORDER_COLOR_KEY, BUTTON_NAME, COLORIZED_ICON_NAME, DARK_ACCENT_COLOR_KEY, DARK_COLOR_KEY, DIRECTION_KEY, DISABLED_BACKGROUND_KEY, DISABLED_FONT_KEY, DISABLED_FOREGROUND_KEY, DISABLED_KEY, ENCODING_TYPE_KEY, END_ROUNDED_KEY, FLIPPED_ICON_NAME, FONT_KEY, FOREGROUND_KEY, GLOBAL_BUTTON_NAME, HEIGHT_RESPONSE_KEY, IMAGE_MAP_AREAS_RESPONSE_KEY, IMAGE_PROVIDER_PROPERTY, IMAGE_TYPE_MANAGER_PROPERTY, LAF_KEY, NAME_KEY, SELECTED_BACKGROUND_KEY, SELECTED_FONT_KEY, SELECTED_FOREGROUND_KEY, SELECTED_INDEX_KEY, SELECTED_KEY, SERVLET_URL_PROPERTY, SOURCE_INPUT_STREAM_PROVIDER_KEY, SOURCE_KEY, START_ROUNDED_KEY, SURROUNDING_COLOR_KEY, TAB_BAR_NAME, TABS_KEY, TECATE_NAMESPACE, TEXT_ANTIALIAS_KEY, TEXT_KEY, WIDTH_RESPONSE_KEY

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

protected

PainterImageRenderer(Painter painter) Create a PainterImageRenderer that uses the given Painter to create a BufferedImage.

Method Summary

protected PaintContext	createPaintContext(ImageContext imageContext, java.awt.image.BufferedImage image, java.util.Dictionary requestedProperties, java.util.Dictionary responseProperties)
protected void	disposePaintContext(PaintContext context)
protected java.awt.Color	getPaintBackground(ImageContext context, java.util.Dictionary d) Returns the background color to use when painting an image with the specified dictionary.
protected java.lang.Object	getPaintData(java.lang.Object key, java.util.Dictionary d)
Painter	getPainter() Get the Painter used to create the image.
protected Painter	getPainter(ImageContext imageContext, java.util.Dictionary requestedProperties) Returns the Painter to use for the specified request.
protected java.awt.Font	getPaintFont(java.util.Dictionary d) Returns the font color to use when painting an image with the specified dictionary.
protected java.awt.Color	getPaintForeground(ImageContext context, java.util.Dictionary d) Returns the foreground color to use when painting an image with the specified dictionary.
protected boolean	isRenderable(ImageContext imageContext, java.util.Dictionary requestedProperties) Tests whether the requested image can be rendered.
java.awt.Image	renderImage(ImageContext imageContext, java.util.Dictionary requestedProperties, java.util.Dictionary responseProperties) Render the image given the Dictionary of properties that describe what to render.

Methods inherited from class oracle.cabo.image.AbstractImageRenderer

createImage, imageUpdate

Methods inherited from class java.lang.Object

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

Constructor Detail

PainterImageRenderer

protected PainterImageRenderer(Painter painter)

Create a PainterImageRenderer that uses the given Painter to create a BufferedImage.

Method Detail

getPainter

public Painter getPainter()

Get the Painter used to create the image.

renderImage

public java.awt.Image renderImage(ImageContext imageContext,
                                  java.util.Dictionary requestedProperties,
                                  java.util.Dictionary responseProperties)

Render the image given the Dictionary of properties that describe what to render. A PaintContext object is created using the given Dictionary of properties.

Overrides:

renderImage in class AbstractImageRenderer

Following copied from interface: oracle.cabo.image.ImageRenderer

Parameters:

context - The rendering context

requestedProperties - Dictionary of requested properties. The keys for this dictionary are the KEY constants defined in ImageConstants.

responseProperties - Dictionary for response properties. The keys for this dictionary are the RESPONSE_KEY constants defined in ImageConstants.

Returns:

an Image containing the rendered results

See Also:

ImageContext, ImageConstants

getPainter

protected Painter getPainter(ImageContext imageContext,
                             java.util.Dictionary requestedProperties)

Returns the Painter to use for the specified request.

isRenderable

protected boolean isRenderable(ImageContext imageContext,
                               java.util.Dictionary requestedProperties)

Tests whether the requested image can be rendered. The default implementation of isRenderable() returns false if oracle.cabo.style.util.GraphicsUtils.isGraphicalEnvironment() returns false. Subclasses can override this to verify that all required properties are present in the requested properties dictionary. All overrides must either call super.isRenderable() or GraphicsUtils.isGraphicalEnvironment() to ensure that a graphical environment is available.

getPaintForeground

protected java.awt.Color getPaintForeground(ImageContext context,
                                            java.util.Dictionary d)

Returns the foreground color to use when painting an image with the specified dictionary.

getPaintBackground

protected java.awt.Color getPaintBackground(ImageContext context,
                                            java.util.Dictionary d)

Returns the background color to use when painting an image with the specified dictionary.

getPaintFont

protected java.awt.Font getPaintFont(java.util.Dictionary d)

Returns the font color to use when painting an image with the specified dictionary.

getPaintData

protected java.lang.Object getPaintData(java.lang.Object key,
                                        java.util.Dictionary d)

createPaintContext

protected PaintContext createPaintContext(ImageContext imageContext,
                                          java.awt.image.BufferedImage image,
                                          java.util.Dictionary requestedProperties,
                                          java.util.Dictionary responseProperties)

disposePaintContext

protected void disposePaintContext(PaintContext context)