Modifier and Type	Class and Description
pack-priv abstract static class	ImageUtil.AbstractFastScaler
pack-priv static class	ImageUtil.AreaAverageScaler AWT-style one-step scaling, using area averaging
pack-priv static class	ImageUtil.FastScaler Fast but decent scaling
pack-priv static class	ImageUtil.HighQualityScaler Step-wise downscaling
pack-priv static class	ImageUtil.OldScaler Old AWT-style scaling, poor quality
pack-priv static interface	ImageUtil.Scaler

Modifier and Type	Field and Description
private static final Map<DownscaleQuality, ImageUtil.Scaler>	qual
private static final Pattern	WHITE_SPACE

Access	Constructor and Description
public	ImageUtil()

Method Summary

Modifier and Type	Method and Description
public static BufferedImage	Returns: BufferedImage with same content. convertToBufferedImage(Image image to convert; if already a BufferedImage, returned unmodified awtImg, int the type of BufferedImage to create; see `java.awt.image.BufferedImage#BufferedImage(int, int, int)` type) Utility method to convert an AWT Image to a BufferedImage.
public static BufferedImage	Returns: A BufferedImage compatible with the screen (best fit). createCompatibleBufferedImage(int Target width for the image width, int Target height for the image height, int Value from the `java.awt.image.BufferedImage` class; see docs for `java.awt.image.BufferedImage#BufferedImage(int, int, int)`. The actual type used will be the type specified in this parameter, if in headless mode, or the type most compatible with the screen, if in non-headless more. biType) Helper method to instantiate new BufferedImages; if the graphics environment is actually connected to real screen devices (e.g. not in headless mode), the image will be compatible with the screen device allowing for best performance.
public static BufferedImage	createTransparentImage(int width, int height)
public static byte[]	fromBase64Encoded(String b64encoded)
public static byte[]	Returns: The binary content getEmbeddedBase64Image(String URI of the embedded image imageDataUri) Get the binary content of an embedded base 64 image.
private static GraphicsConfiguration	getGraphicsConfiguration()
public static BufferedImage	Returns: The scaled image instance. getScaledInstance(ScalingOptions opt, BufferedImage The image to scale orgImage) Scales an image to the requested width and height, assuming these are both >= 1; size given in pixels.
public static BufferedImage	Returns: The scaled image instance. getScaledInstance(BufferedImage The image to scale orgImage, int The target width in pixels targetWidth, int The target height in pixels targetHeight) Scales an image to the requested width and height, assuming these are both >= 1; size given in pixels.
public static BufferedImage	makeCompatible(BufferedImage bimg)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

qual	back to summary
private static final Map<DownscaleQuality, ImageUtil.Scaler> qual

WHITE_SPACE	back to summary
private static final Pattern WHITE_SPACE

Constructor Detail

ImageUtil	back to summary
public ImageUtil()

Method Detail

convertToBufferedImage back to summary

convertToBufferedImage	back to summary
public static BufferedImage convertToBufferedImage(Image awtImg, int type) Utility method to convert an AWT Image to a BufferedImage. Size is preserved, BufferedImage is compatible with current display device. Parameters awtImg:Image image to convert; if already a BufferedImage, returned unmodified type:int the type of BufferedImage to create; see `java.awt.image.BufferedImage#BufferedImage(int, int, int)` Returns:BufferedImage BufferedImage with same content.

public static BufferedImage convertToBufferedImage(Image awtImg, int type)

Utility method to convert an AWT Image to a BufferedImage. Size is preserved, BufferedImage is compatible with current display device.

Parameters

awtImg:Image: image to convert; if already a BufferedImage, returned unmodified
type:int: the type of BufferedImage to create; see java.awt.image.BufferedImage#BufferedImage(int, int, int)

Returns:BufferedImage

BufferedImage with same content.

createCompatibleBufferedImage back to summary

createCompatibleBufferedImage	back to summary
public static BufferedImage createCompatibleBufferedImage(int width, int height, int biType) Helper method to instantiate new BufferedImages; if the graphics environment is actually connected to real screen devices (e.g. not in headless mode), the image will be compatible with the screen device allowing for best performance. In a headless environment, simply creates a new BufferedImage. For non-headless environments, this just sets up and calls `java.awt.GraphicsConfiguration#createCompatibleImage(int, int, int)`. The image will not have anything drawn to it, not even a white background; you must do this yourself. Parameters width:int Target width for the image height:int Target height for the image biType:int Value from the `java.awt.image.BufferedImage` class; see docs for `java.awt.image.BufferedImage#BufferedImage(int, int, int)`. The actual type used will be the type specified in this parameter, if in headless mode, or the type most compatible with the screen, if in non-headless more. Returns:BufferedImage A BufferedImage compatible with the screen (best fit).

public static BufferedImage createCompatibleBufferedImage(int width, int height, int biType)

Helper method to instantiate new BufferedImages; if the graphics environment is actually connected to real screen devices (e.g. not in headless mode), the image will be compatible with the screen device allowing for best performance. In a headless environment, simply creates a new BufferedImage. For non-headless environments, this just sets up and calls java.awt.GraphicsConfiguration#createCompatibleImage(int, int, int). The image will not have anything drawn to it, not even a white background; you must do this yourself.

Parameters

width:int: Target width for the image
height:int: Target height for the image
biType:int: Value from the java.awt.image.BufferedImage class; see docs for java.awt.image.BufferedImage#BufferedImage(int, int, int). The actual type used will be the type specified in this parameter, if in headless mode, or the type most compatible with the screen, if in non-headless more.

Returns:BufferedImage

A BufferedImage compatible with the screen (best fit).

createTransparentImage	back to summary
public static BufferedImage createTransparentImage(int width, int height)

fromBase64Encoded	back to summary
public static byte[] fromBase64Encoded(String b64encoded)

getEmbeddedBase64Image	back to summary
public static byte[] getEmbeddedBase64Image(String imageDataUri) Get the binary content of an embedded base 64 image. Parameters imageDataUri:String URI of the embedded image Returns:byte[] The binary content

getEmbeddedBase64Image

back to summary

public static byte[] getEmbeddedBase64Image(String imageDataUri)

Get the binary content of an embedded base 64 image.

Parameters

imageDataUri:String: URI of the embedded image

Returns:byte[]

The binary content

getGraphicsConfiguration	back to summary
private static GraphicsConfiguration getGraphicsConfiguration()

getScaledInstance back to summary

getScaledInstance	back to summary
public static BufferedImage getScaledInstance(ScalingOptions opt, BufferedImage orgImage) Scales an image to the requested width and height, assuming these are both >= 1; size given in pixels. If either width or height is <=0, the current image width or height will be used. This method assumes that, at the moment the method is called, the width and height of the image are available; it won't wait for them. Therefore, the method should be called once the image has completely loaded and not before. Override this method in a subclass to optimize image scaling operations; note that the legacy `java.awt.Image#getScaledInstance(int, int, int)` is considered to perform poorly compared to more recent developed techniques. For a discussion of the options from a member of the Java2D team, see http://today.java.net/pub/a/today/2007/04/03/perils-of-image-getscaledinstance.html Parameters orgImage:BufferedImage The image to scale Returns:BufferedImage The scaled image instance.

public static BufferedImage getScaledInstance(ScalingOptions opt, BufferedImage orgImage)

Scales an image to the requested width and height, assuming these are both >= 1; size given in pixels. If either width or height is <=0, the current image width or height will be used. This method assumes that, at the moment the method is called, the width and height of the image are available; it won't wait for them. Therefore, the method should be called once the image has completely loaded and not before.
Override this method in a subclass to optimize image scaling operations; note that the legacy java.awt.Image#getScaledInstance(int, int, int) is considered to perform poorly compared to more recent developed techniques.
For a discussion of the options from a member of the Java2D team, see http://today.java.net/pub/a/today/2007/04/03/perils-of-image-getscaledinstance.html

Parameters

orgImage:BufferedImage: The image to scale

Returns:BufferedImage

The scaled image instance.

getScaledInstance back to summary

getScaledInstance	back to summary
public static BufferedImage getScaledInstance(BufferedImage orgImage, int targetWidth, int targetHeight) Scales an image to the requested width and height, assuming these are both >= 1; size given in pixels. If either width or height is <=0, the current image width or height will be used. This method assumes y that, at the moment the method is called, the width and height of the image are available; it won't wait for them. Therefore, the method should be called once the image has completely loaded and not before. Override this method in a subclass to optimize image scaling operations; note that the legacy `java.awt.Image#getScaledInstance(int, int, int)` is considered to perform poorly compared to more recent developed techniques. For a discussion of the options from a member of the Java2D team, see http://today.java.net/pub/a/today/2007/04/03/perils-of-image-getscaledinstance.html Parameters orgImage:BufferedImage The image to scale targetWidth:int The target width in pixels targetHeight:int The target height in pixels Returns:BufferedImage The scaled image instance.

public static BufferedImage getScaledInstance(BufferedImage orgImage, int targetWidth, int targetHeight)

Scales an image to the requested width and height, assuming these are both >= 1; size given in pixels. If either width or height is <=0, the current image width or height will be used. This method assumes y that, at the moment the method is called, the width and height of the image are available; it won't wait for them. Therefore, the method should be called once the image has completely loaded and not before.
Override this method in a subclass to optimize image scaling operations; note that the legacy java.awt.Image#getScaledInstance(int, int, int) is considered to perform poorly compared to more recent developed techniques.
For a discussion of the options from a member of the Java2D team, see http://today.java.net/pub/a/today/2007/04/03/perils-of-image-getscaledinstance.html

Parameters

orgImage:BufferedImage: The image to scale
targetWidth:int: The target width in pixels
targetHeight:int: The target height in pixels

Returns:BufferedImage

The scaled image instance.

makeCompatible	back to summary
public static BufferedImage makeCompatible(BufferedImage bimg)

com.openhtmltopdf.util back to summary

pack-priv abstract Class ImageUtil.AbstractFastScaler

Class Inheritance

extends Object
implements Scaler

java.lang.Object
com.openhtmltopdf.util.ImageUtil.AbstractFastScaler

All Implemented Interfaces

com.openhtmltopdf.util.ImageUtil.Scaler

Known Direct Subclasses

com.openhtmltopdf.util.ImageUtil.OldScaler, com.openhtmltopdf.util.ImageUtil.AreaAverageScaler

Constructor Summary

Access	Constructor and Description
pack-priv	AbstractFastScaler()

Method Summary

Modifier and Type	Method and Description
protected abstract int	getImageScalingMethod()
public BufferedImage	getScaledInstance(BufferedImage the original image to be scaled img, ScalingOptions options opt) Implements com.openhtmltopdf.util.ImageUtil.Scaler.getScaledInstance. Convenience method that returns a scaled instance of the provided `BufferedImage`, taken from article on java.net by Chris Campbell http://today.java.net/pub/a/today/2007/04/03/perils-of-image-getscaledinstance.html.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

AbstractFastScaler	back to summary
pack-priv AbstractFastScaler()

Method Detail

getImageScalingMethod	back to summary
protected abstract int getImageScalingMethod()

getScaledInstance back to summary

getScaledInstance	back to summary
public BufferedImage getScaledInstance(BufferedImage img, ScalingOptions opt) Implements com.openhtmltopdf.util.ImageUtil.Scaler.getScaledInstance. Doc from com.openhtmltopdf.util.ImageUtil.Scaler.getScaledInstance. Convenience method that returns a scaled instance of the provided `BufferedImage`, taken from article on java.net by Chris Campbell http://today.java.net/pub/a/today/2007/04/03/perils-of-image-getscaledinstance.html. Expects the image to be fully loaded (e.g. no need to wait for loading on requesting height or width. Parameters img:BufferedImage the original image to be scaled opt:ScalingOptions options Returns:BufferedImage a scaled version of the original `BufferedImage`

public BufferedImage getScaledInstance(BufferedImage img, ScalingOptions opt)

Implements com.openhtmltopdf.util.ImageUtil.Scaler.getScaledInstance.

