Public Member Functions | |
int | addItem (String tag_name, PDFDictionary property_dict) throws com.foxit.sdk.PDFException |
Add a new marked content item. More... | |
int | getItemCount () |
Get the count of marked content items. More... | |
int | getItemMCID (int index) throws com.foxit.sdk.PDFException |
Get marked-content identifier (MCID) of a marked content item specified by index. More... | |
PDFDictionary | getItemPropertyDict (int index) throws com.foxit.sdk.PDFException |
Get the property dictionary of a marked content item specified by index. More... | |
String | getItemTagName (int index) throws com.foxit.sdk.PDFException |
Get the tag name of a marked content item specified by index. More... | |
boolean | hasTag (String tag_name) throws com.foxit.sdk.PDFException |
Check whether current marked content object has a specified marked content item or not. More... | |
boolean | removeItem (String tag_name) throws com.foxit.sdk.PDFException |
Remove a marked content item by tag name. More... | |
Marked-content operators (PDF 1.2) identify a portion of a PDF content stream as a marked-content element of interest to a particular application or PDF plug-in extension. For more details, please refer to Section 10.5 "Marked Content" in <PDF Reference 1.7>.
To get a marked content object, please use function GraphicsObject::getMarkedContent.
int com.foxit.sdk.pdf.graphics.MarkedContent.addItem | ( | String | tag_name, |
PDFDictionary | property_dict | ||
) | throws com.foxit.sdk.PDFException |
Add a new marked content item.
tag_name | New tag name. It should not be an empty string. If parameter tag_name exists in current marked content object, it cannot be added to current marked content object again. |
property_dict | A property dictionary. null means the new marked content item will not have a property dictionary. If this dictionary is newly created and not set to other object yet, user should release this dictionary object after calling this function. |
int com.foxit.sdk.pdf.graphics.MarkedContent.getItemCount | ( | ) |
Get the count of marked content items.
A marked content object may be nested one within another, and this function is used to get the count of marked content items in the current marked content sequence.
int com.foxit.sdk.pdf.graphics.MarkedContent.getItemMCID | ( | int | index | ) | throws com.foxit.sdk.PDFException |
Get marked-content identifier (MCID) of a marked content item specified by index.
index | Item index. Valid range: from 0 to (count-1). count is returned by function MarkedContent::getItemCount. |
PDFDictionary com.foxit.sdk.pdf.graphics.MarkedContent.getItemPropertyDict | ( | int | index | ) | throws com.foxit.sdk.PDFException |
Get the property dictionary of a marked content item specified by index.
index | Item index. Valid range: from 0 to (count-1). count is returned by function MarkedContent::getItemCount. |
String com.foxit.sdk.pdf.graphics.MarkedContent.getItemTagName | ( | int | index | ) | throws com.foxit.sdk.PDFException |
Get the tag name of a marked content item specified by index.
A marked content object may be nested one within another, and this function is used to get the count of marked content items in the current marked content sequence.
index | Item index. Valid range: from 0 to (count-1). count is returned by function MarkedContent::getItemCount. |
boolean com.foxit.sdk.pdf.graphics.MarkedContent.hasTag | ( | String | tag_name | ) | throws com.foxit.sdk.PDFException |
Check whether current marked content object has a specified marked content item or not.
tag_name | The tag name to be checked. |
boolean com.foxit.sdk.pdf.graphics.MarkedContent.removeItem | ( | String | tag_name | ) | throws com.foxit.sdk.PDFException |
Remove a marked content item by tag name.
tag_name | Tag name. It should not be an empty string. |