org.apache.fop.pdf

Class PDFResources

Implemented Interfaces:
PDFWritable

public class PDFResources
extends PDFObject

class representing a /Resources object. /Resources object contain a list of references to the fonts for the document

Field Summary

protected Map
colorSpaces
Map of color spaces (key: color space name)
protected Map
fonts
/Font objects keyed by their internal name
protected Set
gstates
Set of ExtGStates
protected Map
iccColorSpaces
Map of ICC color spaces (key: ICC profile description)
protected Set
patterns
Set of patterns
protected Set
shadings
Set of shadings
protected Set
xObjects
Set of XObjects

Fields inherited from class org.apache.fop.pdf.PDFObject

DATE_FORMAT, log

Constructor Summary

PDFResources(int objnum)
create a /Resources object.

Method Summary

void
addColorSpace(PDFICCBasedColorSpace colorSpace)
Add a ColorSpace dictionary to the resources.
void
addFont(PDFFont font)
add font object to resources list.
void
addFonts(PDFDocument doc, FontInfo fontInfo)
Add the fonts in the font info to this PDF document's Font Resources.
void
addGState(PDFGState gs)
Add a PDFGState to the resources.
void
addPattern(PDFPattern thePattern)
Add the pattern to the resources.
void
addShading(PDFShading theShading)
Add a Shading to the resources.
void
addXObject(PDFXObject xObject)
Add an XObject to the resources.
PDFICCBasedColorSpace
getColorSpace(String name)
Returns a color space by name.
PDFICCBasedColorSpace
getICCColorSpaceByProfileName(String desc)
Returns a ICCBased color space by profile name.
String
toPDFString()
represent the object in PDF This adds the references to all the objects in the current resource context.

Methods inherited from class org.apache.fop.pdf.PDFObject

encode, encodeString, encodeText, formatDateTime, formatObject, getDocument, getDocumentSafely, getGeneration, getObjectID, getObjectNumber, hasObjectNumber, makeReference, output, referencePDF, setDocument, setObjectNumber, toInlinePDFString, toPDF, toPDFString

Field Details

colorSpaces

protected Map colorSpaces
Map of color spaces (key: color space name)

fonts

protected Map fonts
/Font objects keyed by their internal name

gstates

protected Set gstates
Set of ExtGStates

iccColorSpaces

protected Map iccColorSpaces
Map of ICC color spaces (key: ICC profile description)

patterns

protected Set patterns
Set of patterns

shadings

protected Set shadings
Set of shadings

xObjects

protected Set xObjects
Set of XObjects

Constructor Details

PDFResources

public PDFResources(int objnum)
create a /Resources object.
Parameters:
objnum - the object's number

Method Details

addColorSpace

public void addColorSpace(PDFICCBasedColorSpace colorSpace)
Add a ColorSpace dictionary to the resources.
Parameters:
colorSpace - the color space

addFont

public void addFont(PDFFont font)
add font object to resources list.
Parameters:
font - the PDFFont to add

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

addGState

public void addGState(PDFGState gs)
Add a PDFGState to the resources.
Parameters:
gs - the PDFGState to add

addPattern

public void addPattern(PDFPattern thePattern)
Add the pattern to the resources.
Parameters:
thePattern - the pattern to add

addShading

public void addShading(PDFShading theShading)
Add a Shading to the resources.
Parameters:
theShading - the shading to add

addXObject

public void addXObject(PDFXObject xObject)
Add an XObject to the resources.
Parameters:
xObject - the XObject to add

getColorSpace

public PDFICCBasedColorSpace getColorSpace(String 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

getICCColorSpaceByProfileName

public PDFICCBasedColorSpace getICCColorSpaceByProfileName(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

toPDFString

public String toPDFString()
represent the object in PDF This adds the references to all the objects in the current resource context.
Overrides:
toPDFString in interface PDFObject
Returns:
the PDF

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