nextapp.echoservlet.image
Class ImagePeer

java.lang.Object
  nextapp.echoservlet.image.ImagePeer

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

AwtImagePeer, HttpImagePeer, ResourceImagePeer, StreamImagePeer

public abstract class ImagePeer
extends java.lang.Object
implements java.io.Serializable

A base class from which all image peers are derived.

See Also:

Serialized Form

Constructor Summary

ImagePeer()
Default constructor.

Method Summary

abstract Service	getAncillaryService() Returns the ancillary service used for rendering this image on the client.
ImageReference	getImageReference() Returns the underlying image reference.
abstract java.lang.String	getUri(Connection conn) Returns the URI required to reference this image from a document rendered by the given Connection.
void	registered() Called to notify the image peer that it has been registered to an image.
void	setId(Id id) Sets the identifier for the ancillary service if one is required.

Methods inherited from class java.lang.Object

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

Constructor Detail

ImagePeer

public ImagePeer()

Default constructor.

Method Detail

getAncillaryService

public abstract Service getAncillaryService()

Returns the ancillary service used for rendering this image on the client. Returns null if no ancillary service is required.

Returns:

The ancillary service used for rendering this image on the client.

getImageReference

public ImageReference getImageReference()

Returns the underlying image reference.

Returns:

The underlying image reference.

getUri

public abstract java.lang.String getUri(Connection conn)

Returns the URI required to reference this image from a document rendered by the given Connection.

Parameters:

conn - The connection that is rendering the document that references the image.

Returns:

The URI of the image.

registered

public void registered()

Called to notify the image peer that it has been registered to an image. This method should be overridden when notification of registration is required.

setId

public void setId(Id id)

Sets the identifier for the ancillary service if one is required.

Parameters:

id - The identifier for the ancillary service.