Modifier and Type	Class and Description
public static enum	PDPageContentStream.AppendMode This is to choose what to do with the stream: overwrite, append or prepend.

Modifier and Type	Field and Description
private static final Log	LOG Hides org.apache.pdfbox.pdmodel.PDAbstractContentStream.LOG.
private boolean	sourcePageHadContents

Constructor Summary

Access	Constructor and Description
public	PDPageContentStream(PDDocument The document the page is part of. document, PDPage The page to write the contents to. sourcePage) Create a new PDPage content stream.
public	PDPageContentStream(PDDocument The document the page is part of. document, PDPage The page to write the contents to. sourcePage, PDPageContentStream.AppendMode Indicates whether content will be overwritten, appended or prepended. appendContent, boolean Tell if the content stream should compress the page contents. compress) Create a new PDPage content stream.
public	PDPageContentStream(PDDocument The document the page is part of. document, PDPage The page to write the contents to. sourcePage, PDPageContentStream.AppendMode Indicates whether content will be overwritten, appended or prepended. appendContent, boolean Tell if the content stream should compress the page contents. compress, boolean Tell if the graphic context should be reset. This is only relevant when the appendContent parameter is set to `AppendMode#APPEND`. You should use this when appending to an existing stream, because the existing stream may have changed graphic properties (e.g. scaling, rotation). resetContext) Create a new PDPage content stream.
private	PDPageContentStream(PDDocument document, PDPage sourcePage, PDPageContentStream.AppendMode appendContent, boolean compress, boolean resetContext, PDStream stream, PDResources resources)
public	PDPageContentStream(PDDocument The document the page is part of. doc, PDAppearanceStream The appearance stream to write to. appearance) Create a new appearance stream.
public	PDPageContentStream(PDDocument The document the appearance is part of. doc, PDAppearanceStream The appearance stream to add to. appearance, OutputStream The appearances output stream to write to. outputStream) Create a new appearance stream.

Method Summary

Modifier and Type	Method and Description
public void	appendRawCommands(String The commands to append to the stream. commands) Deprecated Usage of this method is discouraged. This will append raw commands to the content stream.
public void	appendRawCommands(byte[] The commands to append to the stream. commands) Deprecated Usage of this method is discouraged. This will append raw commands to the content stream.
public void	appendRawCommands(int Append a raw byte to the stream. data) Deprecated Usage of this method is discouraged. This will append raw commands to the content stream.
public void	appendRawCommands(double Append a formatted double value to the stream. data) Deprecated Usage of this method is discouraged. This will append raw commands to the content stream.
public void	appendRawCommands(float Append a formatted float value to the stream. data) Deprecated Usage of this method is discouraged. This will append raw commands to the content stream.

Inherited from org.apache.pdfbox.pdmodel.PDAbstractContentStream:: addComment addRect beginMarkedContent beginMarkedContent beginMarkedContent beginText clip clipEvenOdd close closeAndFillAndStroke closeAndFillAndStrokeEvenOdd closeAndStroke closePath curveTo curveTo1 curveTo2 drawForm drawImage drawImage drawImage drawImage drawImage endMarkedContent endText fill fillAndStroke fillAndStrokeEvenOdd fillEvenOdd getName isOutside255Interval lineTo moveTo newLine newLineAtOffset restoreGraphicsState saveGraphicsState setCharacterSpacing setFont setGraphicsStateParameters setHorizontalScaling setLeading setLineCapStyle setLineDashPattern setLineJoinStyle setLineWidth setMaximumFractionDigits setMiterLimit setNonStrokingColor setNonStrokingColor setNonStrokingColor setNonStrokingColor setNonStrokingColor setNonStrokingColorSpaceStack setRenderingMode setStrokingColor setStrokingColor setStrokingColor setStrokingColor setStrokingColor setStrokingColorSpaceStack setTextMatrix setTextRise setWordSpacing shadingFill showText showTextInternal showTextWithPositioning stroke transform write writeBytes writeLine writeOperand writeOperand writeOperand writeOperator

Field Detail

LOG	back to summary
private static final Log LOG Hides org.apache.pdfbox.pdmodel.PDAbstractContentStream.LOG.

sourcePageHadContents	back to summary
private boolean sourcePageHadContents

Constructor Detail

PDPageContentStream	back to summary
public PDPageContentStream(PDDocument document, PDPage sourcePage) throws IOException Create a new PDPage content stream. This constructor overwrites all existing content streams of this page. Parameters document:PDDocument The document the page is part of. sourcePage:PDPage The page to write the contents to. Exceptions IOException: If there is an error writing to the page contents.

PDPageContentStream

back to summary

public PDPageContentStream(PDDocument document, PDPage sourcePage) throws IOException

Create a new PDPage content stream. This constructor overwrites all existing content streams of this page.

Parameters

document:PDDocument: The document the page is part of.
sourcePage:PDPage: The page to write the contents to.

Exceptions

IOException:: If there is an error writing to the page contents.

PDPageContentStream back to summary

PDPageContentStream	back to summary
public PDPageContentStream(PDDocument document, PDPage sourcePage, PDPageContentStream.AppendMode appendContent, boolean compress) throws IOException Create a new PDPage content stream. If the appendContent parameter is set to `AppendMode#APPEND`, you may want to use `PDPageContentStream(PDDocument, PDPage, PDPageContentStream.AppendMode, boolean, boolean)` instead, with the fifth parameter set to true. Parameters document:PDDocument The document the page is part of. sourcePage:PDPage The page to write the contents to. appendContent:PDPageContentStream.AppendMode Indicates whether content will be overwritten, appended or prepended. compress:boolean Tell if the content stream should compress the page contents. Exceptions IOException: If there is an error writing to the page contents.

public PDPageContentStream(PDDocument document, PDPage sourcePage, PDPageContentStream.AppendMode appendContent, boolean compress) throws IOException

Create a new PDPage content stream. If the appendContent parameter is set to AppendMode#APPEND, you may want to use PDPageContentStream(PDDocument, PDPage, PDPageContentStream.AppendMode, boolean, boolean) instead, with the fifth parameter set to true.

Parameters

document:PDDocument: The document the page is part of.
sourcePage:PDPage: The page to write the contents to.
appendContent:PDPageContentStream.AppendMode: Indicates whether content will be overwritten, appended or prepended.
compress:boolean: Tell if the content stream should compress the page contents.

Exceptions

IOException:: If there is an error writing to the page contents.

PDPageContentStream back to summary

PDPageContentStream	back to summary
public PDPageContentStream(PDDocument document, PDPage sourcePage, PDPageContentStream.AppendMode appendContent, boolean compress, boolean resetContext) throws IOException Create a new PDPage content stream. Parameters document:PDDocument The document the page is part of. sourcePage:PDPage The page to write the contents to. appendContent:PDPageContentStream.AppendMode Indicates whether content will be overwritten, appended or prepended. compress:boolean Tell if the content stream should compress the page contents. resetContext:boolean Tell if the graphic context should be reset. This is only relevant when the appendContent parameter is set to `AppendMode#APPEND`. You should use this when appending to an existing stream, because the existing stream may have changed graphic properties (e.g. scaling, rotation). Exceptions IOException: If there is an error writing to the page contents.

public PDPageContentStream(PDDocument document, PDPage sourcePage, PDPageContentStream.AppendMode appendContent, boolean compress, boolean resetContext) throws IOException

Create a new PDPage content stream.

Parameters

document:PDDocument: The document the page is part of.
sourcePage:PDPage: The page to write the contents to.
appendContent:PDPageContentStream.AppendMode: Indicates whether content will be overwritten, appended or prepended.
compress:boolean: Tell if the content stream should compress the page contents.
resetContext:boolean: Tell if the graphic context should be reset. This is only relevant when the appendContent parameter is set to AppendMode#APPEND. You should use this when appending to an existing stream, because the existing stream may have changed graphic properties (e.g. scaling, rotation).

Exceptions

IOException:: If there is an error writing to the page contents.

PDPageContentStream	back to summary
private PDPageContentStream(PDDocument document, PDPage sourcePage, PDPageContentStream.AppendMode appendContent, boolean compress, boolean resetContext, PDStream stream, PDResources resources) throws IOException

PDPageContentStream	back to summary
public PDPageContentStream(PDDocument doc, PDAppearanceStream appearance) throws IOException Create a new appearance stream. Note that this is not actually a "page" content stream. Parameters doc:PDDocument The document the page is part of. appearance:PDAppearanceStream The appearance stream to write to. Exceptions IOException: If there is an error writing to the page contents.

PDPageContentStream

back to summary

public PDPageContentStream(PDDocument doc, PDAppearanceStream appearance) throws IOException

Create a new appearance stream. Note that this is not actually a "page" content stream.

Parameters

doc:PDDocument: The document the page is part of.
appearance:PDAppearanceStream: The appearance stream to write to.

Exceptions

IOException:: If there is an error writing to the page contents.

PDPageContentStream	back to summary
public PDPageContentStream(PDDocument doc, PDAppearanceStream appearance, OutputStream outputStream) Create a new appearance stream. Note that this is not actually a "page" content stream. Parameters doc:PDDocument The document the appearance is part of. appearance:PDAppearanceStream The appearance stream to add to. outputStream:OutputStream The appearances output stream to write to.

PDPageContentStream

back to summary

public PDPageContentStream(PDDocument doc, PDAppearanceStream appearance, OutputStream outputStream)

Create a new appearance stream. Note that this is not actually a "page" content stream.

Parameters

doc:PDDocument: The document the appearance is part of.
appearance:PDAppearanceStream: The appearance stream to add to.
outputStream:OutputStream: The appearances output stream to write to.

