Foxit PDF SDK
|
Public Member Functions | |
WatermarkTextProperties (Font font, float font_size, long color, int style, float line_space, int alignment) | |
Constructor, with parameters. More... | |
WatermarkTextProperties () | |
Constructor. | |
WatermarkTextProperties (WatermarkTextProperties properties) | |
Constructor, with another watermark text properties object. More... | |
synchronized void | delete () |
Clean up related resources immediately. More... | |
int | getAlignment () |
Get text horizontal alignment. More... | |
long | getColor () |
Get text color. More... | |
Font | getFont () |
Get a font object used for the text. More... | |
float | getFont_size () |
Get font size in points. More... | |
int | getFont_style () |
Get font style. More... | |
float | getLine_space () |
Get space between vertical center of lines, in line heights. More... | |
void | set (Font font, float font_size, long color, int style, float line_space, int alignment) |
Set value. More... | |
void | setAlignment (int value) |
Set text horizontal alignment. More... | |
void | setColor (long value) |
Set text color. More... | |
void | setFont (Font value) |
Set a font object used for the text. More... | |
void | setFont_size (float value) |
Set font size in points. More... | |
void | setFont_style (int value) |
Set font style. More... | |
void | setLine_space (float value) |
Set space between vertical center of lines, in line heights. More... | |
Static Public Attributes | |
static final int | e_FontStyleNormal = 0 |
Watermark font style: normal. | |
static final int | e_FontStyleUnderline = 1 |
Watermark font style: with underline. | |
This class represents the watermark text settings used to construct a watermark object from text.
com.foxit.sdk.pdf.WatermarkTextProperties.WatermarkTextProperties | ( | Font | font, |
float | font_size, | ||
long | color, | ||
int | style, | ||
float | line_space, | ||
int | alignment | ||
) |
Constructor, with parameters.
[in] | font | A valid font object used for the text. |
[in] | font_size | Font size in points. |
[in] | color | Text color. Format: 0xRRGGBB. |
[in] | style | Font style. It should be one of the following values: |
[in] | line_space | Space between vertical center of lines, in line heights. This value specifies the multiple of line heights for the space between vertical center of lines. Valid range: from 0 to 10 (not including 0 but including 10). If this value is above 10, 10 will be used as default for the text watermark. |
[in] | alignment | Text horizontal alignment. It should be one of the following values: |
com.foxit.sdk.pdf.WatermarkTextProperties.WatermarkTextProperties | ( | WatermarkTextProperties | properties | ) |
Constructor, with another watermark text properties object.
[in] | properties | Another watermark text properties object. |
synchronized void com.foxit.sdk.pdf.WatermarkTextProperties.delete | ( | ) |
Clean up related resources immediately.
com.foxit.sdk.pdf.WatermarkTextProperties.getAlignment | ( | ) |
Get text horizontal alignment.
It should be one of the following macro definitions:
com.foxit.sdk.pdf.WatermarkTextProperties.getColor | ( | ) |
Get text color.
com.foxit.sdk.pdf.WatermarkTextProperties.getFont | ( | ) |
Get a font object used for the text.
com.foxit.sdk.pdf.WatermarkTextProperties.getFont_size | ( | ) |
Get font size in points.
com.foxit.sdk.pdf.WatermarkTextProperties.getFont_style | ( | ) |
Get font style.
It should be one of the following values:
com.foxit.sdk.pdf.WatermarkTextProperties.getLine_space | ( | ) |
Get space between vertical center of lines, in line heights.
This value is used to specify the multiple of line heights for the space between vertical center of lines. Valid range: from 0 to 10 (not including 0 but including 10). If this value is above 10, 10 will be used as default for the text watermark.
void com.foxit.sdk.pdf.WatermarkTextProperties.set | ( | Font | font, |
float | font_size, | ||
long | color, | ||
int | style, | ||
float | line_space, | ||
int | alignment | ||
) |
Set value.
[in] | font | A valid font object used for the text. |
[in] | font_size | Font size in points. |
[in] | color | Text color. Format: 0xRRGGBB. |
[in] | style | Font style. It should be one of the following values: |
[in] | line_space | Space between vertical center of lines, in line heights. This value specifies the multiple of line heights for the space between vertical center of lines. Valid range: from 0 to 10 (not including 0 but including 10). If this value is above 10, 10 will be used as default for the text watermark. |
[in] | alignment | Text horizontal alignment. It should be one of the following values: |
com.foxit.sdk.pdf.WatermarkTextProperties.setAlignment | ( | int | value | ) |
Set text horizontal alignment.
It should be one of the following macro definitions:
[in] | value | Text horizontal alignment. |
com.foxit.sdk.pdf.WatermarkTextProperties.setColor | ( | long | value | ) |
Set text color.
[in] | value | Text color. Format: 0xRRGGBB. |
com.foxit.sdk.pdf.WatermarkTextProperties.setFont | ( | Font | value | ) |
Set a font object used for the text.
[in] | value | A font object used for the text. |
com.foxit.sdk.pdf.WatermarkTextProperties.setFont_size | ( | float | value | ) |
Set font size in points.
[in] | value | Font size in points. |
com.foxit.sdk.pdf.WatermarkTextProperties.setFont_style | ( | int | value | ) |
Set font style.
It should be one of the following values:
[in] | value | Font style. |
com.foxit.sdk.pdf.WatermarkTextProperties.setLine_space | ( | float | value | ) |
Set space between vertical center of lines, in line heights.
This value is used to specify the multiple of line heights for the space between vertical center of lines. Valid range: from 0 to 10 (not including 0 but including 10). If this value is above 10, 10 will be used as default for the text watermark.
[in] | value | Space between vertical center of lines, in line heights. |