Deprecated API

Contents

• Deprecated Classes
• Deprecated Fields
• Deprecated Methods
• Deprecated Constructors

Deprecated Classes

Class and Description
org.apache.pdfbox.pdmodel.encryption.PDEncryptionDictionary Use PDEncryption instead

Deprecated Fields

Field and Description
org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences.BOUNDARY_ART_BOX use PDViewerPreferences.BOUNDARY instead
org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences.BOUNDARY_BLEED_BOX use PDViewerPreferences.BOUNDARY instead
org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences.BOUNDARY_CROP_BOX use PDViewerPreferences.BOUNDARY instead
org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences.BOUNDARY_MEDIA_BOX use PDViewerPreferences.BOUNDARY instead
org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences.BOUNDARY_TRIM_BOX use PDViewerPreferences.BOUNDARY instead
org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences.NON_FULL_SCREEN_PAGE_MODE_USE_NONE use PDViewerPreferences.NON_FULL_SCREEN_PAGE_MODE instead
org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences.NON_FULL_SCREEN_PAGE_MODE_USE_OPTIONAL_CONTENT use PDViewerPreferences.NON_FULL_SCREEN_PAGE_MODE instead
org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences.NON_FULL_SCREEN_PAGE_MODE_USE_OUTLINES use PDViewerPreferences.NON_FULL_SCREEN_PAGE_MODE instead
org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences.NON_FULL_SCREEN_PAGE_MODE_USE_THUMBS use PDViewerPreferences.NON_FULL_SCREEN_PAGE_MODE instead
org.apache.pdfbox.cos.COSNumber.ONE Use the COSInteger.ONE constant instead
org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences.READING_DIRECTION_L2R use PDViewerPreferences.READING_DIRECTION instead
org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences.READING_DIRECTION_R2L use PDViewerPreferences.READING_DIRECTION instead
org.apache.pdfbox.cos.COSNumber.ZERO Use the COSInteger.ZERO constant instead

Deprecated Methods

