org.apache.pdfbox.pdmodel.markedcontent
Class PDPropertyList

java.lang.Object
  extended by org.apache.pdfbox.pdmodel.markedcontent.PDPropertyList
All Implemented Interfaces:
COSObjectable

public class PDPropertyList
extends java.lang.Object
implements COSObjectable

This class represents a property list used for the marked content feature to map a resource name to a dictionary.

Since:
PDF 1.2
Version:
$Revision$

Constructor Summary
PDPropertyList()
          Creates a new property list.
PDPropertyList(COSDictionary dict)
          Creates a new instance based on a given COSDictionary.
 
Method Summary
 COSBase getCOSObject()
          Convert this standard java object to a COS object.
 PDOptionalContentGroup getOptionalContentGroup(COSName name)
          Returns the optional content group belonging to the given resource name.
 void putMapping(COSName name, PDOptionalContentGroup ocg)
          Puts a mapping from a resource name to an optional content group.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PDPropertyList

public PDPropertyList()
Creates a new property list.


PDPropertyList

public PDPropertyList(COSDictionary dict)
Creates a new instance based on a given COSDictionary.

Parameters:
dict - the dictionary
Method Detail

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.

getOptionalContentGroup

public PDOptionalContentGroup getOptionalContentGroup(COSName name)
Returns the optional content group belonging to the given resource name.

Parameters:
name - the resource name
Returns:
the optional content group or null if the group was not found

putMapping

public void putMapping(COSName name,
                       PDOptionalContentGroup ocg)
Puts a mapping from a resource name to an optional content group.

Parameters:
name - the resource name
ocg - the optional content group