Package org.apache.pdfbox.pdmodel
Class PDResources
java.lang.Object
org.apache.pdfbox.pdmodel.PDResources
- All Implemented Interfaces:
COSObjectable
This represents a set of resources available at the page/pages/stream level.
- Author:
- Ben Litchfield, BM
-
Constructor Summary
ConstructorsConstructorDescriptionDefault constructor.PDResources
(COSDictionary resourceDictionary) Prepopulated resources. -
Method Summary
Modifier and TypeMethodDescriptionAdds the given font to the resources of the current page.Adds the given font to the resources of the current page using the given font key.addXObject
(PDXObject xobject, String prefix) Adds the given XObject to the resources of the current the page.void
clear()
Calling this will release all cached information.This will get the map of colorspaces.This will get the underlying dictionary.Convert this standard java object to a COS object.getFonts()
This will get the map of fonts.Deprecated.This will get the map of graphic states.Deprecated.usegetXObjects()
instead, as the images map isn't synchronized with the XObjects map.This will get the map of patterns.Returns the dictionary mapping resource names to property list dictionaries for marked content.This will get the map of shadings.This will get the map of PDXObjects that are in the resource dictionary.void
setColorSpaces
(Map<String, PDColorSpace> csValue) This will set the map of colorspaces.void
This will set the map of fonts.void
This will set the map of graphics states.void
setPatterns
(Map<String, PDPatternResources> patternsValue) This will set the map of patterns.void
setProperties
(PDPropertyList props) Sets the dictionary mapping resource names to property list dictionaries for marked content.void
setShadings
(Map<String, PDShadingResources> shadingsValue) This will set the map of shadings.void
setXObjects
(Map<String, PDXObject> xobjectsValue) This will set the map of xobjects.
-
Constructor Details
-
PDResources
public PDResources()Default constructor. -
PDResources
Prepopulated resources.- Parameters:
resourceDictionary
- The cos dictionary for this resource.
-
-
Method Details
-
getCOSDictionary
This will get the underlying dictionary.- Returns:
- The dictionary for these resources.
-
getCOSObject
Convert this standard java object to a COS object.- Specified by:
getCOSObject
in interfaceCOSObjectable
- Returns:
- The cos object that matches this Java object.
-
clear
public void clear()Calling this will release all cached information. -
getFonts
Deprecated.due to some side effects font caching is no longer supported, usegetFonts()
insteadThis will get the map of fonts. This will never return null. The keys are string and the values are PDFont objects.- Parameters:
fontCache
- A map of existing PDFont objects to reuse.- Returns:
- The map of fonts.
- Throws:
IOException
- If there is an error getting the fonts.
-
getFonts
This will get the map of fonts. This will never return null.- Returns:
- The map of fonts.
-
getXObjects
This will get the map of PDXObjects that are in the resource dictionary. This will never return null.- Returns:
- The map of xobjects.
-
getImages
Deprecated.usegetXObjects()
instead, as the images map isn't synchronized with the XObjects map.This will get the map of images. An empty map will be returned if there are no underlying images. So far the keys are COSName of the image and the value is the corresponding PDXObjectImage.- Returns:
- The map of images.
- Throws:
IOException
- If there is an error writing the picture.
-
setFonts
This will set the map of fonts.- Parameters:
fontsValue
- The new map of fonts.
-
setXObjects
This will set the map of xobjects.- Parameters:
xobjectsValue
- The new map of xobjects.
-
getColorSpaces
This will get the map of colorspaces. This will return null if the underlying resources dictionary does not have a colorspace dictionary. The keys are string and the values are PDColorSpace objects.- Returns:
- The map of colorspaces.
-
setColorSpaces
This will set the map of colorspaces.- Parameters:
csValue
- The new map of colorspaces.
-
getGraphicsStates
This will get the map of graphic states. This will return null if the underlying resources dictionary does not have a graphics dictionary. The keys are the graphic state name as a String and the values are PDExtendedGraphicsState objects.- Returns:
- The map of extended graphic state objects.
-
setGraphicsStates
This will set the map of graphics states.- Parameters:
states
- The new map of states.
-
getProperties
Returns the dictionary mapping resource names to property list dictionaries for marked content.- Returns:
- the property list
-
setProperties
Sets the dictionary mapping resource names to property list dictionaries for marked content.- Parameters:
props
- the property list
-
getPatterns
This will get the map of patterns. This will return null if the underlying resources dictionary does not have a patterns dictionary. The keys are the pattern name as a String and the values are PDPatternResources objects.- Returns:
- The map of pattern resources objects.
- Throws:
IOException
- If there is an error getting the pattern resources.
-
setPatterns
This will set the map of patterns.- Parameters:
patternsValue
- The new map of patterns.
-
getShadings
This will get the map of shadings. This will return null if the underlying resources dictionary does not have a shading dictionary. The keys are the shading name as a String and the values are PDShadingResources objects.- Returns:
- The map of shading resources objects.
- Throws:
IOException
- If there is an error getting the shading resources.
-
setShadings
This will set the map of shadings.- Parameters:
shadingsValue
- The new map of shadings.
-
addFont
Adds the given font to the resources of the current page.- Parameters:
font
- the font to be added- Returns:
- the font name to be used within the content stream.
-
addFont
Adds the given font to the resources of the current page using the given font key.- Parameters:
font
- the font to be addedfontKey
- key to used to map to the given font- Returns:
- the font name to be used within the content stream.
-
addXObject
Adds the given XObject to the resources of the current the page.- Parameters:
xobject
- the XObject to be addedprefix
- the prefix to be used for the name- Returns:
- the XObject name to be used within the content stream.
-
getFonts()
instead