Doc from com.openhtmltopdf.util.ImageUtil.Scaler.getScaledInstance.

Convenience method that returns a scaled instance of the provided BufferedImage, taken from article on java.net by Chris Campbell http://today.java.net/pub/a/today/2007/04/03/perils-of-image-getscaledinstance.html. Expects the image to be fully loaded (e.g. no need to wait for loading on requesting height or width.

Parameters

img:BufferedImage: the original image to be scaled
opt:ScalingOptions: options

Returns:BufferedImage

a scaled version of the original BufferedImage

Access	Constructor and Description
pack-priv	AreaAverageScaler()

Modifier and Type	Method and Description
protected int	getImageScalingMethod() Implements abstract com.openhtmltopdf.util.ImageUtil.AbstractFastScaler.getImageScalingMethod.

AreaAverageScaler	back to summary
pack-priv AreaAverageScaler()

getImageScalingMethod	back to summary
protected int getImageScalingMethod() Implements abstract com.openhtmltopdf.util.ImageUtil.AbstractFastScaler.getImageScalingMethod.

com.openhtmltopdf.util back to summary

pack-priv Class ImageUtil.FastScaler

Class Inheritance

extends Object
implements Scaler

java.lang.Object
com.openhtmltopdf.util.ImageUtil.FastScaler

All Implemented Interfaces

com.openhtmltopdf.util.ImageUtil.Scaler

Fast but decent scaling

Constructor Summary

Access	Constructor and Description
pack-priv	FastScaler()

Method Summary

Modifier and Type	Method and Description
public BufferedImage	getScaledInstance(BufferedImage the original image to be scaled img, ScalingOptions options opt) Implements com.openhtmltopdf.util.ImageUtil.Scaler.getScaledInstance. Convenience method that returns a scaled instance of the provided `BufferedImage`, taken from article on java.net by Chris Campbell http://today.java.net/pub/a/today/2007/04/03/perils-of-image-getscaledinstance.html.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

FastScaler	back to summary
pack-priv FastScaler()

Method Detail

getScaledInstance back to summary

getScaledInstance	back to summary
public BufferedImage getScaledInstance(BufferedImage img, ScalingOptions opt) Implements com.openhtmltopdf.util.ImageUtil.Scaler.getScaledInstance. Doc from com.openhtmltopdf.util.ImageUtil.Scaler.getScaledInstance. Convenience method that returns a scaled instance of the provided `BufferedImage`, taken from article on java.net by Chris Campbell http://today.java.net/pub/a/today/2007/04/03/perils-of-image-getscaledinstance.html. Expects the image to be fully loaded (e.g. no need to wait for loading on requesting height or width. Parameters img:BufferedImage the original image to be scaled opt:ScalingOptions options Returns:BufferedImage a scaled version of the original `BufferedImage`

public BufferedImage getScaledInstance(BufferedImage img, ScalingOptions opt)

Implements com.openhtmltopdf.util.ImageUtil.Scaler.getScaledInstance.

Doc from com.openhtmltopdf.util.ImageUtil.Scaler.getScaledInstance.

Parameters

img:BufferedImage: the original image to be scaled
opt:ScalingOptions: options

Returns:BufferedImage

a scaled version of the original BufferedImage

com.openhtmltopdf.util back to summary

pack-priv Class ImageUtil.HighQualityScaler

Class Inheritance

extends Object
implements Scaler

java.lang.Object
com.openhtmltopdf.util.ImageUtil.HighQualityScaler

All Implemented Interfaces

com.openhtmltopdf.util.ImageUtil.Scaler

Step-wise downscaling

Constructor Summary

Access	Constructor and Description
pack-priv	HighQualityScaler()

Method Summary

Modifier and Type	Method and Description
public BufferedImage	getScaledInstance(BufferedImage the original image to be scaled img, ScalingOptions options opt) Implements com.openhtmltopdf.util.ImageUtil.Scaler.getScaledInstance. Convenience method that returns a scaled instance of the provided `BufferedImage`, taken from article on java.net by Chris Campbell http://today.java.net/pub/a/today/2007/04/03/perils-of-image-getscaledinstance.html.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

HighQualityScaler	back to summary
pack-priv HighQualityScaler()

Method Detail

getScaledInstance back to summary

getScaledInstance	back to summary
public BufferedImage getScaledInstance(BufferedImage img, ScalingOptions opt) Implements com.openhtmltopdf.util.ImageUtil.Scaler.getScaledInstance. Doc from com.openhtmltopdf.util.ImageUtil.Scaler.getScaledInstance. Convenience method that returns a scaled instance of the provided `BufferedImage`, taken from article on java.net by Chris Campbell http://today.java.net/pub/a/today/2007/04/03/perils-of-image-getscaledinstance.html. Expects the image to be fully loaded (e.g. no need to wait for loading on requesting height or width. Parameters img:BufferedImage the original image to be scaled opt:ScalingOptions options Returns:BufferedImage a scaled version of the original `BufferedImage`

public BufferedImage getScaledInstance(BufferedImage img, ScalingOptions opt)

Implements com.openhtmltopdf.util.ImageUtil.Scaler.getScaledInstance.

Doc from com.openhtmltopdf.util.ImageUtil.Scaler.getScaledInstance.

Parameters

img:BufferedImage: the original image to be scaled
opt:ScalingOptions: options

Returns:BufferedImage

a scaled version of the original BufferedImage

Access	Constructor and Description
pack-priv	OldScaler()

Modifier and Type	Method and Description
protected int	getImageScalingMethod() Implements abstract com.openhtmltopdf.util.ImageUtil.AbstractFastScaler.getImageScalingMethod.

OldScaler	back to summary
pack-priv OldScaler()

getImageScalingMethod	back to summary
protected int getImageScalingMethod() Implements abstract com.openhtmltopdf.util.ImageUtil.AbstractFastScaler.getImageScalingMethod.

com.openhtmltopdf.util back to summary

pack-priv Interface ImageUtil.Scaler

Known Direct Implementers: com.openhtmltopdf.util.ImageUtil.AbstractFastScaler, com.openhtmltopdf.util.ImageUtil.FastScaler, com.openhtmltopdf.util.ImageUtil.HighQualityScaler

Method Summary

Modifier and Type	Method and Description
public BufferedImage	Returns: a scaled version of the original `BufferedImage` getScaledInstance(BufferedImage the original image to be scaled img, ScalingOptions options opt) Convenience method that returns a scaled instance of the provided `BufferedImage`, taken from article on java.net by Chris Campbell http://today.java.net/pub/a/today/2007/04/03/perils-of-image-getscaledinstance.html.

Method Detail

getScaledInstance back to summary

getScaledInstance	back to summary
public BufferedImage getScaledInstance(BufferedImage img, ScalingOptions opt) Convenience method that returns a scaled instance of the provided `BufferedImage`, taken from article on java.net by Chris Campbell http://today.java.net/pub/a/today/2007/04/03/perils-of-image-getscaledinstance.html. Expects the image to be fully loaded (e.g. no need to wait for loading on requesting height or width. Parameters img:BufferedImage the original image to be scaled opt:ScalingOptions options Returns:BufferedImage a scaled version of the original `BufferedImage`

public BufferedImage getScaledInstance(BufferedImage img, ScalingOptions opt)

Parameters

img:BufferedImage: the original image to be scaled
opt:ScalingOptions: options

Returns:BufferedImage

a scaled version of the original BufferedImage

public Class ImageUtil

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv abstract Class ImageUtil.AbstractFastScaler

Constructor Summary

Method Summary

Constructor Detail

Method Detail

pack-priv Class ImageUtil.AreaAverageScaler

Constructor Summary

Method Summary

Constructor Detail

Method Detail

pack-priv Class ImageUtil.FastScaler

Constructor Summary

Method Summary

Constructor Detail

Method Detail

pack-priv Class ImageUtil.HighQualityScaler

Constructor Summary

Method Summary

Constructor Detail

Method Detail

pack-priv Class ImageUtil.OldScaler

Constructor Summary

Method Summary

Constructor Detail

Method Detail

pack-priv Interface ImageUtil.Scaler

Method Summary

Method Detail