Method and Description
org.apache.pdfbox.pdmodel.PDPageContentStream.addBezier31(float, float, float, float) Use PDPageContentStream.curveTo1(float, float, float, float) instead.
org.apache.pdfbox.pdmodel.PDPageContentStream.addBezier312(float, float, float, float, float, float) Use PDPageContentStream.curveTo(float, float, float, float, float, float) instead.
org.apache.pdfbox.pdmodel.PDPageContentStream.addBezier32(float, float, float, float) Use PDPageContentStream.curveTo2(float, float, float, float) instead.
org.apache.pdfbox.pdmodel.common.PDStream.addCompression() This method is inefficient. To copying an existing InputStream, use PDStream.PDStream(PDDocument, InputStream, COSName) instead, with COSName.FLATE_DECODE as the final argument. Otherwise, to write new compressed data, use PDStream.createOutputStream(COSName), with COSName.FLATE_DECODE as the argument.
org.apache.pdfbox.pdmodel.PDPageContentStream.addLine(float, float, float, float) Use moveto(xStart,yStart) followed by lineTo(xEnd,yEnd).
org.apache.pdfbox.pdmodel.PDPageContentStream.addPolygon(float[], float[]) Use PDPageContentStream.moveTo(float, float) and PDPageContentStream.lineTo(float, float) methods instead.
org.apache.pdfbox.pdmodel.PDDocument.addSignatureField(List<PDSignatureField>, SignatureInterface, SignatureOptions) The method is misleading, because only one signature may be added in a document. The method will be removed in the future.
org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSignDesigner.affineTransformParams(byte[]) use PDVisibleSignDesigner.transform(java.awt.geom.AffineTransform).
org.apache.pdfbox.pdmodel.PDPageContentStream.appendCOSName(COSName) Usage of this method is discouraged.
org.apache.pdfbox.pdmodel.PDPageContentStream.appendRawCommands(byte[]) Usage of this method is discouraged.
org.apache.pdfbox.pdmodel.PDPageContentStream.appendRawCommands(double) Usage of this method is discouraged.
org.apache.pdfbox.pdmodel.PDPageContentStream.appendRawCommands(float) Usage of this method is discouraged.
org.apache.pdfbox.pdmodel.PDPageContentStream.appendRawCommands(int) Usage of this method is discouraged.
org.apache.pdfbox.pdmodel.PDPageContentStream.appendRawCommands(String) Usage of this method is discouraged.
org.apache.pdfbox.pdmodel.PDPageContentStream.beginMarkedContentSequence(COSName) Use PDPageContentStream.beginMarkedContent(org.apache.pdfbox.cos.COSName) instead.
org.apache.pdfbox.pdmodel.PDPageContentStream.beginMarkedContentSequence(COSName, COSName) Use PDPageContentStream.beginMarkedContent(COSName, PDPropertyList) instead.
org.apache.pdfbox.pdmodel.PDPageContentStream.clipPath(int) Use PDPageContentStream.clip() or PDPageContentStream.clipEvenOdd() instead.
org.apache.pdfbox.pdmodel.PDPageContentStream.closeSubPath() Use PDPageContentStream.closePath() instead.
org.apache.pdfbox.pdmodel.PDPageContentStream.concatenate2CTM(AffineTransform) Use PDPageContentStream.transform(org.apache.pdfbox.util.Matrix) instead.
org.apache.pdfbox.pdmodel.PDPageContentStream.concatenate2CTM(double, double, double, double, double, double) Use PDPageContentStream.transform(org.apache.pdfbox.util.Matrix) instead.
org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSigBuilder.createAffineTransform(byte[]) use PDVisibleSigBuilder.createAffineTransform(java.awt.geom.AffineTransform)
org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.createAffineTransform(byte[]) use PDFTemplateBuilder.createAffineTransform(java.awt.geom.AffineTransform)
org.apache.pdfbox.cos.COSStream.createFilteredStream() Use COSStream.createRawOutputStream() instead.
org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSigBuilder.createFormatterRectangle(byte[]) use createFormatterRectangle(int[])
org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateBuilder.createFormatterRectangle(byte[]) use createFormatterRectangle(int[])
org.apache.pdfbox.pdmodel.graphics.image.CCITTFactory.createFromRandomAccess(PDDocument, RandomAccess) Use CCITTFactory.createFromFile(PDDocument, File) instead.
org.apache.pdfbox.pdmodel.graphics.image.CCITTFactory.createFromRandomAccess(PDDocument, RandomAccess, int) Use CCITTFactory.createFromFile(PDDocument, File, int) instead.
org.apache.pdfbox.cos.COSStream.createUnfilteredStream() Use COSStream.createOutputStream() instead.
org.apache.pdfbox.pdmodel.PDPageContentStream.drawInlineImage(PDInlineImage, float, float) Use PDPageContentStream.drawImage(PDInlineImage, float, float) instead.
org.apache.pdfbox.pdmodel.PDPageContentStream.drawInlineImage(PDInlineImage, float, float, float, float) Use PDPageContentStream.drawImage(PDInlineImage, float, float, float, float) instead.
org.apache.pdfbox.pdmodel.PDPageContentStream.drawLine(float, float, float, float) Use moveto(xStart,yStart) followed by lineTo(xEnd,yEnd) followed by stroke().
org.apache.pdfbox.pdmodel.PDPageContentStream.drawPolygon(float[], float[]) Use PDPageContentStream.moveTo(float, float) and PDPageContentStream.lineTo(float, float) methods instead.
org.apache.pdfbox.pdmodel.PDPageContentStream.drawString(String) Use PDPageContentStream.showText(java.lang.String) instead.
org.apache.pdfbox.pdmodel.PDPageContentStream.drawXObject(PDXObject, AffineTransform) Use drawImage(PDImageXObject, Matrix) or drawForm(PDFormXObject) with transform(Matrix) instead.
org.apache.pdfbox.pdmodel.PDPageContentStream.drawXObject(PDXObject, float, float, float, float) Use PDPageContentStream.drawImage(org.apache.pdfbox.pdmodel.graphics.image.PDImageXObject, float, float) instead.
org.apache.pdfbox.pdmodel.PDPageContentStream.endMarkedContentSequence() Use PDPageContentStream.endMarkedContent() instead.
org.apache.pdfbox.pdmodel.common.function.PDFunction.eval(COSArray) Replaced by PDFunction.eval(float[] input)
org.apache.pdfbox.util.Matrix.extractScaling() This method is due to be removed, please contact us if you make use of it.
org.apache.pdfbox.util.Matrix.extractTranslating() This method is due to be removed, please contact us if you make use of it.
org.apache.pdfbox.pdmodel.PDPageContentStream.fill(int) Use PDPageContentStream.fill() or PDPageContentStream.fillEvenOdd() instead.
org.apache.pdfbox.pdmodel.PDPageContentStream.fillPolygon(float[], float[]) Use PDPageContentStream.moveTo(float, float) and PDPageContentStream.lineTo(float, float) methods instead.
org.apache.pdfbox.pdmodel.PDPageContentStream.fillRect(float, float, float, float) Use PDPageContentStream.addRect(float, float, float, float) followed by PDPageContentStream.fill() instead.
org.apache.pdfbox.pdmodel.interactive.documentnavigation.destination.PDPageDestination.findPageNumber() This method has inconsistent behavior (see returns), use PDPageDestination.retrievePageNumber() instead.
org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSignDesigner.formatterRectangleParams(byte[]) use formatterRectangleParameters(int[])
org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSignDesigner.getAffineTransformParams() use PDVisibleSignDesigner.getTransform().
org.apache.fontbox.ttf.CmapSubtable.getCharacterCode(int) the mapping may be ambiguous, see CmapSubtable.getCharCodes(int). The first mapped value is returned by default.
org.apache.pdfbox.pdmodel.graphics.image.PDInlineImage.getColorKeyMask() inline images don't have a color key mask.
org.apache.pdfbox.pdmodel.graphics.PDXObject.getCOSStream() use PDXObject.getCOSObject()
org.apache.pdfbox.cos.COSDictionary.getDictionaryObject(String[]) Will be removed in 3.0. A value may have to keys, the regular one and sometimes an additional abbreviation. More than 2 values doesn't make sense.
org.apache.pdfbox.cos.COSStream.getFilteredStream() Use COSStream.createRawInputStream() instead.
org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSignDesigner.getFormatterRectangleParams() use getFormatterRectangleParameters()
org.apache.pdfbox.pdmodel.font.PDFontLike.getHeight(int) Use getBoundingBox().getHeight() instead.
org.apache.pdfbox.cos.COSDictionary.getInt(String[], int) Will be removed in 3.0. A value may have to keys, the regular one and sometimes an additional abbreviation. More than 2 values doesn't make sense.
org.apache.pdfbox.cos.COSDictionary.getLong(String[], long) Will be removed in 3.0. A value may have to keys, the regular one and sometimes an additional abbreviation. More than 2 values doesn't make sense.
org.apache.pdfbox.pdmodel.graphics.state.PDGraphicsState.getNonStrokeAlphaConstants() use PDGraphicsState.getNonStrokeAlphaConstant()
org.apache.pdfbox.pdmodel.graphics.PDXObject.getPDStream() Use PDXObject.getStream() instead.
org.apache.pdfbox.pdmodel.interactive.action.PDActionURI.getS() use PDAction.getSubType().
org.apache.pdfbox.pdmodel.interactive.action.PDActionSound.getS() use PDAction.getSubType().
org.apache.pdfbox.pdmodel.interactive.action.PDActionRemoteGoTo.getS() use PDAction.getSubType().
org.apache.pdfbox.pdmodel.interactive.action.PDActionMovie.getS() use PDAction.getSubType().
org.apache.pdfbox.pdmodel.common.PDStream.getStream() use PDStream.getCOSObject()
org.apache.pdfbox.cos.COSStream.getString() Use COSStream.toTextString() instead.
org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDFTemplateStructure.getTemplateAppearanceStream() This will be removed in 2.1 because the method name is misleading and confusing, and the work done rather belongs into the calling class: COSDocument visualSignature = structure.getVisualSignature(); ByteArrayOutputStream baos = new ByteArrayOutputStream(); COSWriter writer = new COSWriter(baos); writer.write(visualSignature); writer.close(); structure.getTemplate().close(); ByteArrayInputStream bais = new ByteArrayInputStream(baos.toByteArray());
org.apache.pdfbox.util.Matrix.getTranslatingInstance(float, float) Use Matrix.getTranslateInstance(float, float) instead.
org.apache.pdfbox.cos.COSStream.getUnfilteredStream() Use COSStream.createInputStream() instead.
org.apache.fontbox.ttf.TrueTypeFont.getUnicodeCmap() Use TrueTypeFont.getUnicodeCmapLookup() instead
org.apache.fontbox.ttf.TrueTypeFont.getUnicodeCmap(boolean) Use TrueTypeFont.getUnicodeCmapLookup(boolean) instead
org.apache.pdfbox.util.Matrix.getValuesAsDouble() Use Matrix.getValues() instead.
org.apache.pdfbox.pdmodel.interactive.form.PDTerminalField.getWidget() Fields may have more than one widget, call PDTerminalField.getWidgets() instead.
org.apache.pdfbox.util.Matrix.getXPosition() Use Matrix.getTranslateX() instead
org.apache.pdfbox.util.Matrix.getYPosition() Use Matrix.getTranslateY() instead
org.apache.pdfbox.pdmodel.font.PDTrueTypeFont.loadTTF(PDDocument, File) Use PDType0Font.load(PDDocument, File) instead.
org.apache.pdfbox.pdmodel.font.PDTrueTypeFont.loadTTF(PDDocument, InputStream) Use PDType0Font.load(PDDocument, InputStream) instead.
org.apache.pdfbox.multipdf.PDFMergerUtility.mergeDocuments() use PDFMergerUtility.mergeDocuments(org.apache.pdfbox.io.MemoryUsageSetting)
org.apache.pdfbox.cos.COSDictionary.mergeInto(COSDictionary) This method should no longer be used and will be removed in 3.0 because it could also merge attributes that should not be merged (filter and length) in a COSStream.
org.apache.pdfbox.pdmodel.PDPageContentStream.moveTextPositionByAmount(float, float) Use PDPageContentStream.newLineAtOffset(float, float) instead.
org.apache.pdfbox.contentstream.PDFStreamEngine.registerOperatorProcessor(String, OperatorProcessor) Use PDFStreamEngine.addOperator(OperatorProcessor) instead
org.apache.pdfbox.util.Matrix.reset() This method will be removed.
org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationFileAttachment.setAttachementName(String) use PDAnnotationFileAttachment.setAttachmentName(java.lang.String).
org.apache.pdfbox.cos.COSStream.setFilters(COSBase) Use COSStream.createOutputStream(COSBase) instead.
org.apache.pdfbox.util.Matrix.setFromAffineTransform(AffineTransform) Use the Matrix.Matrix(AffineTransform) constructor instead.
org.apache.pdfbox.pdmodel.PDPageContentStream.setLeading(double) use setLeading(float)
org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences.setNonFullScreenPageMode(String)
org.apache.pdfbox.pdmodel.graphics.state.PDGraphicsState.setNonStrokeAlphaConstants(double) use PDGraphicsState.setNonStrokeAlphaConstant(double)
org.apache.pdfbox.pdmodel.PDPageContentStream.setNonStrokingColor(double) use setNonStrokingColor(float)
org.apache.pdfbox.pdmodel.PDPageContentStream.setNonStrokingColor(double, double, double, double) use setNonStrokingColor(float, float, float, float)
org.apache.pdfbox.pdmodel.PDPageContentStream.setNonStrokingColor(float[]) Use PDPageContentStream.setNonStrokingColor(PDColor) instead.
org.apache.pdfbox.pdmodel.PDPageContentStream.setNonStrokingColorSpace(PDColorSpace) Use PDPageContentStream.setNonStrokingColor(PDColor) instead.
org.apache.pdfbox.pdmodel.graphics.color.PDICCBased.setNumberOfComponents(int)
org.apache.pdfbox.pdmodel.interactive.action.PDActionRemoteGoTo.setOpenInNewWindow(boolean) use PDActionRemoteGoTo.setOpenInNewWindow(OpenMode)
org.apache.pdfbox.pdmodel.interactive.action.PDActionLaunch.setOpenInNewWindow(boolean) use PDActionLaunch.setOpenInNewWindow(OpenMode)
org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences.setPrintArea(String)
org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences.setPrintClip(String)
org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences.setReadingDirection(String)
org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSeedValue.setReasonsd(List<String>) use PDSeedValue.setReasons(java.util.List)
org.apache.pdfbox.pdmodel.interactive.action.PDActionURI.setS(String) use PDAction.setSubType(java.lang.String).
org.apache.pdfbox.pdmodel.interactive.action.PDActionSound.setS(String) use PDAction.setSubType(java.lang.String).
org.apache.pdfbox.pdmodel.interactive.action.PDActionRemoteGoTo.setS(String) use PDAction.setSubType(java.lang.String).
org.apache.pdfbox.pdmodel.interactive.action.PDActionMovie.setS(String) use PDAction.setSubType(java.lang.String).
org.apache.pdfbox.pdmodel.interactive.form.PDSignatureField.setSignature(PDSignature) Use PDSignatureField.setValue(PDSignature) instead.
org.apache.pdfbox.pdmodel.PDPageContentStream.setStrokingColor(double) use setStrokingColor(float)
org.apache.pdfbox.pdmodel.PDPageContentStream.setStrokingColor(float[]) Use PDPageContentStream.setStrokingColor(PDColor) instead.
org.apache.pdfbox.pdmodel.PDPageContentStream.setStrokingColor(int) Use PDPageContentStream.setStrokingColor(float) instead.
org.apache.pdfbox.pdmodel.PDPageContentStream.setStrokingColor(int, int, int, int) Use PDPageContentStream.setStrokingColor(float, float, float, float) instead.
org.apache.pdfbox.pdmodel.PDPageContentStream.setStrokingColorSpace(PDColorSpace) Use PDPageContentStream.setStrokingColor(org.apache.pdfbox.pdmodel.graphics.color.PDColor) instead.
org.apache.pdfbox.pdmodel.PDPageContentStream.setTextMatrix(AffineTransform) Use PDPageContentStream.setTextMatrix(Matrix) instead.
org.apache.pdfbox.pdmodel.PDPageContentStream.setTextMatrix(double, double, double, double, double, double) Use PDPageContentStream.setTextMatrix(Matrix) instead.
org.apache.pdfbox.pdmodel.PDPageContentStream.setTextRotation(double, double, double) Use PDPageContentStream.setTextMatrix(Matrix) instead.
org.apache.pdfbox.pdmodel.PDPageContentStream.setTextScaling(double, double, double, double) Use PDPageContentStream.setTextMatrix(Matrix) instead.
org.apache.pdfbox.pdmodel.PDPageContentStream.setTextTranslation(double, double) Use PDPageContentStream.setTextMatrix(Matrix) instead.
org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences.setViewArea(String)
org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences.setViewClip(String)
org.apache.pdfbox.pdmodel.interactive.action.PDActionRemoteGoTo.shouldOpenInNewWindow() use PDActionRemoteGoTo.getOpenInNewWindow()
org.apache.pdfbox.pdmodel.interactive.action.PDActionLaunch.shouldOpenInNewWindow() use PDActionLaunch.getOpenInNewWindow()
org.apache.pdfbox.tools.PDFText2HTML.writeHeader() deprecated, use PDFText2HTML.startDocument(PDDocument)
org.apache.pdfbox.tools.imageio.ImageIOUtil.writeImage(BufferedImage, String, String, int) use ImageIOUtil.writeImage(BufferedImage image, String filename, int dpi), which uses the full filename instead of just the prefix.

Deprecated Constructors

Constructor and Description
org.apache.pdfbox.pdfwriter.COSStandardOutputStream(OutputStream, int) use COSStandardOutputStream.COSStandardOutputStream(java.io.OutputStream, long)
org.apache.pdfbox.pdmodel.encryption.PDEncryptionDictionary() Use PDEncryption instead
org.apache.pdfbox.pdmodel.encryption.PDEncryptionDictionary(COSDictionary) Use PDEncryption.PDEncryption(COSDictionary) instead
org.apache.pdfbox.pdfparser.PDFStreamParser(COSStream) Use PDFStreamParser.PDFStreamParser(PDContentStream) instead.
org.apache.pdfbox.pdfparser.PDFStreamParser(PDStream) Use PDFStreamParser.PDFStreamParser(PDContentStream) instead.
org.apache.pdfbox.pdfparser.PDFXRefStream() use PDFXRefStream.PDFXRefStream(org.apache.pdfbox.cos.COSDocument)
org.apache.pdfbox.pdmodel.PDPageContentStream(PDDocument, PDPage, boolean, boolean) use PDPageContentStream.PDPageContentStream(PDDocument, PDPage, PDPageContentStream.AppendMode, boolean)
org.apache.pdfbox.pdmodel.PDPageContentStream(PDDocument, PDPage, boolean, boolean, boolean) use PDPageContentStream.PDPageContentStream(PDDocument, PDPage, PDPageContentStream.AppendMode, boolean, boolean)