Top Description Fields Constructors Methods
org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure

public Class PDMarkedContentReference

extends Object
implements COSObjectable
Class Inheritance
All Implemented Interfaces
org.apache.pdfbox.pdmodel.common.COSObjectable
Imports
org.apache.pdfbox.cos.COSDictionary, .COSName, org.apache.pdfbox.pdmodel.PDPage, org.apache.pdfbox.pdmodel.common.COSObjectable
A marked-content reference.
Author
Johannes Koch

Field Summary

Modifier and TypeField and Description
private final COSDictionary
dictionary

public static final String
TYPE

Constructor Summary

AccessConstructor and Description
public
PDMarkedContentReference()

Default constructor

public
PDMarkedContentReference(COSDictionary
the page dictionary
dictionary)

Constructor for an existing marked content reference.

Method Summary

Modifier and TypeMethod and Description
public COSDictionary
getCOSObject()

Implements org.apache.pdfbox.pdmodel.common.COSObjectable.getCOSObject.

Convert this standard java object to a COS object.

public int

Returns:

the marked content identifier
getMCID()

Gets the marked content identifier.

public PDPage

Returns:

the page
getPage()

Gets the page.

public void
setMCID(int
the marked content identifier
mcid)

Sets the marked content identifier.

public void
setPage(PDPage
the page
page)

Sets the page.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

dictionaryback to summary
private final COSDictionary dictionary
TYPEback to summary
public static final String TYPE

Constructor Detail

PDMarkedContentReferenceback to summary
public PDMarkedContentReference()

Default constructor

PDMarkedContentReferenceback to summary
public PDMarkedContentReference(COSDictionary dictionary)

Constructor for an existing marked content reference.

Parameters
dictionary:COSDictionary

the page dictionary

Method Detail

getCOSObjectback to summary
public COSDictionary getCOSObject()

Implements org.apache.pdfbox.pdmodel.common.COSObjectable.getCOSObject.

Doc from org.apache.pdfbox.pdmodel.common.COSObjectable.getCOSObject.

Convert this standard java object to a COS object.

Returns:COSDictionary

The cos object that matches this Java object.

Annotations
@Override
getMCIDback to summary
public int getMCID()

Gets the marked content identifier.

Returns:int

the marked content identifier

getPageback to summary
public PDPage getPage()

Gets the page.

Returns:PDPage

the page

setMCIDback to summary
public void setMCID(int mcid)

Sets the marked content identifier.

Parameters
mcid:int

the marked content identifier

setPageback to summary
public void setPage(PDPage page)

Sets the page.

Parameters
page:PDPage

the page

toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations
@Override