fop 2.1

org.apache.fop.pdf
Class PDFResources

java.lang.Object
  extended by org.apache.fop.pdf.PDFObject
      extended by org.apache.fop.pdf.PDFDictionary
          extended by org.apache.fop.pdf.PDFResources
All Implemented Interfaces:
PDFWritable

public class PDFResources
extends PDFDictionary

Class representing a /Resources object. /Resources object contain a list of references to the fonts, patterns, shadings, etc., for the document.


Field Summary
protected  java.util.Map<org.apache.fop.pdf.PDFResources.LazyName,PDFColorSpace> colorSpaces
          Map of color spaces (key: color space name)
protected  java.util.Set<PDFResourceContext> contexts
           
protected  java.util.Map<java.lang.String,PDFDictionary> fonts
          /Font objects keyed by their internal name
protected  java.util.Map<java.lang.String,PDFICCBasedColorSpace> iccColorSpaces
          Map of ICC color spaces (key: ICC profile description)
protected  java.util.Map<java.lang.String,PDFReference> properties
          Named properties
protected  java.util.Set<PDFXObject> xObjects
          Set of XObjects
 
Fields inherited from class org.apache.fop.pdf.PDFDictionary
entries, order
 
Fields inherited from class org.apache.fop.pdf.PDFObject
log
 
Constructor Summary
PDFResources(PDFDocument doc)
          create a /Resources object.
 
Method Summary
 void addColorSpace(PDFColorSpace colorSpace)
          Add a ColorSpace dictionary to the resources.
 void addContext(PDFResourceContext c)
           
 void addFont(PDFFont font)
          add font object to resources list.
 void addFont(java.lang.String name, PDFDictionary font)
           
 void addFonts(PDFDocument doc, FontInfo fontInfo)
          Add the fonts in the font info to this PDF document's Font Resources.
 void addProperty(java.lang.String name, PDFReference property)
          Add a named property.
 void addXObject(PDFXObject xObject)
          Add an XObject to the resources.
 void createFontsAsObj()
           
 void getChildren(java.util.Set<PDFObject> children)
           
 PDFColorSpace getColorSpace(PDFName name)
          Returns a color space by name.
 PDFICCBasedColorSpace getICCColorSpaceByProfileName(java.lang.String desc)
          Returns a ICCBased color space by profile name.
 PDFResources getParentResources()
           
 PDFReference getProperty(java.lang.String name)
          Get a named property.
 int output(java.io.OutputStream stream)
          Write the PDF represention of this object
 void setParentResources(PDFResources p)
           
 
Methods inherited from class org.apache.fop.pdf.PDFDictionary
containsKey, get, getChildren, keySet, put, put, remove, writeDictionary
 
Methods inherited from class org.apache.fop.pdf.PDFObject
contentEquals, encode, encodeBinaryToHexString, encodeString, encodeText, formatObject, getDocument, getDocumentSafely, getGeneration, getObjectID, getObjectNumber, getParent, hasObjectNumber, makeReference, outputInline, referencePDF, setDocument, setObjectNumber, setObjectNumber, setObjectNumber, setParent, toPDF, toPDFString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

fonts

protected java.util.Map<java.lang.String,PDFDictionary> fonts
/Font objects keyed by their internal name


xObjects

protected java.util.Set<PDFXObject> xObjects
Set of XObjects


colorSpaces

protected java.util.Map<org.apache.fop.pdf.PDFResources.LazyName,PDFColorSpace> colorSpaces
Map of color spaces (key: color space name)


iccColorSpaces

protected java.util.Map<java.lang.String,PDFICCBasedColorSpace> iccColorSpaces
Map of ICC color spaces (key: ICC profile description)


properties

protected java.util.Map<java.lang.String,PDFReference> properties
Named properties


contexts

protected java.util.Set<PDFResourceContext> contexts
Constructor Detail

PDFResources

public PDFResources(PDFDocument doc)
create a /Resources object.

Method Detail

addContext

public void addContext(PDFResourceContext c)

setParentResources

public void setParentResources(PDFResources p)

getParentResources

public PDFResources getParentResources()

addFont

public void addFont(PDFFont font)
add font object to resources list.

Parameters:
font - the PDFFont to add

addFont

public void addFont(java.lang.String name,
                    PDFDictionary font)

createFontsAsObj

public void createFontsAsObj()

addFonts

public void addFonts(PDFDocument doc,
                     FontInfo fontInfo)
Add the fonts in the font info to this PDF document's Font Resources.

Parameters:
doc - PDF document to add fonts to
fontInfo - font info object to get font information from

addXObject

public void addXObject(PDFXObject xObject)
Add an XObject to the resources.

Parameters:
xObject - the XObject to add

addColorSpace

public void addColorSpace(PDFColorSpace colorSpace)
Add a ColorSpace dictionary to the resources.

Parameters:
colorSpace - the color space

getICCColorSpaceByProfileName

public PDFICCBasedColorSpace getICCColorSpaceByProfileName(java.lang.String desc)
Returns a ICCBased color space by profile name.

Parameters:
desc - the name of the color space
Returns:
the requested color space or null if it wasn't found

getColorSpace

public PDFColorSpace getColorSpace(PDFName name)
Returns a color space by name.

Parameters:
name - the name of the color space
Returns:
the requested color space or null if it wasn't found

addProperty

public void addProperty(java.lang.String name,
                        PDFReference property)
Add a named property.

Parameters:
name - name of property
property - reference to property value

getProperty

public PDFReference getProperty(java.lang.String name)
Get a named property.

Parameters:
name - name of property

output

public int output(java.io.OutputStream stream)
           throws java.io.IOException
Description copied from class: PDFDictionary
Write the PDF represention of this object

Overrides:
output in class PDFDictionary
Parameters:
stream - the stream to write the PDF to
Returns:
the number of bytes written
Throws:
java.io.IOException - if there is an error writing to the stream

getChildren

public void getChildren(java.util.Set<PDFObject> children)
Overrides:
getChildren in class PDFDictionary

fop 2.1

Copyright 1999-2016 The Apache Software Foundation. All Rights Reserved.