Foxit PDF SDK

Public Member Functions | List of all members
com.foxit.sdk.pdf.objects.StructMarkedContent Class Reference
Inheritance diagram for com.foxit.sdk.pdf.objects.StructMarkedContent:

## Public Member Functions
| StructMarkedContent ()
| Constructor.
synchronized void | delete ()
| Clean up related C++ resources immediately. More...
int | getMCID () throws com.foxit.sdk.PDFException
| Get marked-content identifier(MCID). More...
StructElement | getParentElement () throws com.foxit.sdk.PDFException
| Get the parent structure element. More...
PDFDictionary | getStmDict () throws com.foxit.sdk.PDFException
| Get PDF dictionary of the content stream that contains the marked-content sequence. More...
PDFDictionary | getStmOwnerDict () throws com.foxit.sdk.PDFException
| Get PDF dictionary of content stream owner. More...
Public Member Functions inherited from com.foxit.sdk.pdf.objects.StructTreeEntity
| StructTreeEntity ()
| Constructor.
| StructTreeEntity (StructTreeEntity other)
| Constructor, with another structure element entity object. More...
synchronized void | delete ()
| Clean up related C++ resources immediately. More...
PDFPage | getPage () throws com.foxit.sdk.PDFException
| Get the related PDF page. More...
int | getType () throws com.foxit.sdk.PDFException
| Get structure tree entity type. More...
boolean | isEmpty ()
| Check whether current object is empty or not. More...
Public Member Functions inherited from com.foxit.sdk.common.Base
synchronized void | delete ()
| Clean up related C++ resources immediately. More...

## Additional Inherited Members
Static Public Attributes inherited from com.foxit.sdk.pdf.objects.StructTreeEntity
static final int | e_StructTreeEntityTypeElement = 0
| Structure tree entity type: Element, which represents a structure element.
static final int | e_StructTreeEntityTypeMarkedContent = 1
| Structure tree entity type: MarkedContent, which represents a marked-content item.
static final int | e_StructTreeEntityTypeObjectContent = 2
| Structure tree entity type: ObjectContent, which represents a PDF object content item, such as annotation and XObject.
static final int | e_UnknownType = -1
| Structure tree entity type: unknown.

## Detailed Description

This class represents a marked-content item.

## Member Function Documentation

## ◆ delete()

synchronized void com.foxit.sdk.pdf.objects.StructMarkedContent.delete | ( |  | ) |

Clean up related C++ resources immediately.

Returns
  None.

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

## ◆ getMCID()

int com.foxit.sdk.pdf.objects.StructMarkedContent.getMCID | ( |  | ) | throws com.foxit.sdk.PDFException

Get marked-content identifier(MCID).

Returns
  Marked-content identifier.

## ◆ getParentElement()

StructElement com.foxit.sdk.pdf.objects.StructMarkedContent.getParentElement | ( |  | ) | throws com.foxit.sdk.PDFException

Get the parent structure element.

Returns
  Parent structure element. If function StructElement::IsEmpty for the returned object returns true, that means current element does not have a parent element.

## ◆ getStmDict()

PDFDictionary com.foxit.sdk.pdf.objects.StructMarkedContent.getStmDict | ( |  | ) | throws com.foxit.sdk.PDFException

Get PDF dictionary of the content stream that contains the marked-content sequence.

The content stream containing the marked-content sequence. This entry should be present only if the marked-content sequence resides in a content stream other than the content stream for the page.

Returns
  PDF dictionary of content stream that contains the marked-content sequence.

## ◆ getStmOwnerDict()

PDFDictionary com.foxit.sdk.pdf.objects.StructMarkedContent.getStmOwnerDict | ( |  | ) | throws com.foxit.sdk.PDFException

Get PDF dictionary of content stream owner.

Returns
  PDF dictionary of content stream owner.