public class PD4PageMark
extends java.lang.Object
implements java.io.Serializable
Modifier and Type | Field and Description |
---|---|
static int |
CENTER_ALIGN |
static int |
LEFT_ALIGN |
static int |
RIGHT_ALIGN |
Constructor and Description |
---|
PD4PageMark() |
Modifier and Type | Method and Description |
---|---|
boolean |
firstPageDiffers()
checks if the header/footer definition for the first page differs the default definition
|
int |
getAreaHeight()
returns header or footer height.
|
java.awt.Color |
getColor() |
java.awt.Font |
getFont()
returns font currently used for header or footer
|
java.awt.Font |
getFont(int pageNumber)
returns font currently used for header or footer
The method can be overridden in order to add page dependent
header/footer font definition
|
int |
getFontSize() |
java.lang.String |
getHtmlTemplate()
returns HTML template used to print entire document header/footer area.
|
java.lang.String |
getHtmlTemplate(int pageNumber)
returns string template used to print HTML header or footer
The method can be overridden in order to add page dependent
template specification
|
int |
getInitialPageNumber()
returns initial value for the PDF document page counter.
|
java.awt.Color |
getPageBackgroundColor()
returns default page background color
|
java.awt.Color |
getPageBackgroundColor(int pageNumber)
returns background color for the specified page
The method can be overridden in order to add page dependent
color definition
|
java.lang.String |
getPageBackgroundImageUrl()
returns default page background image URL
|
java.lang.String |
getPageBackgroundImageUrl(int pageNumber)
returns background image URL for the specified page
The method can be overridden in order to add page dependent
background image definition
|
int |
getPageNumberAlignment()
returns page number alignment
|
java.lang.String |
getPageNumberTemplate()
returns string template used to print page numbers
|
java.lang.String |
getPageNumberTemplate(int pageNumber)
returns string template used to print page numbers.
|
int |
getPagesToSkip()
returns number of pages that should not be
marked with header or footer area
|
int |
getTitleAlignment()
returns title alignment value
|
java.lang.String |
getTitleTemplate()
returns string template used to print document title
in header or footer area
|
java.lang.String |
getTitleTemplate(int pageNumber)
returns string template used to print document title
in header or footer area
The method can be overridden in order to add page dependent
template specification
|
java.awt.Rectangle |
getWatermarkBounds() |
int |
getWatermarkOpacity() |
java.lang.String |
getWatermarkUrl() |
java.lang.String |
getWatermarkUrl(int pageNumber) |
void |
setAreaHeight(int i)
defines height of the header or footer area
|
void |
setColor(java.awt.Color color)
setColor() sets the color of header or footer text
|
void |
setFont(java.awt.Font font)
sets font for header (footer) (since v1.2.0b2)
|
void |
setFontSize(int size)
sets font size for the header of footer
|
void |
setHtmlTemplate(java.lang.String template)
sets HTML template used to print entire document header/footer area.
|
void |
setInitialPageNumber(int i)
defines initial value for the
PDF document page counter.
|
void |
setPageBackgroundColor(java.awt.Color pageBackgroundColor)
defines default page background color
|
void |
setPageBackgroundImageUrl(java.lang.String pageBackgroundImageUrl)
defines default page background image (form, letterhead)
|
void |
setPageNumberAlignment(int i)
defines alignment for the page numbers
in the document's header of footer area
|
void |
setPageNumberTemplate(java.lang.String string)
defines a template for page number representation
No page numbering is printed, if the pageNumberTemplate is set to null. Default value is null. If HTML template specified, than the method call is ignored. |
void |
setPagesToSkip(int i)
defines a number of pages from the document beginning, that should not
be marked with the header or footer info.
|
void |
setTitleAlignment(int i)
defines alignment for the page title string
in the document's header of footer.
Note: only single line headers are supported |
void |
setTitleTemplate(java.lang.String string)
defines a template for page title representation.
No title is printed, if the titleTemplate is set to null. |
void |
setWatermark(java.lang.String url,
java.awt.Rectangle bounds,
int opacity)
specifies watermark image to be printed on every page.
|
java.lang.String |
toString() |
public static final int LEFT_ALIGN
public static final int CENTER_ALIGN
public static final int RIGHT_ALIGN
public void setWatermark(java.lang.String url, java.awt.Rectangle bounds, int opacity)
url
- image locationbounds
- image position and size in typographical pointsopacity
- image opacity in range from 0 to 100public java.awt.Rectangle getWatermarkBounds()
setWatermark(String, Rectangle, int)
public int getWatermarkOpacity()
setWatermark(String, Rectangle, int)
public java.lang.String getWatermarkUrl()
setWatermark(String, Rectangle, int)
public java.lang.String getWatermarkUrl(int pageNumber)
setWatermark(String, Rectangle, int)
public int getInitialPageNumber()
setInitialPageNumber(int)
public int getPageNumberAlignment()
setPageNumberAlignment(int)
,
LEFT_ALIGN
,
RIGHT_ALIGN
,
CENTER_ALIGN
public java.lang.String getPageNumberTemplate()
setPageNumberTemplate(String)
public java.lang.String getPageNumberTemplate(int pageNumber)
pageNumber
- destination page numberpublic int getPagesToSkip()
setPagesToSkip(int)
public int getTitleAlignment()
setTitleAlignment(int)
public java.lang.String getTitleTemplate()
setTitleTemplate(String)
public java.lang.String getTitleTemplate(int pageNumber)
pageNumber
- destination page numberpublic java.lang.String getHtmlTemplate()
setTitleTemplate(String)
,
setPageNumberTemplate(String)
,
setHtmlTemplate(String)
public java.lang.String getHtmlTemplate(int pageNumber)
pageNumber
- destination page numberpublic void setHtmlTemplate(java.lang.String template)
public void setInitialPageNumber(int i)
i
- initial page numberpublic void setPageNumberAlignment(int i) throws java.security.InvalidParameterException
i
- - alignmentjava.security.InvalidParameterException
LEFT_ALIGN
,
RIGHT_ALIGN
,
CENTER_ALIGN
public void setPageNumberTemplate(java.lang.String string)
string
- a string with static text or/and special markups: ${page} - for current
page number, ${total} - for total number of pages in the document. The both numeric values
can be affected by setInitailPageNumber()setHtmlTemplate(String)
public void setPagesToSkip(int i) throws java.security.InvalidParameterException
i
- number of pages to skipjava.security.InvalidParameterException
public void setTitleAlignment(int i) throws java.security.InvalidParameterException
i
- - alignmentjava.security.InvalidParameterException
LEFT_ALIGN
,
RIGHT_ALIGN
,
CENTER_ALIGN
public void setTitleTemplate(java.lang.String string)
string
- a string with static text or/and special markups: ${title} -
page title, ${page} - current page number, ${total} - for total number of
pages in the document. The both numeric values can be affected by
setInitailPageNumber() callsetHtmlTemplate(String)
public int getAreaHeight()
public void setAreaHeight(int i) throws java.security.InvalidParameterException
i
- height in points; "-1" value forces PD4ML to predict HTML header or footer height
and to use the calculated value.java.security.InvalidParameterException
public java.awt.Color getColor()
setColor(Color)
public java.awt.Font getFont()
public java.awt.Font getFont(int pageNumber)
pageNumber
- destination page numberpublic int getFontSize()
setFontSize(int)
public void setColor(java.awt.Color color)
color
- public void setFontSize(int size) throws java.security.InvalidParameterException
size
- java.security.InvalidParameterException
public void setFont(java.awt.Font font) throws java.security.InvalidParameterException
font
- java.security.InvalidParameterException
public java.lang.String toString()
toString
in class java.lang.Object
public java.awt.Color getPageBackgroundColor(int pageNumber)
pageNumber
- destination page numberpublic java.lang.String getPageBackgroundImageUrl(int pageNumber)
pageNumber
- destination page numberpublic java.awt.Color getPageBackgroundColor()
public void setPageBackgroundColor(java.awt.Color pageBackgroundColor)
pageBackgroundColor
- public java.lang.String getPageBackgroundImageUrl()
public void setPageBackgroundImageUrl(java.lang.String pageBackgroundImageUrl)
pageBackgroundImageUrl
- public boolean firstPageDiffers()
Copyright © 2004-15 zefer.org. All Rights Reserved.