Foxit PDF SDK
com.foxit.sdk.addon.conversion.HTML2PDFSettingData Class Reference

Public Member Functions

 HTML2PDFSettingData ()
 Constructor.

 
 HTML2PDFSettingData (float page_width, float page_height, boolean is_to_page_scale, RectF page_margin, boolean is_convert_link, int rotate_degrees, boolean is_generate_tag, int page_mode)
 Constructor, with parameters.
More...
 
boolean getIs_convert_link ()
 Get used to decide whether the web link should be coverted or not. More...
 
boolean getIs_generate_tag ()
 Get used to decide whether the tag should be generated or not. More...
 
boolean getIs_to_page_scale ()
 Get used to decide whether to scale the coverted PDF page or not. More...
 
float getPage_height ()
 Get the page height used for the coverted PDF document. More...
 
RectF getPage_margin ()
 Get the page margin used for coverted PDF document. More...
 
int getPage_mode ()
 Get the page mode used for the converting. More...
 
float getPage_width ()
 Get the page width used for the coverted PDF document. More...
 
int getRotate_degrees ()
 Get the rotation degree used for the coverted PDF page. More...
 
void setIs_convert_link (boolean value)
 Set used to decide whether the web link should be coverted or not. More...
 
void setIs_generate_tag (boolean value)
 Set used to decide whether the tag should be generated or not. More...
 
void setIs_to_page_scale (boolean value)
 Set used to decide whether to scale the coverted PDF page or not. More...
 
void setPage_height (float value)
 Set the page height used for the coverted PDF document. More...
 
void setPage_margin (RectF value)
 Set the page margin used for coverted PDF document. More...
 
void setPage_mode (int value)
 Set the page mode used for the converting. More...
 
void setPage_width (float value)
 Set the page width used for the coverted PDF document. More...
 
void setRotate_degrees (int value)
 Set the rotation degree used for the coverted PDF page. More...
 

Static Public Attributes

static final int e_PageModeMultiplePage = 1
 Multiple page mode.

 
static final int e_PageModeSinglePage = 0
 Single page mode.

 

Detailed Description

This class represents setting data used for converting HTML to PDF.

Constructor & Destructor Documentation

◆ HTML2PDFSettingData()

com.foxit.sdk.addon.conversion.HTML2PDFSettingData.HTML2PDFSettingData ( float  page_width,
float  page_height,
boolean  is_to_page_scale,
RectF  page_margin,
boolean  is_convert_link,
int  rotate_degrees,
boolean  is_generate_tag,
int  page_mode 
)

Constructor, with parameters.

Parameters
[in]page_widthThe page width used for the coverted PDF document.
[in]page_heightThe page height used for the coverted PDF document. This would be ignored if page mode com.foxit.sdk.addon.conversion.HTML2PDFSettingData.e_PageModeSinglePage is used.
[in]is_to_page_scaleUsed to decide whether to scale the coverted PDF page or not.
[in]page_marginThe page margin used for coverted PDF document.
[in]is_convert_linkUsed to decide whether the web link should be coverted or not.
[in]rotate_degreesThe rotation degree used for the coverted PDF page.Please refer to values starting from com.foxit.sdk.common.Constants.e_Rotation0 and this should be one of these values.
[in]is_generate_tagUsed to decide whether the tag should be generated or not.
[in]page_modeThe page mode used for the converting.. Please refer to values starting from com.foxit.sdk.addon.conversion.HTML2PDFSettingData.e_PageModeSinglePage and this should be one of these values.
Returns
None.

Member Function Documentation

◆ getIs_convert_link()

com.foxit.sdk.addon.conversion.HTML2PDFSettingData.getIs_convert_link ( )

Get used to decide whether the web link should be coverted or not.

Returns
Used to decide whether the web link should be coverted or not.

◆ getIs_generate_tag()

com.foxit.sdk.addon.conversion.HTML2PDFSettingData.getIs_generate_tag ( )

Get used to decide whether the tag should be generated or not.

Returns
Used to decide whether the tag should be generated or not.

◆ getIs_to_page_scale()

com.foxit.sdk.addon.conversion.HTML2PDFSettingData.getIs_to_page_scale ( )

Get used to decide whether to scale the coverted PDF page or not.

Returns
Used to decide whether to scale the coverted PDF page or not.

◆ getPage_height()

com.foxit.sdk.addon.conversion.HTML2PDFSettingData.getPage_height ( )

Get the page height used for the coverted PDF document.

Note
The page height would be ignored if page mode com.foxit.sdk.addon.conversion.HTML2PDFSettingData.e_PageModeSinglePage is used.
Returns
The page height used for the coverted PDF document.

◆ getPage_margin()

com.foxit.sdk.addon.conversion.HTML2PDFSettingData.getPage_margin ( )

Get the page margin used for coverted PDF document.

Note
This value does not represents a rectangle. It just defines the left margin, bottom margin, right margin and top margin of a PDF page.
Returns
The page margin used for coverted PDF document.

◆ getPage_mode()

com.foxit.sdk.addon.conversion.HTML2PDFSettingData.getPage_mode ( )

Get the page mode used for the converting.

Returns
The page mode used for the converting. Please refer to values starting from com.foxit.sdk.addon.conversion.HTML2PDFSettingData.e_PageModeSinglePage and this should be one of these values.

◆ getPage_width()

com.foxit.sdk.addon.conversion.HTML2PDFSettingData.getPage_width ( )

Get the page width used for the coverted PDF document.

Returns
The page width used for the coverted PDF document.

◆ getRotate_degrees()

com.foxit.sdk.addon.conversion.HTML2PDFSettingData.getRotate_degrees ( )

Get the rotation degree used for the coverted PDF page.

Returns
The rotation degree used for the coverted PDF page.Please refer to values starting from com.foxit.sdk.common.Constants.e_Rotation0 and this should be one of these values.

◆ setIs_convert_link()

com.foxit.sdk.addon.conversion.HTML2PDFSettingData.setIs_convert_link ( boolean  value)

Set used to decide whether the web link should be coverted or not.

Parameters
[in]valueUsed to decide whether the web link should be coverted or not.
Returns
None.

◆ setIs_generate_tag()

com.foxit.sdk.addon.conversion.HTML2PDFSettingData.setIs_generate_tag ( boolean  value)

Set used to decide whether the tag should be generated or not.

Parameters
[in]valueUsed to decide whether the tag should be generated or not.
Returns
None.

◆ setIs_to_page_scale()

com.foxit.sdk.addon.conversion.HTML2PDFSettingData.setIs_to_page_scale ( boolean  value)

Set used to decide whether to scale the coverted PDF page or not.

Parameters
[in]valueUsed to decide whether to scale the coverted PDF page or not.
Returns
None.

◆ setPage_height()

com.foxit.sdk.addon.conversion.HTML2PDFSettingData.setPage_height ( float  value)

Set the page height used for the coverted PDF document.

Note
The page height would be ignored if page mode com.foxit.sdk.addon.conversion.HTML2PDFSettingData.e_PageModeSinglePage is used.
Parameters
[in]valueThe page height used for the coverted PDF document.
Returns
None.

◆ setPage_margin()

com.foxit.sdk.addon.conversion.HTML2PDFSettingData.setPage_margin ( RectF  value)

Set the page margin used for coverted PDF document.

Note
This value does not represents a rectangle. It just defines the left margin, bottom margin, right margin and top margin of a PDF page.
Parameters
[in]valueThe page margin used for coverted PDF document.
Returns
None.

◆ setPage_mode()

com.foxit.sdk.addon.conversion.HTML2PDFSettingData.setPage_mode ( int  value)

Set the page mode used for the converting.

Parameters
[in]valueThe page mode used for the converting. Please refer to values starting from com.foxit.sdk.addon.conversion.HTML2PDFSettingData.e_PageModeSinglePage and this should be one of these values.
Returns
None.

◆ setPage_width()

com.foxit.sdk.addon.conversion.HTML2PDFSettingData.setPage_width ( float  value)

Set the page width used for the coverted PDF document.

Parameters
[in]valueThe page width used for the coverted PDF document.
Returns
None.

◆ setRotate_degrees()

com.foxit.sdk.addon.conversion.HTML2PDFSettingData.setRotate_degrees ( int  value)

Set the rotation degree used for the coverted PDF page.

Parameters
[in]valueThe rotation degree used for the coverted PDF page.Please refer to values starting from com.foxit.sdk.common.Constants.e_Rotation0 and this should be one of these values.
Returns
None.