org.jmol.image

Class ImageEncoder

java.lang.Object

org.jmol.image.ImageEncoder

All Implemented Interfaces:

JmolImageEncoder

Direct Known Subclasses:

CRCEncoder, GifEncoder, JpgEncoder, PdfEncoder, PpmEncoder

public abstract class ImageEncoder
extends Object
implements JmolImageEncoder

Generic abstract image creator: (1) set parameters (2) encode the image bytes, if necessary (3) generate the image

Author:

Bob Hanson hansonr@stolaf.edu

Field Summary

Fields

Modifier and Type	Field and Description
protected String	date
protected String[]	errRet
protected int	height
protected javajs.util.OC	out
protected int[]	pixels
protected int	quality
protected int	width

Constructor Summary

Constructors

Constructor and Description
ImageEncoder()

Method Summary

Modifier and Type	Method and Description
protected void	close()
boolean	createImage(javajs.api.GenericPlatform apiPlatform, String type, Object objImage, javajs.util.OC out, Map<String,Object> params, String[] errRet)
protected void	encodeImage(javajs.api.GenericPlatform apiPlatform, Object objImage)
protected abstract void	generate()
protected void	putByte(int b)
protected void	putString(String str)
protected abstract void	setParams(Map<String,Object> params)

Methods inherited from class java.lang.Object

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

Field Detail

out

protected javajs.util.OC out

width

protected int width

height

protected int height

quality

protected int quality

date

protected String date

errRet

protected String[] errRet

pixels

protected int[] pixels

Constructor Detail

ImageEncoder

public ImageEncoder()

Method Detail

createImage

public boolean createImage(javajs.api.GenericPlatform apiPlatform,
                           String type,
                           Object objImage,
                           javajs.util.OC out,
                           Map<String,Object> params,
                           String[] errRet)

Specified by:

createImage in interface JmolImageEncoder

Parameters:

apiPlatform -

type -

objImage -

out -

params -

errRet -

Returns:

true if successful

setParams

protected abstract void setParams(Map<String,Object> params)

generate

protected abstract void generate()
                          throws Exception

Throws:

Exception

encodeImage

protected void encodeImage(javajs.api.GenericPlatform apiPlatform,
                           Object objImage)
                    throws Exception

Throws:

Exception

putString

protected void putString(String str)

putByte

protected void putByte(int b)

close

protected void close()