Foxit PDF SDK
|
Public Member Functions | |
HeaderFooter (Font font, float text_size, long text_color, PageNumberRange page_range, RectF page_margin, boolean has_text_shrinked, boolean has_fixedsize_for_print, int start_page_number, HeaderFooterContent content, boolean is_to_embed_font, boolean is_underline) | |
Constructor, with parameters. More... | |
HeaderFooter () | |
Constructor. | |
HeaderFooter (HeaderFooter other) | |
Constructor, with another header-footer object. More... | |
HeaderFooterContent | getContent () |
Get header-footer content. More... | |
Font | getFont () |
Get a valid font object which is expected to be used for header-footer content. More... | |
boolean | getHas_fixedsize_for_print () |
Get a boolean value that decides whether to use fixed size for print or not. More... | |
boolean | getHas_text_shrinked () |
Get a boolean value that decides whether to shrink text or not. More... | |
boolean | getIs_replace_font () |
Get (Reserved) A boolean value that decides whether to replace font or not. More... | |
boolean | getIs_to_embed_font () |
Get a boolean value that decides whether to embed font or not. More... | |
boolean | getIs_underline () |
Get a boolean value that decides whether to underline text or not. More... | |
RectF | getPage_margin () |
Get page margin which specifies the location for header-footer content. More... | |
PageNumberRange | getPage_range () |
Get a page number range object which specifies pages where current header-footer is used. More... | |
int | getStart_page_number () |
Get a virtual page number used for the first page specified in parameter page_range. More... | |
long | getText_color () |
Get text color used for header-footer content. More... | |
float | getText_size () |
Get text size of header-footer content. More... | |
void | set (Font font, float text_size, long text_color, PageNumberRange page_range, RectF page_margin, boolean has_text_shrinked, boolean has_fixedsize_for_print, int start_page_number, HeaderFooterContent content, boolean is_to_embed_font, boolean is_underline) |
Set value. More... | |
void | setContent (HeaderFooterContent value) |
Set header-footer content. More... | |
void | setFont (Font value) |
Set a valid font object which is expected to be used for header-footer content. More... | |
void | setHas_fixedsize_for_print (boolean value) |
Set a boolean value that decides whether to use fixed size for print or not. More... | |
void | setHas_text_shrinked (boolean value) |
Set a boolean value that decides whether to shrink text or not. More... | |
void | setIs_replace_font (boolean value) |
Set (Reserved) A boolean value that decides whether to replace font or not. More... | |
void | setIs_to_embed_font (boolean value) |
Set a boolean value that decides whether to embed font or not. More... | |
void | setIs_underline (boolean value) |
Set a boolean value that decides whether to underline text or not. More... | |
void | setPage_margin (RectF value) |
Set page margin which specifies the location for header-footer content. More... | |
void | setPage_range (PageNumberRange value) |
Set a page number range object which specifies pages where current header-footer is used. More... | |
void | setStart_page_number (int value) |
Set a virtual page number used for the first page specified in parameter page_range. More... | |
void | setText_color (long value) |
Set text color used for header-footer content. More... | |
void | setText_size (float value) |
Set text size of header-footer content. More... | |
This class represents properties and data for a header-footer.
com.foxit.sdk.pdf.HeaderFooter.HeaderFooter | ( | Font | font, |
float | text_size, | ||
long | text_color, | ||
PageNumberRange | page_range, | ||
RectF | page_margin, | ||
boolean | has_text_shrinked, | ||
boolean | has_fixedsize_for_print, | ||
int | start_page_number, | ||
HeaderFooterContent | content, | ||
boolean | is_to_embed_font, | ||
boolean | is_underline | ||
) |
Constructor, with parameters.
[in] | font | A valid font object used for header-footer content. Please refer to comment of font of current object. |
[in] | text_size | Text size of header-footer content. |
[in] | text_color | Text color used for header-footer content. |
[in] | page_range | A page number range object which specifies pages where current header-footer is used. Please refer to comment of page_range of current object. |
[in] | page_margin | Page margin which specifies the location for header-footer content. Please refer to comment of page_margin of current object. |
[in] | has_text_shrinked | A boolean value that decides whether to shrink text or not. |
[in] | has_fixedsize_for_print | A boolean value that decides whether to use fixed size for print or not. |
[in] | start_page_number | A virtual page number used for the first page specified in parameter page_range. This can be any number, even different from the actual page number of the specified page. If this value is less than 1, Foxit PDF SDK will use 1 for this value when current header-footer object is used in a PDF document. |
[in] | content | Header-footer content. |
[in] | is_to_embed_font | A boolean value that decides whether to embed font or not. |
[in] | is_underline | A boolean value that decides whether to underline text or not. |
com.foxit.sdk.pdf.HeaderFooter.HeaderFooter | ( | HeaderFooter | other | ) |
Constructor, with another header-footer object.
[in] | other | Another header-footer object. |
com.foxit.sdk.pdf.HeaderFooter.getContent | ( | ) |
Get header-footer content.
com.foxit.sdk.pdf.HeaderFooter.getFont | ( | ) |
Get a valid font object which is expected to be used for header-footer content.
com.foxit.sdk.pdf.HeaderFooter.getHas_fixedsize_for_print | ( | ) |
Get a boolean value that decides whether to use fixed size for print or not.
com.foxit.sdk.pdf.HeaderFooter.getHas_text_shrinked | ( | ) |
Get a boolean value that decides whether to shrink text or not.
com.foxit.sdk.pdf.HeaderFooter.getIs_replace_font | ( | ) |
Get (Reserved) A boolean value that decides whether to replace font or not.
com.foxit.sdk.pdf.HeaderFooter.getIs_to_embed_font | ( | ) |
Get a boolean value that decides whether to embed font or not.
com.foxit.sdk.pdf.HeaderFooter.getIs_underline | ( | ) |
Get a boolean value that decides whether to underline text or not.
com.foxit.sdk.pdf.HeaderFooter.getPage_margin | ( | ) |
Get page margin which specifies the location for header-footer content.
com.foxit.sdk.pdf.HeaderFooter.getPage_range | ( | ) |
Get a page number range object which specifies pages where current header-footer is used.
All the values represented in this range should start from 1 and no more than page count of the PDF document, in which current header-footer object is used.
com.foxit.sdk.pdf.HeaderFooter.getStart_page_number | ( | ) |
Get a virtual page number used for the first page specified in parameter page_range.
com.foxit.sdk.pdf.HeaderFooter.getText_color | ( | ) |
Get text color used for header-footer content.
com.foxit.sdk.pdf.HeaderFooter.getText_size | ( | ) |
Get text size of header-footer content.
void com.foxit.sdk.pdf.HeaderFooter.set | ( | Font | font, |
float | text_size, | ||
long | text_color, | ||
PageNumberRange | page_range, | ||
RectF | page_margin, | ||
boolean | has_text_shrinked, | ||
boolean | has_fixedsize_for_print, | ||
int | start_page_number, | ||
HeaderFooterContent | content, | ||
boolean | is_to_embed_font, | ||
boolean | is_underline | ||
) |
Set value.
[in] | font | A valid font object which is expected to be used for header-footer content. Please refer to comment of font of current object. |
[in] | text_size | Text size of header-footer content. |
[in] | text_color | Text color used for header-footer content. |
[in] | page_range | A page number range object which specifies pages where current header-footer is used. Please refer to comment of page_range of current object. |
[in] | page_margin | Page margin which specifies the location for header-footer content. Please refer to comment of page_margin of current object. |
[in] | has_text_shrinked | A boolean value that decides whether to shrink text or not. |
[in] | has_fixedsize_for_print | A boolean value that decides whether to use fixed size for print or not. |
[in] | start_page_number | A virtual page number used for the first page specified in parameter page_range. This can be any number, even different from the actual page number of the specified page. If this value is less than 1, Foxit PDF SDK will use 1 for this value when current header-footer object is used in a PDF document. |
[in] | content | Header-footer content. |
[in] | is_to_embed_font | A boolean value that decides whether to embed font or not. |
[in] | is_underline | A boolean value that decides whether to underline text or not. |
com.foxit.sdk.pdf.HeaderFooter.setContent | ( | HeaderFooterContent | value | ) |
Set header-footer content.
[in] | value | Header-footer content. |
com.foxit.sdk.pdf.HeaderFooter.setFont | ( | Font | value | ) |
Set a valid font object which is expected to be used for header-footer content.
[in] | value | A valid font object which is expected to be used for header-footer content. |
com.foxit.sdk.pdf.HeaderFooter.setHas_fixedsize_for_print | ( | boolean | value | ) |
Set a boolean value that decides whether to use fixed size for print or not.
[in] | value | A boolean value that decides whether to use fixed size for print or not. |
com.foxit.sdk.pdf.HeaderFooter.setHas_text_shrinked | ( | boolean | value | ) |
Set a boolean value that decides whether to shrink text or not.
[in] | value | A boolean value that decides whether to shrink text or not. |
com.foxit.sdk.pdf.HeaderFooter.setIs_replace_font | ( | boolean | value | ) |
Set (Reserved) A boolean value that decides whether to replace font or not.
[in] | value | (Reserved) A boolean value that decides whether to replace font or not. Currently Foxit PDF SDK will use this as true all the time. |
com.foxit.sdk.pdf.HeaderFooter.setIs_to_embed_font | ( | boolean | value | ) |
Set a boolean value that decides whether to embed font or not.
[in] | value | A boolean value that decides whether to embed font or not. |
com.foxit.sdk.pdf.HeaderFooter.setIs_underline | ( | boolean | value | ) |
Set a boolean value that decides whether to underline text or not.
[in] | value | A boolean value that decides whether to underline text or not. |
com.foxit.sdk.pdf.HeaderFooter.setPage_margin | ( | RectF | value | ) |
Set page margin which specifies the location for header-footer content.
[in] | value | Page margin which specifies the location for header-footer content. Foxit PDF SDK will use a maring defined as (72.0, 36.0, 72.0, 36.0) as default if no margin value is set by user. |
com.foxit.sdk.pdf.HeaderFooter.setPage_range | ( | PageNumberRange | value | ) |
Set a page number range object which specifies pages where current header-footer is used.
All the values represented in this range should start from 1 and no more than page count of the PDF document, in which current header-footer object is used.
[in] | value | A page number range object which specifies pages where current header-footer is used. |
com.foxit.sdk.pdf.HeaderFooter.setStart_page_number | ( | int | value | ) |
Set a virtual page number used for the first page specified in parameter page_range.
[in] | value | A virtual page number used for the first page specified in parameter page_range. This can be any number, even different from the actual page number of the specified page. |
com.foxit.sdk.pdf.HeaderFooter.setText_color | ( | long | value | ) |
Set text color used for header-footer content.
[in] | value | Text color used for header-footer content. |
com.foxit.sdk.pdf.HeaderFooter.setText_size | ( | float | value | ) |
Set text size of header-footer content.
[in] | value | Text size of header-footer content. |