| com.salmonllc.html.ImageGenerator
All known Subclasses: com.salmonllc.html.HtmlSubmitImage, com.salmonllc.jsp.JspDataTable, com.salmonllc.html.HtmlDataTable, com.salmonllc.jsp.JspList, com.salmonllc.html.HtmlImage,
ImageGenerator | public interface ImageGenerator (Code) | | This interface is implemented by components that dynamically generate gif images that are sent back to the browser.
The implementing class can use the ImageFactory and GifEncoder to generate an image. The generated images will be served up
and cached by the ObjectStore servlet (Any Image with a dgif extension).
See Also: com See Also: com.salmonllc.util.ImageFactory See Also: com See Also: com.salmonllc.util.GifEncoder |
Method Summary | |
public void | generateImage(String imageName, OutputStream out) This method should be implemented by any class that generates an image. | public long | getCacheKey() This method is called by the Objectstore servlet to decide whether or not an image should be regenerated or loaded from cache. | public boolean | getUseCache() This method is called by the Objectstore servlet to decide whether or not to cache generated images. | public void | setCacheKey(long key) This method is used by the framework to decide whether or not to generate the image or get it from cache. |
generateImage | public void generateImage(String imageName, OutputStream out) throws IOException(Code) | | This method should be implemented by any class that generates an image. The implementing class is responsible for actually generating
an image based on the name passed
Parameters: imageName - Each implementing class can decide for itself what image to generate based on the passed name. Parameters: out - The output stream to write the generated image to |
getCacheKey | public long getCacheKey()(Code) | | This method is called by the Objectstore servlet to decide whether or not an image should be regenerated or loaded from cache. It should return the value set in the setCacheKey method.
|
getUseCache | public boolean getUseCache()(Code) | | This method is called by the Objectstore servlet to decide whether or not to cache generated images.
|
setCacheKey | public void setCacheKey(long key)(Code) | | This method is used by the framework to decide whether or not to generate the image or get it from cache. The implementing class should store the passed value in an instance variable.
|
|
|