com.klg.jclass.util.swing.encode
Class JCEncodeComponent

java.lang.Object
  |
  +--com.klg.jclass.util.swing.encode.JCEncodeComponent

public class JCEncodeComponent

extends Object

This class allows for the creation of images of Java components and the encoding of images in several graphics formats (such as PNG or JPEG). It is used to output any AWT or Swing component (including JClass components) or Image class to a file or output stream. The image formats supported are:

GIF

Only enabled if user has a GIF output license from Unisys.

PNG

Portable Network Graphics format.

JPEG

Joint Photographic Experts Group format.

EPS

Encapsulated PostScript format. Requires JClass PageLayout.

PDF

Acrobat Portable Document format. Requires JClass PageLayout.

PS

PostScript Level 2 format. Requires JClass PageLayout.

PCL

Hewlett-Packard Page Control Language version 5. Requires JClass PageLayout.

Nested Class Summary

static class

JCEncodeComponent.Encoding Class used to enumerate valid encoding formats.

Field Summary

protected static String	bundleName
static JCEncodeComponent.Encoding[]	ENCODINGS Client side encodings.
static JCEncodeComponent.Encoding	EPS Specifies EPS encoding.
static JCEncodeComponent.Encoding	GIF Specifies GIF encoding.
static JCEncodeComponent.Encoding[]	IMAGE_ENCODINGS Imagebased encodings.
static JCEncodeComponent.Encoding	JPEG Specifies JPEG encoding.
static JCEncodeComponent.Encoding	PCL Specifies PCL encoding.
static JCEncodeComponent.Encoding	PDF Specifies PDF encoding.
static JCEncodeComponent.Encoding	PNG Specifies PNG encoding.
static JCEncodeComponent.Encoding	PS Specifies PS encoding.
static JCEncodeComponent.Encoding[]	SERVER_ENCODINGS Server side encodings.
static JCEncodeComponent.Encoding	SVG Specifies SVG Encoding.
static JCEncodeComponent.Encoding	SWF Specifies SWF Encoding.

Constructor Summary

JCEncodeComponent()

Method Summary

static void	encode(JCEncodeComponent.Encoding encoding, Component component, File file) Encodes the image of a Java component to a file.
static void	encode(JCEncodeComponent.Encoding encoding, Component component, OutputStream output) Encodes the image of a Java component to an output stream.
static void	encode(JCEncodeComponent.Encoding encoding, Image image, File file) Encodes an image to a file.
static void	encode(JCEncodeComponent.Encoding encoding, Image image, OutputStream output) Encodes an image to an output stream.
static com.klg.jclass.util.swing.encode.Encoder	findEncoder(JCEncodeComponent.Encoding encoding, boolean throwDialog) Finds the encoder class for the specified encoding.
static boolean	isImageBasedEncoding(JCEncodeComponent.Encoding enc) Checks if encoding type is image based.

Methods inherited from class java.lang.Object

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

Field Detail

GIF

public static final JCEncodeComponent.Encoding GIF

Specifies GIF encoding.

PNG

public static final JCEncodeComponent.Encoding PNG

Specifies PNG encoding.

SVG

public static final JCEncodeComponent.Encoding SVG

Specifies SVG Encoding.

SWF

public static final JCEncodeComponent.Encoding SWF

Specifies SWF Encoding.

JPEG

public static final JCEncodeComponent.Encoding JPEG

Specifies JPEG encoding.

EPS

public static final JCEncodeComponent.Encoding EPS

Specifies EPS encoding.

PCL

public static final JCEncodeComponent.Encoding PCL

Specifies PCL encoding.

PDF

public static final JCEncodeComponent.Encoding PDF

Specifies PDF encoding.

PS

public static final JCEncodeComponent.Encoding PS

Specifies PS encoding.

ENCODINGS

public static final JCEncodeComponent.Encoding[] ENCODINGS

Client side encodings.

SERVER_ENCODINGS

public static final JCEncodeComponent.Encoding[] SERVER_ENCODINGS

Server side encodings.

IMAGE_ENCODINGS

public static final JCEncodeComponent.Encoding[] IMAGE_ENCODINGS

Imagebased encodings.

bundleName

protected static String bundleName

Constructor Detail

JCEncodeComponent

public JCEncodeComponent()

Method Detail

encode

public static void encode(JCEncodeComponent.Encoding encoding,
                          Component component,
                          OutputStream output)
                   throws IOException,
                          EncoderException

Encodes the image of a Java component to an output stream. Can be used with any AWT or Swing component (including JClass components). See above for details on supported image formats.

Parameters:

encoding - image format to encode to (GIF, PNG, JPEG, EPS, PS, PDF, or PCL)

component - component to encode

output - stream to which to write the encoding

Throws:

IOException

EncoderException

encode

public static void encode(JCEncodeComponent.Encoding encoding,
                          Component component,
                          File file)
                   throws IOException,
                          EncoderException

Encodes the image of a Java component to a file. Can be used with any AWT or Swing component (including JClass components). See above for details on supported image formats.

Parameters:

encoding - image format to encode to (GIF, PNG, JPEG, EPS, PS, PDF, or PCL)

component - component to encode

file - file to which to write the encoding

Throws:

IOException

EncoderException

encode

public static void encode(JCEncodeComponent.Encoding encoding,
                          Image image,
                          OutputStream output)
                   throws IOException,
                          EncoderException

Encodes an image to an output stream.

Parameters:

encoding - image format to encode to (GIF, PNG, JPEG, EPS, PS, PDF, or PCL)

image - image to encode

output - stream to which to write the encoding

Throws:

IOException

EncoderException

encode

public static void encode(JCEncodeComponent.Encoding encoding,
                          Image image,
                          File file)
                   throws IOException,
                          EncoderException

Encodes an image to a file.

Parameters:

encoding - image format to encode to (GIF, PNG, JPEG, EPS, PS, PDF, or PCL)

image - image to encode

file - file to which to write the encoding

Throws:

IOException

EncoderException

findEncoder

public static com.klg.jclass.util.swing.encode.Encoder findEncoder(JCEncodeComponent.Encoding encoding,
                                                                   boolean throwDialog)
                                                            throws IOException,
                                                                   EncoderException

Finds the encoder class for the specified encoding.

Parameters:

encoding - image format to encode to (GIF, PNG, JPEG, EPS, PS, PDF, or PCL)

throwDialog - true is error dialog is to be shown in case of error; false if no dialog is to be shown

Returns:

encoder class for this encoding

Throws:

IOException

EncoderException

isImageBasedEncoding

public static boolean isImageBasedEncoding(JCEncodeComponent.Encoding enc)

Checks if encoding type is image based. An image based encoding type must encode from an image. Examples are PNG, GIF and JPEG.

Parameters:

enc -

Returns: