|
DynamicPDF by ceTe Software | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.cete.dynamicpdf.PageElement com.cete.dynamicpdf.pageelements.TaggablePageElement com.cete.dynamicpdf.pageelements.RotatingPageElement com.cete.dynamicpdf.pageelements.Image
public class Image
This class can be used to place images on a page.
Licensing:
The use of the GIF image type is a DynamicPDF Generator
Community Edition feature. All other image types (JPEG, JPEG 2000, PNG, BMP, EMF,
EXIF, TIFF and WMF) are a DynamicPDF Generator Professional Edition feature,
except for the use of 64 bit PNG images (in this case see below). One of the
following licenses is required for non-evaluation usage:
Use of 64 bit PNG images with this class is an Enterprise Edition feature. One of the following licenses is required for non-evaluation usage:
Constructor Summary | |
---|---|
Image(byte[] byteArray,
float x,
float y)
Creates a new instance of Image . |
|
Image(byte[] byteArray,
float x,
float y,
float scale)
Creates a new instance of Image . |
|
Image(ImageData imageData,
float x,
float y)
Creates a new instance of Image . |
|
Image(ImageData imageData,
float x,
float y,
float scale)
Creates a new instance of Image . |
|
Image(java.lang.String filePath,
float x,
float y)
Creates a new instance of Image . |
|
Image(java.lang.String filePath,
float x,
float y,
float scale)
Creates a new instance of Image . |
Method Summary | |
---|---|
protected void |
drawRotated(PageWriter writer)
Draws the image to the given PageWriter object. |
Align |
getAlign()
Gets the Align enumeration that specifies horizontal alignment
of the image on the X coordinate. |
java.lang.String |
getAlternateText()
Gets the alternate text of the image. |
float |
getHeight()
Gets the height of the image. |
float |
getHorizontalDpi()
Gets the horizontal dpi(also known as pixels per inch) of the image. |
ImageData |
getImageData()
Get the image's ImageData object. |
float |
getScaleX()
Gets the horizontal scale of the image. |
float |
getScaleY()
Gets the vertical scale of the image. |
VAlign |
getVAlign()
Gets the VAlign enumeration that specifies vertical alignment
of the image on the Y coordinate. |
float |
getVerticalDpi()
Gets the vertical dpi(also known as pixels per inch) of the image. |
float |
getWidth()
Gets the width of the image. |
void |
setAlign(Align value)
Sets the Align enumeration that specifies horizontal alignment
of the image on the X coordinate. |
void |
setAlternateText(java.lang.String alternateText)
Sets the alternate text of the image. |
void |
setBounds(float maximumWidth,
float maximumHeight)
Scales the image to fit in the given box keeping the X and Y scale equal. |
void |
setDpi(float dpi)
Scales the image to have the specified dpi(also known as pixels per inch). |
void |
setDpi(float horizontalDpi,
float verticalDpi)
Scales the image to have the specified dpi(also known as pixels per inch). |
void |
setHeight(float value)
Sets the height of the image. |
void |
setHorizontalDpi(float dpiX)
Sets the horizontal dpi(also known as pixels per inch) of the image. |
void |
setScaleX(float value)
Sets the horizontal scale of the image. |
void |
setScaleY(float value)
Sets the vertical scale of the image. |
void |
setSize(float width,
float height)
Scales the image to fit the exact width and height given. |
void |
setVAlign(VAlign value)
Sets the VAlign enumeration that specifies vertical alignment
of the image on the Y coordinate. |
void |
setVerticalDpi(float dpiY)
Sets the vertical dpi(also known as pixels per inch) of the image. |
void |
setWidth(float value)
Sets the width of the image. |
Methods inherited from class com.cete.dynamicpdf.pageelements.RotatingPageElement |
---|
draw, getAngle, getX, getY, setAngle, setX, setY |
Methods inherited from class com.cete.dynamicpdf.pageelements.TaggablePageElement |
---|
getTag, getTagOrder, setTag, setTagOrder |
Methods inherited from class com.cete.dynamicpdf.PageElement |
---|
getRequiredLicenseLevel, getStrID, setRequiredLicenseLevel, setStrID |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.cete.dynamicpdf.pageelements.ICoordinate |
---|
getX, getY, setX, setY |
Constructor Detail |
---|
public Image(java.lang.String filePath, float x, float y) throws java.io.FileNotFoundException
Image
.
java.io.FileNotFoundException
filePath
- Physical file path of the image.x
- X coordinate of the image.y
- Y coordinate of the image.public Image(java.lang.String filePath, float x, float y, float scale) throws java.io.FileNotFoundException
Image
.
java.io.FileNotFoundException
- If the physical file path of the image is not found.filePath
- Physical file path of the image.x
- X coordinate of the image.y
- Y coordinate of the image.scale
- The scale to use when rendering the image.public Image(byte[] byteArray, float x, float y)
Image
.
byteArray
- Byte Array containing the image data.x
- X coordinate of the image.y
- Y coordinate of the image.public Image(byte[] byteArray, float x, float y, float scale)
Image
.
byteArray
- Byte Array containing the image data.x
- X coordinate of the image.y
- Y coordinate of the image.scale
- The scale to use when rendering the image.public Image(ImageData imageData, float x, float y)
Image
.
imageData
- ImageData
object containing the image data.x
- X coordinate of the image.y
- Y coordinate of the image.ImageData
public Image(ImageData imageData, float x, float y, float scale)
Image
.
imageData
- ImageData
object containing the image data.x
- X coordinate of the image.y
- Y coordinate of the image.scale
- The scale to use when rendering the image.ImageData
Method Detail |
---|
public Align getAlign()
Align
enumeration that specifies horizontal alignment
of the image on the X coordinate.
Align
public void setAlign(Align value)
Align
enumeration that specifies horizontal alignment
of the image on the X coordinate.
value
- the alignment of the image.Align
public VAlign getVAlign()
VAlign
enumeration that specifies vertical alignment
of the image on the Y coordinate.
VAlign
public void setVAlign(VAlign value)
VAlign
enumeration that specifies vertical alignment
of the image on the Y coordinate.
value
- the vertical alignment of the image.VAlign
public float getScaleX()
public void setScaleX(float value)
getHorizontalDpi
property.
value
- the horizontal scale of the image.public float getScaleY()
public void setScaleY(float value)
getVerticalDpi
property.
value
- the vertical scale of the image.public float getHorizontalDpi()
public void setHorizontalDpi(float dpiX)
getScaleX
property.
dpiX
- the horizontal dpi(also known as pixels per inch) of the image.public float getVerticalDpi()
public void setVerticalDpi(float dpiY)
getScaleY
property.
dpiY
- the vertical dpi(also known as pixels per inch) of the image.public float getWidth()
getWidth
in interface IArea
public void setWidth(float value)
setWidth
in interface IArea
value
- the width of the image.public float getHeight()
getHeight
in interface IArea
getHeight
in class RotatingPageElement
public void setHeight(float value)
setHeight
in interface IArea
setHeight
in class RotatingPageElement
value
- the height of the image.public ImageData getImageData()
ImageData
object.
ImageData
protected void drawRotated(PageWriter writer)
PageWriter
object.
drawRotated
in class RotatingPageElement
writer
- PageWriter
object to receive the image's output.PageWriter
public void setBounds(float maximumWidth, float maximumHeight)
maximumWidth
- The maximum width.maximumHeight
- The maximum height.public void setSize(float width, float height)
width
- Width of image.height
- Height of image.public void setDpi(float dpi)
dpi
- DPI of the image.public void setDpi(float horizontalDpi, float verticalDpi)
horizontalDpi
- Horizontal dpi of the image.verticalDpi
- Horizontal dpi of the image.public java.lang.String getAlternateText()
public void setAlternateText(java.lang.String alternateText)
alternateText
- the alternate text of the image.
|
DynamicPDF by ceTe Software | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |