org.apache.myfaces.trinidadinternal.image
Interface ImageRenderer

All Known Implementing Classes:
AbstractImageRenderer, ButtonImageRenderer, ColorizedIconImageRenderer, CompositeButtonImageRenderer, FlippedIconImageRenderer, PainterImageRenderer

public interface ImageRenderer

ImageRenderer defines an interface for generated an AWT Image from a set of properties describing the desired image.

Version:
$Name: $ ($Revision: adfrt/faces/adf-faces-impl/src/main/java/oracle/adfinternal/view/faces/image/ImageRenderer.java#0 $) $Date: 10-nov-2005.19:03:56 $
Author:
The Oracle ADF Faces Team

Method Summary
 java.awt.Image renderImage(ImageContext context, java.util.Map<java.lang.Object,java.lang.Object> requestedProperties, java.util.Map<java.lang.Object,java.lang.Object> responseProperties)
          Render and return an image given the dictionary of properties that describe what to render.
 

Method Detail

renderImage

java.awt.Image renderImage(ImageContext context,
                           java.util.Map<java.lang.Object,java.lang.Object> requestedProperties,
                           java.util.Map<java.lang.Object,java.lang.Object> responseProperties)
Render and return an image given the dictionary of properties that describe what to render. In addition to returning the rendered image, the image renderer may store additional properties describing the generated image (such as its width and height) in the provided responseProperties dictionary.

Parameters:
context - The rendering context
requestedProperties - Map of requested properties. The keys for this dictionary are the KEY constants defined in ImageConstants.
responseProperties - Map 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


Copyright © 2001-2007 Apache Software Foundation. All Rights Reserved.