public class ScalingOptions
extends java.lang.Object
org.xhtmlrenderer.util.ImageUtil#getScaledInstance(ScalingOptions,java.awt.Image)
.
Encapsulates a set of parameters related to scaling quality and output. Values are final once constructed, except
for target width and height, which can be change and the options instance reused.
There is a default constructor for average quality and performance.Constructor and Description |
---|
ScalingOptions()
Default scaling options, nearest neighbor interpolation, and fast downscaling.
|
ScalingOptions(DownscaleQuality downscalingHint,
java.lang.Object interpolationHint)
Constructor with all options.
|
ScalingOptions(int targetWidth,
int targetHeight,
int type,
DownscaleQuality downscalingHint,
java.lang.Object hint)
Constructor with all options.
|
Modifier and Type | Method and Description |
---|---|
void |
applyRenderingHints(java.awt.Graphics2D g2)
Applies any rendering hints configured for these ScalingOptions to a Graphics2D instance before image
operations are called on it.
|
DownscaleQuality |
getDownscalingHint() |
java.lang.Object |
getRenderingHint() |
int |
getTargetHeight() |
int |
getTargetWidth() |
void |
setTargetDimensions(java.awt.Dimension dim) |
void |
setTargetHeight(int targetHeight) |
void |
setTargetWidth(int targetWidth) |
boolean |
sizeMatches(java.awt.Image img)
Returns true if the target size specified by these options matches the size provided (e.g.
|
boolean |
sizeMatches(int w,
int h)
Returns true if the target size specified by these options matches the size provided (e.g.
|
public ScalingOptions(DownscaleQuality downscalingHint, java.lang.Object interpolationHint)
downscalingHint
- Directs downscaling quality. One of the enumerated types of
DownscaleQuality
such as
org.xhtmlrenderer.util.ImageUtil.DOWNSCALE_FAST
.interpolationHint
- Hint for interpolation to AWT image renderer, one of the Object constants from
RenderingHints
using java.awt.RenderingHints.KEY_INTERPOLATION
public ScalingOptions()
public ScalingOptions(int targetWidth, int targetHeight, int type, DownscaleQuality downscalingHint, java.lang.Object hint)
targetWidth
- Target width in pixels of image once scaledtargetHeight
- Target height in pixels of image once scaledtype
- Type of BufferedImage
to create for output; see docs for
BufferedImage.BufferedImage(int,int,int)
downscalingHint
- Directs downscaling quality. One of the enumerated types of
DownscaleQuality
such as
org.xhtmlrenderer.util.ImageUtil.DOWNSCALE_FAST
.hint
- Hint for interpolation to AWT image renderer, one of the Object constants from
RenderingHints
using java.awt.RenderingHints.KEY_INTERPOLATION
public DownscaleQuality getDownscalingHint()
ScalingOptions#ScalingOptions(int,DownscaleQuality,Object)
docs.public java.lang.Object getRenderingHint()
ScalingOptions#ScalingOptions(int,DownscaleQuality,Object)
docs.public void applyRenderingHints(java.awt.Graphics2D g2)
g2
- A Graphics2D instance on which scaled images will be rendered.public boolean sizeMatches(int w, int h)
w
- an image widthh
- an image heightpublic boolean sizeMatches(java.awt.Image img)
img
- public int getTargetWidth()
public int getTargetHeight()
public void setTargetWidth(int targetWidth)
public void setTargetHeight(int targetHeight)
public void setTargetDimensions(java.awt.Dimension dim)