Foxit PDF SDK
|
Public Member Functions | |
DefaultAppearance (int flags, Font font, float text_size, long text_color) | |
Constructor, with parameters. More... | |
DefaultAppearance () | |
Constructor. | |
DefaultAppearance (DefaultAppearance default_appearance) | |
Constructor, with another default appearance object. More... | |
synchronized void | delete () |
Clean up related resources immediately. More... | |
int | getFlags () |
Get flags to indicate which properties of default appearance are meaningful. More... | |
Font | getFont () |
Get a font for default appearance. More... | |
long | getText_color () |
Get text color for default appearance. More... | |
float | getText_size () |
Get text size for default appearance. More... | |
void | set (int flags, Font font, float text_size, long text_color) |
Set value. More... | |
void | setFlags (int value) |
Set flags to indicate which properties of default appearance are meaningful. More... | |
void | setFont (Font value) |
Set a font for default appearance. More... | |
void | setText_color (long value) |
Set text color for default appearance. More... | |
void | setText_size (float value) |
Set text size for default appearance. More... | |
Static Public Attributes | |
static final int | e_FlagFont = 0x0001 |
Indicates property font of com.foxit.sdk.pdf.annots.DefaultAppearance is meaningful. | |
static final int | e_FlagFontSize = 0x0004 |
Indicates property text size of com.foxit.sdk.pdf.annots.DefaultAppearance is meaningful. | |
static final int | e_FlagTextColor = 0x0002 |
Indicates property text color of com.foxit.sdk.pdf.annots.DefaultAppearance is meaningful. | |
This class represents default appearance data, which is used for free text annotation and form.
com.foxit.sdk.pdf.annots.DefaultAppearance.DefaultAppearance | ( | int | flags, |
Font | font, | ||
float | text_size, | ||
long | text_color | ||
) |
Constructor, with parameters.
[in] | flags | Flags to indicate which properties of default appearance are meaningful. Please refer to values starting from com.foxit.sdk.pdf.annots.DefaultAppearance.e_FlagFont and this can be one or a combination of these values. |
[in] | font | A valid font object for default appearance when parameter flags includes com.foxit.sdk.pdf.annots.DefaultAppearance.e_FlagFont . |
[in] | text_size | Font size for default appearance when parameter flags includes com.foxit.sdk.pdf.annots.DefaultAppearance.e_FlagFontSize . Usually it should be above 0. For some objects, the size 0 has special meaning. Please refer to the comment of functions which are used to set default appearance data to other object. |
[in] | text_color | Text color for default appearance. Format: 0xRRGGBB. |
com.foxit.sdk.pdf.annots.DefaultAppearance.DefaultAppearance | ( | DefaultAppearance | default_appearance | ) |
Constructor, with another default appearance object.
[in] | default_appearance | Another default appearance object. |
synchronized void com.foxit.sdk.pdf.annots.DefaultAppearance.delete | ( | ) |
Clean up related resources immediately.
com.foxit.sdk.pdf.annots.DefaultAppearance.getFlags | ( | ) |
Get flags to indicate which properties of default appearance are meaningful.
Please refer to values starting from com.foxit.sdk.pdf.annots.DefaultAppearance.e_FlagFont and this can be one or a combination of these values. 0 means no property of default appearance is meaningful.
com.foxit.sdk.pdf.annots.DefaultAppearance.getFont | ( | ) |
Get a font for default appearance.
com.foxit.sdk.pdf.annots.DefaultAppearance.getText_color | ( | ) |
Get text color for default appearance.
com.foxit.sdk.pdf.annots.DefaultAppearance.getText_size | ( | ) |
Get text size for default appearance.
Usually it should be above 0 when it is useful. For some objects, the size 0 has special meaning. Please refer to the comment of functions which are used to set default appearance data to other object.
void com.foxit.sdk.pdf.annots.DefaultAppearance.set | ( | int | flags, |
Font | font, | ||
float | text_size, | ||
long | text_color | ||
) |
Set value.
[in] | flags | Flags to indicate which properties of default appearance are meaningful. Please refer to values starting from com.foxit.sdk.pdf.annots.DefaultAppearance.e_FlagFont and this can be one or a combination of these values. |
[in] | font | A font for default appearance. Please ensure this is a valid font object when parameter flags includes com.foxit.sdk.pdf.annots.DefaultAppearance.e_FlagFont . |
[in] | text_size | Font size for default appearance when parameter flags includes com.foxit.sdk.pdf.annots.DefaultAppearance.e_FlagFontSize . Usually it should be above 0. For some objects, the size 0 has special meaning. Please refer to the comment of functions which are used to set default appearance data to other object. |
[in] | text_color | Text color for default appearance. Format: 0xRRGGBB. |
com.foxit.sdk.pdf.annots.DefaultAppearance.setFlags | ( | int | value | ) |
Set flags to indicate which properties of default appearance are meaningful.
Please refer to values starting from com.foxit.sdk.pdf.annots.DefaultAppearance.e_FlagFont and this can be one or a combination of these values. 0 means no property of default appearance is meaningful.
[in] | value | Flags to indicate which properties of default appearance are meaningful. |
com.foxit.sdk.pdf.annots.DefaultAppearance.setFont | ( | Font | value | ) |
Set a font for default appearance.
[in] | value | A font for default appearance. It should be a valid font object when it is useful. |
com.foxit.sdk.pdf.annots.DefaultAppearance.setText_color | ( | long | value | ) |
Set text color for default appearance.
[in] | value | Text color for default appearance. Format: 0xRRGGBB. |
com.foxit.sdk.pdf.annots.DefaultAppearance.setText_size | ( | float | value | ) |
Set text size for default appearance.
Usually it should be above 0 when it is useful. For some objects, the size 0 has special meaning. Please refer to the comment of functions which are used to set default appearance data to other object.
[in] | value | Text size for default appearance. |