Method Detail

appendRawCommands	back to summary
public void appendRawCommands(String commands) throws IOException Deprecated Usage of this method is discouraged. This will append raw commands to the content stream. Parameters commands:String The commands to append to the stream. Annotations @Deprecated Exceptions IOException: If an error occurs while writing to the stream.

appendRawCommands

back to summary

public void appendRawCommands(String commands) throws IOException

Deprecated

Usage of this method is discouraged.

This will append raw commands to the content stream.

Parameters

commands:String: The commands to append to the stream.

Annotations

@Deprecated

Exceptions

IOException:: If an error occurs while writing to the stream.

appendRawCommands	back to summary
public void appendRawCommands(byte[] commands) throws IOException Deprecated Usage of this method is discouraged. This will append raw commands to the content stream. Parameters commands:byte[] The commands to append to the stream. Annotations @Deprecated Exceptions IOException: If an error occurs while writing to the stream.

appendRawCommands

back to summary

public void appendRawCommands(byte[] commands) throws IOException

Deprecated

Usage of this method is discouraged.

This will append raw commands to the content stream.

Parameters

commands:byte[]: The commands to append to the stream.

Annotations

@Deprecated

Exceptions

IOException:: If an error occurs while writing to the stream.

appendRawCommands	back to summary
public void appendRawCommands(int data) throws IOException Deprecated Usage of this method is discouraged. This will append raw commands to the content stream. Parameters data:int Append a raw byte to the stream. Annotations @Deprecated Exceptions IOException: If an error occurs while writing to the stream.

appendRawCommands

back to summary

public void appendRawCommands(int data) throws IOException

Deprecated

Usage of this method is discouraged.

This will append raw commands to the content stream.

Parameters

data:int: Append a raw byte to the stream.

Annotations

@Deprecated

Exceptions

IOException:: If an error occurs while writing to the stream.

appendRawCommands	back to summary
public void appendRawCommands(double data) throws IOException Deprecated Usage of this method is discouraged. This will append raw commands to the content stream. Parameters data:double Append a formatted double value to the stream. Annotations @Deprecated Exceptions IOException: If an error occurs while writing to the stream.

appendRawCommands

back to summary

public void appendRawCommands(double data) throws IOException

Deprecated

Usage of this method is discouraged.

This will append raw commands to the content stream.

Parameters

data:double: Append a formatted double value to the stream.

Annotations

@Deprecated

Exceptions

IOException:: If an error occurs while writing to the stream.

appendRawCommands	back to summary
public void appendRawCommands(float data) throws IOException Deprecated Usage of this method is discouraged. This will append raw commands to the content stream. Parameters data:float Append a formatted float value to the stream. Annotations @Deprecated Exceptions IOException: If an error occurs while writing to the stream.

appendRawCommands

back to summary

public void appendRawCommands(float data) throws IOException

Deprecated

Usage of this method is discouraged.

This will append raw commands to the content stream.

Parameters

data:float: Append a formatted float value to the stream.

Annotations

@Deprecated

Exceptions

IOException:: If an error occurs while writing to the stream.

org.apache.pdfbox.pdmodel back to summary

public final Enum PDPageContentStream.AppendMode

Class Inheritance

extends Enum<PDPageContentStream.AppendMode>

java.lang.Object
java.lang.Enum
org.apache.pdfbox.pdmodel.PDPageContentStream.AppendMode

This is to choose what to do with the stream: overwrite, append or prepend.

Field Summary

Modifier and Type	Field and Description
public static final PDPageContentStream.AppendMode	APPEND Append the content stream after all existing page content streams.
public static final PDPageContentStream.AppendMode	OVERWRITE Overwrite the existing page content streams.
public static final PDPageContentStream.AppendMode	PREPEND Insert before all other page content streams.

Constructor Summary

Access	Constructor and Description
private	AppendMode()

Method Summary

Modifier and Type	Method and Description
public boolean	isOverwrite()
public boolean	isPrepend()
public static PDPageContentStream.AppendMode	valueOf(String name)
public static PDPageContentStream.AppendMode[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

APPEND	back to summary
public static final PDPageContentStream.AppendMode APPEND Append the content stream after all existing page content streams.

OVERWRITE	back to summary
public static final PDPageContentStream.AppendMode OVERWRITE Overwrite the existing page content streams.

PREPEND	back to summary
public static final PDPageContentStream.AppendMode PREPEND Insert before all other page content streams.

Constructor Detail

AppendMode	back to summary
private AppendMode()

Method Detail

isOverwrite	back to summary
public boolean isOverwrite()

isPrepend	back to summary
public boolean isPrepend()

valueOf	back to summary
public static PDPageContentStream.AppendMode valueOf(String name)

values	back to summary
public static PDPageContentStream.AppendMode[] values()

public final Class PDPageContentStream

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum PDPageContentStream.AppendMode

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail