org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure

Class PDMarkedContentReference

java.lang.Object

org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDMarkedContentReference

All Implemented Interfaces:

COSObjectable

public class PDMarkedContentReference
extends java.lang.Object
implements COSObjectable

A marked-content reference.

Version:

$Revision: $

Author:

Johannes Koch

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TYPE

Constructor Summary

Constructors

Constructor and Description
PDMarkedContentReference() Default constructor
PDMarkedContentReference(COSDictionary dictionary) Constructor for an existing marked content reference.

Method Summary

Methods

Modifier and Type	Method and Description
protected COSDictionary	getCOSDictionary()
COSBase	getCOSObject() Convert this standard java object to a COS object.
int	getMCID() Gets the marked content identifier.
PDPage	getPage() Gets the page.
void	setMCID(int mcid) Sets the marked content identifier.
void	setPage(PDPage page) Sets the page.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

TYPE

public static final java.lang.String TYPE

See Also:

Constant Field Values

Constructor Detail

PDMarkedContentReference

public PDMarkedContentReference()

Default constructor

PDMarkedContentReference

public PDMarkedContentReference(COSDictionary dictionary)

Constructor for an existing marked content reference.

Parameters:

dictionary - the page dictionary

Method Detail

getCOSDictionary

protected COSDictionary getCOSDictionary()

getCOSObject

public COSBase getCOSObject()

Convert this standard java object to a COS object.

Specified by:

getCOSObject in interface COSObjectable

Returns:

The cos object that matches this Java object.

getPage

public PDPage getPage()

Gets the page.

Returns:

the page

setPage

public void setPage(PDPage page)

Sets the page.

Parameters:

page - the page

getMCID

public int getMCID()

Gets the marked content identifier.

Returns:

the marked content identifier

setMCID

public void setMCID(int mcid)

Sets the marked content identifier.

Parameters:

mcid - the marked content identifier

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object