|
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.BackgroundImage
public class BackgroundImage
This class can be used to place an image on the page that will be stretched to the dimensions of the page.
Licensing:
This class is 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 | |
---|---|
BackgroundImage(byte[] byteArray)
Creates a new instance of BackgroundImage class. |
|
BackgroundImage(ImageData imageData)
Creates a new instance of BackgroundImage class. |
|
BackgroundImage(java.lang.String filePath)
Creates a new instance of BackgroundImage class. |
Method Summary | |
---|---|
void |
draw(PageWriter writer)
Draws the background image to the given PageWriter object. |
int |
getBottomPadding()
Get the bottom padding of the background image. |
ImageData |
getImageData()
Get the background image's ImageData object. |
int |
getLeftPadding()
Get the left padding of the background image. |
int |
getRightPadding()
Get the right padding of the background image. |
int |
getTopPadding()
Get the top padding of the background image. |
boolean |
getUseMargins()
Get or set a value indicating if the pages margins should be used when calculating the placement of the background image. |
void |
setBottomPadding(int value)
Set the bottom padding of the background image. |
void |
setLeftPadding(int value)
Set the left padding of the background image. |
void |
setRightPadding(int value)
Set the right padding of the background image. |
void |
setTopPadding(int value)
Set the top padding of the background image. |
void |
setUseMargins(boolean value)
Set or set a value indicating if the pages margins should be used when calculating the placement of the background image. |
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 |
Constructor Detail |
---|
public BackgroundImage(java.lang.String filePath) throws java.io.FileNotFoundException
BackgroundImage
class.
java.io.FileNotFoundException
- If the physical file path to the background image is notfound.filePath
- The physical file path to the background image.public BackgroundImage(byte[] byteArray)
BackgroundImage
class.
byteArray
- Byte Array containing the image data.public BackgroundImage(ImageData imageData)
BackgroundImage
class.
imageData
- ImageData
object containing the image data.ImageData
Method Detail |
---|
public void draw(PageWriter writer)
PageWriter
object.
draw
in class TaggablePageElement
writer
- PageWriter
object to receive the background image's output.PageWriter
public ImageData getImageData()
ImageData
object.
public int getLeftPadding()
public void setLeftPadding(int value)
value
- the left padding of the background image.public int getRightPadding()
public void setRightPadding(int value)
value
- the right padding of the background image.public int getTopPadding()
public void setTopPadding(int value)
value
- the top padding of the background image.public int getBottomPadding()
public void setBottomPadding(int value)
value
- the bottom padding of the background image.public boolean getUseMargins()
public void setUseMargins(boolean value)
value
- the user margin status.
|
DynamicPDF by ceTe Software | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |