Foxit PDF SDK
com.foxit.sdk.addon.tablegenerator.TableGeneratorCallback Class Reference

Public Member Functions

PageBasicInfo getNewPageBasicInfo (int page_index, float rest_table_height, float table_width)
 A callback function to get new page basic information to be generated to a new page.
More...
 
float getTableTopMarginToPage (int page_index)
 A callback function to get the top margin of the table to be generated to a new page.
More...
 
void release ()
 A callback function used to release current callback object itself.
More...
 

Detailed Description

This class represents a callback object for generating table. All the pure virtual functions in this class are used as callback functions and should be implemented by user.

Member Function Documentation

◆ getNewPageBasicInfo()

PageBasicInfo com.foxit.sdk.addon.tablegenerator.TableGeneratorCallback.getNewPageBasicInfo ( int  page_index,
float  rest_table_height,
float  table_width 
)

A callback function to get new page basic information to be generated to a new page.

This callback function is only used for TableGenerator.insertTablePagesToDocument . It will be triggered if the page width or page height is less than or equal to zero. Users must ensure that the text size is greater than zero in com.foxit.sdk.pdf.annots.RichTextStyle if the content of cell is text.

Parameters
[in]page_indexThe page index. It would start from 0.
[in]rest_table_heightThe rest table height(unit is 1/72 inch).
[in]table_widthThe table width(unit is 1/72 inch).
Returns
The basic page information.(The rotation is not supported currently).

◆ getTableTopMarginToPage()

float com.foxit.sdk.addon.tablegenerator.TableGeneratorCallback.getTableTopMarginToPage ( int  page_index)

A callback function to get the top margin of the table to be generated to a new page.

Parameters
[in]page_indexThe page index. It would start from 0.
Returns
The table top margin to page.

◆ release()

void com.foxit.sdk.addon.tablegenerator.TableGeneratorCallback.release ( )

A callback function used to release current callback object itself.

Returns
None.