Class PDXObject
java.lang.Object
org.apache.pdfbox.pdmodel.graphics.PDXObject
- All Implemented Interfaces:
COSObjectable
- Direct Known Subclasses:
PDFormXObject
,PDImageXObject
,PDPostScriptXObject
An external object, or "XObject".
-
Field Summary
Fields -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
Creates a new XObject from the given stream and subtype.protected
Creates a new XObject from the given stream and subtype.protected
PDXObject
(PDDocument document, COSName subtype) Creates a new XObject of the given subtype for writing. -
Method Summary
Modifier and TypeMethodDescriptionstatic PDXObject
createXObject
(COSBase base, PDResources resources) Creates a new XObject instance of the appropriate type for the COS stream.final COSStream
Returns the stream.final COSStream
Deprecated.final PDStream
Deprecated.UsegetStream()
instead.final PDStream
Returns the stream.
-
Field Details
-
stream
-
-
Constructor Details
-
PDXObject
Creates a new XObject from the given stream and subtype.- Parameters:
stream
- The stream to read.subtype
-
-
PDXObject
Creates a new XObject from the given stream and subtype.- Parameters:
stream
- The stream to read.subtype
-
-
PDXObject
Creates a new XObject of the given subtype for writing.- Parameters:
document
- The document in which to create the XObject.subtype
- The subtype of the new XObject.
-
-
Method Details
-
createXObject
Creates a new XObject instance of the appropriate type for the COS stream.- Parameters:
base
- The stream which is wrapped by this XObject.resources
-- Returns:
- A new XObject instance.
- Throws:
IOException
- if there is an error creating the XObject.
-
getCOSObject
Returns the stream. Convert this standard java object to a COS object.- Specified by:
getCOSObject
in interfaceCOSObjectable
- Returns:
- The cos object that matches this Java object.
-
getCOSStream
Deprecated.usegetCOSObject()
Returns the stream.- Returns:
- The stream for this object.
-
getPDStream
Deprecated.UsegetStream()
instead.Returns the stream.- Returns:
- The stream for this object.
-
getStream
Returns the stream.- Returns:
- The stream for this object.
-
getCOSObject()