|
xmlgraphics-commons 2.0.1 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.xmlgraphics.image.writer.ImageWriterParams
public class ImageWriterParams
Parameters for the encoder which is accessed through the ImageWriter interface.
Field Summary | |
---|---|
static int |
ONE_ROW_PER_STRIP
Used for generating exactly one strip for each row |
static int |
SINGLE_STRIP
Forces a single strip for the whole image. |
Constructor Summary | |
---|---|
ImageWriterParams()
Default constructor. |
Method Summary | |
---|---|
String |
getCompressionMethod()
|
Endianness |
getEndianness()
Returns the endianness selected for the image. |
Boolean |
getJPEGForceBaseline()
|
Float |
getJPEGQuality()
|
Integer |
getResolution()
|
ResolutionUnit |
getResolutionUnit()
Returns the unit in which resolution values are given (ex. |
int |
getRowsPerStrip()
The number of rows per strip of the TIFF image, default 1. |
Integer |
getXResolution()
|
Integer |
getYResolution()
|
boolean |
hasResolution()
|
boolean |
isSingleStrip()
Checks if image is single strip (required by some fax processors). |
void |
setCompressionMethod(String method)
Set the compression method that shall be used to encode the image. |
void |
setEndianness(Endianness endianness)
Sets the endianness selected for the image. |
void |
setJPEGQuality(float quality,
boolean forceBaseline)
Sets the quality setting for encoding JPEG images. |
void |
setResolution(int resolution)
Sets the target resolution of the bitmap image to be written (sets both the horizontal and vertical resolution to the same value). |
void |
setResolutionUnit(ResolutionUnit resolutionUnit)
Sets the resolution unit of the image for calculating resolution. |
void |
setRowsPerStrip(int rowsPerStrip)
Sets the rows per strip (default is one row per strip); if set to -1 (single strip), will use height of the current page, required by some fax processors. |
void |
setSingleStrip(boolean isSingle)
Convenience method to set rows per strip to single strip, otherwise sets to one row per strip. |
void |
setXResolution(int resolution)
Sets the target horizontal resolution of the bitmap image to be written. |
void |
setYResolution(int resolution)
Sets the target vertical resolution of the bitmap image to be written. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int SINGLE_STRIP
public static final int ONE_ROW_PER_STRIP
Constructor Detail |
---|
public ImageWriterParams()
Method Detail |
---|
public boolean hasResolution()
public Integer getResolution()
public Float getJPEGQuality()
public Boolean getJPEGForceBaseline()
public String getCompressionMethod()
public void setResolution(int resolution)
resolution
- the resolutionpublic void setJPEGQuality(float quality, boolean forceBaseline)
quality
- the quality setting (0.0-1.0)forceBaseline
- force baseline quantization tablepublic void setCompressionMethod(String method)
method
- the compression methodpublic boolean isSingleStrip()
public void setSingleStrip(boolean isSingle)
isSingle
- true if a single strip shall be produced, false if multiple strips are okpublic void setRowsPerStrip(int rowsPerStrip)
rowsPerStrip
- the value to set.public int getRowsPerStrip()
public ResolutionUnit getResolutionUnit()
public void setResolutionUnit(ResolutionUnit resolutionUnit)
resolutionUnit
- the resolution unit (inches, centimeters etc.)public Integer getXResolution()
public void setXResolution(int resolution)
resolution
- the resolution valuepublic Integer getYResolution()
public void setYResolution(int resolution)
resolution
- the resolution valuepublic Endianness getEndianness()
public void setEndianness(Endianness endianness)
endianness
- the endianness
|
xmlgraphics-commons 2.0.1 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |