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

public Class PDMarkInfo

extends Object
implements COSObjectable
Class Inheritance
All Implemented Interfaces
org.apache.pdfbox.pdmodel.common.COSObjectable
Imports
org.apache.pdfbox.cos.COSDictionary, org.apache.pdfbox.pdmodel.common.COSObjectable
The MarkInfo provides additional information relevant to specialized uses of structured documents.
Author
Ben Litchfield

Field Summary

Modifier and TypeField and Description
private final COSDictionary
dictionary

Constructor Summary

AccessConstructor and Description
public
PDMarkInfo()

Default Constructor.

public
PDMarkInfo(COSDictionary
The existing dictionary.
dic)

Constructor for an existing MarkInfo element.

Method Summary

Modifier and TypeMethod and Description
public COSDictionary

Returns:

The cos object that matches this Java object.
getCOSObject()

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

Convert this standard java object to a COS object.

public boolean

Returns:

true If this is a tagged PDF.
isMarked()

Tells if this is a tagged PDF.

public boolean

Returns:

true if the suspect flag has been set.
isSuspect()

Tells if this PDF contain 'suspect' tags.

public void
setMarked(boolean
The new marked value.
value)

Set if this is a tagged PDF.

public void
setSuspect(boolean
The new "Suspects" value.
suspect)

Set the value of the suspects property.

public void
setUserProperties(boolean
The new value for this property.
userProps)

Set if the structure elements contain user properties.

public boolean

Returns:

A boolean telling if the structure elements use user properties.
usesUserProperties()

Tells if structure elements use user properties.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

dictionaryback to summary
private final COSDictionary dictionary

Constructor Detail

PDMarkInfoback to summary
public PDMarkInfo()

Default Constructor.

PDMarkInfoback to summary
public PDMarkInfo(COSDictionary dic)

Constructor for an existing MarkInfo element.

Parameters
dic:COSDictionary

The existing dictionary.

Method Detail

getCOSObjectback to summary
public COSDictionary getCOSObject()

Implements 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
isMarkedback to summary
public boolean isMarked()

Tells if this is a tagged PDF.

Returns:boolean

true If this is a tagged PDF.

isSuspectback to summary
public boolean isSuspect()

Tells if this PDF contain 'suspect' tags. See PDF Reference 1.6 section 10.6 "Logical Structure" for more information about this property.

Returns:boolean

true if the suspect flag has been set.

setMarkedback to summary
public void setMarked(boolean value)

Set if this is a tagged PDF.

Parameters
value:boolean

The new marked value.

setSuspectback to summary
public void setSuspect(boolean suspect)

Set the value of the suspects property. See PDF Reference 1.6 section 10.6 "Logical Structure" for more information about this property.

Parameters
suspect:boolean

The new "Suspects" value.

setUserPropertiesback to summary
public void setUserProperties(boolean userProps)

Set if the structure elements contain user properties.

Parameters
userProps:boolean

The new value for this property.

usesUserPropertiesback to summary
public boolean usesUserProperties()

Tells if structure elements use user properties.

Returns:boolean

A boolean telling if the structure elements use user properties.