nextapp.echo2.webcontainer.image
Interface ImageRenderSupport

All Known Implementing Classes:

ButtonPeer, ColumnPeer, ContentPanePeer, GridPeer, LabelPeer, RowPeer, SplitPanePeer, TablePeer, TextAreaPeer, TextComponentPeer, TextFieldPeer, WindowPanePeer

public interface ImageRenderSupport

An optional interface which may be implemented by ComponentSynchronizePeers to render images via the ImageRenderService.

Method Summary

ImageReference

getImage(Component component, java.lang.String imageId) Retrieves the image identified by the given imageId value for the given Component.

Method Detail

getImage

ImageReference getImage(Component component,
                        java.lang.String imageId)

Retrieves the image identified by the given imageId value for the given Component.

Note: A reference to any images to be rendered must be maintained throughout the rendering process, due to the fact that the image rendering subsystem creates a weak-keyed cache of images to be rendered. This method therefore may not simply return a new, otherwise-unreferenced image. In the event that this presents a problem, the recommended workaround is to simply store such otherwise unreferenced ImageReferences using a RenderState object.

Parameters:

component - the component

imageId - the id of the image

Returns:

the target image