com.foxit.sdk.addon.accessibility.TaggedPDF Class Reference

Inheritance diagram for com.foxit.sdk.addon.accessibility.TaggedPDF:

Public Member Functions
	TaggedPDF (PDFDoc doc, boolean is_fix) throws com.foxit.sdk.PDFException
	Constructor. More...
	TaggedPDF (TaggedPDF other)
	Constructor, with another tagged PDF object. More...
boolean	canTagDocument () throws com.foxit.sdk.PDFException
	Check whether the current PDF document can be tagged. More...
boolean	canTagFormFields () throws com.foxit.sdk.PDFException
	Check whether the form fields in the current PDF document can be auto tagged. More...
synchronized void	delete ()
	Clean up related C++ resources immediately. More...
int	getCurrentFigureElementIndex () throws com.foxit.sdk.PDFException
	Get current figure element index. More...
String	getFigureAlternateText (int figure_index) throws com.foxit.sdk.PDFException
	Get the alternate text of the figure. More...
int	getFigureCount () throws com.foxit.sdk.PDFException
	Get the count of figures in tagged document, excluding the decorative figures. More...
int	getFigurePageIndex (int figure_index) throws com.foxit.sdk.PDFException
	Get the figure page index by the figure index. More...
RectF	getFigureRect (int figure_index) throws com.foxit.sdk.PDFException
	Get the rectangle of figure. More...
AlternateTextFigureData	getNextFigureData () throws com.foxit.sdk.PDFException
	Get next figure data. More...
AlternateTextFigureData	getPrevFigureData () throws com.foxit.sdk.PDFException
	Get previous figure data. More...
boolean	hasFigures () throws com.foxit.sdk.PDFException
	Check whether the document has figures. More...
boolean	isAlreadyTagged () throws com.foxit.sdk.PDFException
	Check whether the current PDF document is already tagged. More...
boolean	isEmpty ()
	Check whether current object is empty or not. More...
void	removeTags () throws com.foxit.sdk.PDFException
	Remove the accessibility tag tree tree for the current PDF document. More...
boolean	saveFigureData () throws com.foxit.sdk.PDFException
	Save figure data. More...
boolean	setAsDecorativeFigure (int figure_index) throws com.foxit.sdk.PDFException
	Decorate the figure.The decorative figure can not set alternate text. More...
void	setCallback (TaggedPDFCallback callback) throws com.foxit.sdk.PDFException
void	setCurrentFigureDataInfo (boolean is_decorative, String alternate_text) throws com.foxit.sdk.PDFException
	Set current figure data info. More...
void	setFigureAlternateText (int figure_index, String alternate_text) throws com.foxit.sdk.PDFException
	Set figure alternate text. More...
Progressive	startTagDocument (PauseCallback pause, StreamCallback report_callback, AutoTagProviderCallback callback) throws com.foxit.sdk.PDFException
	Start to auto tag the given PDF document with specified tagged settings. More...
boolean	tagFormFields () throws com.foxit.sdk.PDFException
	Tag form fields in the current PDF document. More...

Detailed Description

This class represents settings for a tagged PDF document.The tagged PDF means that only tagging information for PDF structure here. Before using any class or methods in this module, please ensure Foxit PDF SDK has been initialized successfully by function common.Library.initialize with a key including "Accessibility" module.

See also

com.foxit.sdk.common.Library

Constructor & Destructor Documentation

TaggedPDF() [1/2]

com.foxit.sdk.addon.accessibility.TaggedPDF.TaggedPDF	(	PDFDoc	doc,
		boolean	is_fix
	)		throws com.foxit.sdk.PDFException

Constructor.

Parameters

[in]	doc	A valid PDF document object to be tagged.
[in]	is_fix	Whether this tagged PDF is used for fix operation. If true, figure data methods will use fix alternate text; if false, they will use no-fix alternate text. Default value: false.

This constructor is to construct a tagged PDF object with specified settings.

TaggedPDF() [2/2]

com.foxit.sdk.addon.accessibility.TaggedPDF.TaggedPDF

(

TaggedPDF

other

)

Constructor, with another tagged PDF object.

Parameters

[in]

other

Another tagged PDF object.

Member Function Documentation

canTagDocument()

boolean com.foxit.sdk.addon.accessibility.TaggedPDF.canTagDocument

(

)

throws com.foxit.sdk.PDFException

Check whether the current PDF document can be tagged.

Returns

true means the document can be tagged, while false means not.

canTagFormFields()

boolean com.foxit.sdk.addon.accessibility.TaggedPDF.canTagFormFields

(

)

throws com.foxit.sdk.PDFException

Check whether the form fields in the current PDF document can be auto tagged.

The function is only used for a tagged PDF document. Please call function pdf.PDFDoc.isTaggedPDF to check current PDF document whether is a tagged PDF document.

Returns

true means form fields can be auto tagged, while false means not.

delete()

synchronized void com.foxit.sdk.addon.accessibility.TaggedPDF.delete

(

)

Clean up related C++ resources immediately.

Returns

None.

Note

Once this function is called, current object cannot be used anymore.

Reimplemented from com.foxit.sdk.common.Base.

getCurrentFigureElementIndex()

int com.foxit.sdk.addon.accessibility.TaggedPDF.getCurrentFigureElementIndex

(

)

throws com.foxit.sdk.PDFException

Get current figure element index.

Returns

The current figure element index.

getFigureAlternateText()

String com.foxit.sdk.addon.accessibility.TaggedPDF.getFigureAlternateText

(

int

figure_index

)

throws com.foxit.sdk.PDFException

Get the alternate text of the figure.

The alternate text is the human-readable text, the PDF documents can be enhanced by providing alternate text for images, formulas, or other items that do not translate naturally into text. The function is only used for a tagged PDF document. Please call function pdf.PDFDoc.isTaggedPDF to check current PDF document whether is a tagged PDF document.

Parameters

[in]

figure_index

The index of figure. Valid range: from 0 to (count-1). count is returned by function TaggedPDF.getFigureCount .

Returns

The alternative descriptions text.

getFigureCount()

int com.foxit.sdk.addon.accessibility.TaggedPDF.getFigureCount

(

)

throws com.foxit.sdk.PDFException

Get the count of figures in tagged document, excluding the decorative figures.

The function is only used for a tagged PDF document. Please call function pdf.PDFDoc.isTaggedPDF to check current PDF document whether is a tagged PDF document.

Returns

The count of figures.

getFigurePageIndex()

int com.foxit.sdk.addon.accessibility.TaggedPDF.getFigurePageIndex

(

int

figure_index

)

throws com.foxit.sdk.PDFException

Get the figure page index by the figure index.

The function is only used for a tagged PDF document. Please call function pdf.PDFDoc.isTaggedPDF to check current PDF document whether is a tagged PDF document.

Parameters

[in]

figure_index

The index of figure. Valid range: from 0 to (count-1). count is returned by function TaggedPDF.getFigureCount .

Returns

The page index. Valid value would starts from 0. If there is any error, this function will return -1.

getFigureRect()

RectF com.foxit.sdk.addon.accessibility.TaggedPDF.getFigureRect

(

int

figure_index

)

throws com.foxit.sdk.PDFException

Get the rectangle of figure.

The function is only used for a tagged PDF document. Please call function pdf.PDFDoc.isTaggedPDF to check current PDF document whether is a tagged PDF document.

Parameters

[in]

figure_index

The index of figure. Valid range: from 0 to (count-1). count is returned by function TaggedPDF.getFigureCount .

Returns

The figure rectangle.If there is any error, this function will return an empty rectangle.

getNextFigureData()

AlternateTextFigureData com.foxit.sdk.addon.accessibility.TaggedPDF.getNextFigureData

(

)

throws com.foxit.sdk.PDFException

Get next figure data.

Returns

The next figure data object.

getPrevFigureData()

AlternateTextFigureData com.foxit.sdk.addon.accessibility.TaggedPDF.getPrevFigureData

(

)

throws com.foxit.sdk.PDFException

Get previous figure data.

Returns

The previous figure data object.

hasFigures()

boolean com.foxit.sdk.addon.accessibility.TaggedPDF.hasFigures

(

)

throws com.foxit.sdk.PDFException

Check whether the document has figures.

Returns

true means the document has figures, while false means not.

isAlreadyTagged()

boolean com.foxit.sdk.addon.accessibility.TaggedPDF.isAlreadyTagged

(

)

throws com.foxit.sdk.PDFException

Check whether the current PDF document is already tagged.

Returns

true means the document is already tagged, while false means not.

isEmpty()

boolean com.foxit.sdk.addon.accessibility.TaggedPDF.isEmpty

(

)

Check whether current object is empty or not.

When the current object is empty, that means current object is useless.

Returns

true means current object is empty, while false means not.

removeTags()

void com.foxit.sdk.addon.accessibility.TaggedPDF.removeTags

(

)

throws com.foxit.sdk.PDFException

Remove the accessibility tag tree tree for the current PDF document.

This method releases the accessibility-side tag tree/cache associated with the document.

Returns

None.

saveFigureData()

boolean com.foxit.sdk.addon.accessibility.TaggedPDF.saveFigureData

(

)

throws com.foxit.sdk.PDFException

Save figure data.

Returns

true means success, while false means not.

setAsDecorativeFigure()

boolean com.foxit.sdk.addon.accessibility.TaggedPDF.setAsDecorativeFigure

(

int

figure_index

)

throws com.foxit.sdk.PDFException

Decorate the figure.The decorative figure can not set alternate text.

The function is only used for a tagged PDF document. Please call function pdf.PDFDoc.isTaggedPDF to check current PDF document whether is a tagged PDF document.

Parameters

[in]

figure_index

The index of figure. Valid range: from 0 to (count-1). count is returned by function TaggedPDF.getFigureCount .

Returns

true means decorate figure successed, while false means not.

setCallback()

void com.foxit.sdk.addon.accessibility.TaggedPDF.setCallback

(

TaggedPDFCallback

callback

)

throws com.foxit.sdk.PDFException

Deprecated:

This function has been deprecated since Foxit PDF SDK 12.0. Please use function TaggedPDF.startTagDocument instead, which receives the report callbacks (report stream and localized report text) directly as parameters.

If this function is not called, that means no callback will be used.

Parameters

[in]

callback

A TaggedPDFCallback object which is implemented by user. User can change some information/data during tagged PDF document by this callback. Please ensure that the callback object keeps valid until the life-cycle of current tagged PDF object ends. If this is null, that means to use default information/data.

Returns

None.

setCurrentFigureDataInfo()

void com.foxit.sdk.addon.accessibility.TaggedPDF.setCurrentFigureDataInfo	(	boolean	is_decorative,
		String	alternate_text
	)		throws com.foxit.sdk.PDFException

Set current figure data info.

Parameters

[in]	is_decorative	Whether the figure is decorative.
[in]	alternate_text	The alternate text.

Returns

None.

setFigureAlternateText()

void com.foxit.sdk.addon.accessibility.TaggedPDF.setFigureAlternateText	(	int	figure_index,
		String	alternate_text
	)		throws com.foxit.sdk.PDFException

Set figure alternate text.

The alternate text is the human-readable text, the PDF documents can be enhanced by providing alternate text for images, formulas, or other items that do not translate naturally into text. The function is only used for a tagged PDF document. Please call function pdf.PDFDoc.isTaggedPDF to check current PDF document whether is a tagged PDF document.

Parameters

[in]	figure_index	The index of figure. Valid range: from 0 to (count-1). count is returned by function TaggedPDF.getFigureCount .
[in]	alternate_text	The alternative descriptions text.

Returns

None.

startTagDocument()

Progressive com.foxit.sdk.addon.accessibility.TaggedPDF.startTagDocument	(	PauseCallback	pause,
		StreamCallback	report_callback,
		AutoTagProviderCallback	callback
	)		throws com.foxit.sdk.PDFException

Start to auto tag the given PDF document with specified tagged settings.

If user wants to get specific tag results during the tagging document process, please pass a valid report_callback and/or callback parameter to this function.

Parameters

[in]	pause	Pause object which decides if the auto tagging process needs to be paused. This can be null which means not to pause during the tagging process. If this is not null, it should be a valid pause object implemented by user. Default value: null.
[in]	report_callback	A com.foxit.sdk.common.fxcrt.StreamCallback object used to receive the generated auto tag report stream. This can be null which means not to output the report. If this is not null, it should be a valid stream callback object implemented by user. Default value: null.
[in]	callback	An com.foxit.sdk.addon.accessibility.AutoTagProviderCallback object which is implemented by user. User can provide the localized report text during tagged PDF document by this callback. Please ensure that the callback object keeps valid until the life-cycle of current tagged PDF object ends. If this is null, that means to use default report text.

Returns

A progressive object. Please check the rate of current progress by function common.Progressive.getRateOfProgress . If the rate is not 100 yet, call function common.Progressive.resume to continue the progress until the progress is finished.

tagFormFields()

boolean com.foxit.sdk.addon.accessibility.TaggedPDF.tagFormFields

(

)

throws com.foxit.sdk.PDFException

Tag form fields in the current PDF document.

The function is only used for a tagged PDF document. Please call function pdf.PDFDoc.isTaggedPDF to check current PDF document whether is a tagged PDF document.

Returns

true means form fields tagged successfully, while false means not.