com.microej.tool.ui.generator

Interface ImageConverter

public interface ImageConverter

An implementation of this interface is required to convert an image is a format not managed by MicroUI (custom ouput format different than MicroUI Image RAW formats).

The resulted image is not compatible with MicroUI Image API but it can be used by custom MicroUI extensions.

Method Summary

Modifier and Type	Method and Description
boolean	generate(Image image, OutputStream stream) Converts the given image in the given output stream.
String	getOutputFileExtension() Returns the file extension to apply as suffix for the converted images.

Method Detail

generate

boolean generate(Image image,
                 OutputStream stream)
          throws IOException

Converts the given image in the given output stream.

If this method returns true, the image is considered as encoded even if no byte has been written into the output stream. In this case the final file size is 0.

If this method returns false, the image is not considered as encoded even if some bytes have been written into the output stream. In this case the written bytes are lost.

Parameters:

image - the image to convert

stream - the output stream where write the encoded image.

Returns:

true when the image has been converted.

Throws:

IOException

getOutputFileExtension

String getOutputFileExtension()

Returns the file extension to apply as suffix for the converted images. At runtime, the converted image can be retrieved using the image classpath relative path (with its extension, for instance ".png") + this extension.

Returns:

the output file extension