public class PdfFileSpec extends PdfObjectWrapper<PdfObject>
Modifier | Constructor and Description |
---|---|
protected |
PdfFileSpec(PdfObject pdfObject) |
Modifier and Type | Method and Description |
---|---|
static PdfFileSpec |
createEmbeddedFileSpec(PdfDocument doc, byte[] fileStore, String fileDisplay, PdfDictionary fileParameter, PdfName afRelationshipValue)
Embed a file to a PdfDocument.
|
static PdfFileSpec |
createEmbeddedFileSpec(PdfDocument doc, byte[] fileStore, String fileDisplay, PdfName afRelationshipValue)
Embed a file to a PdfDocument.
|
static PdfFileSpec |
createEmbeddedFileSpec(PdfDocument doc, byte[] fileStore, String description, String fileDisplay, PdfDictionary fileParameter, PdfName afRelationshipValue)
Embed a file to a PdfDocument.
|
static PdfFileSpec |
createEmbeddedFileSpec(PdfDocument doc, byte[] fileStore, String description, String fileDisplay, PdfName afRelationshipValue)
Embed a file to a PdfDocument.
|
static PdfFileSpec |
createEmbeddedFileSpec(PdfDocument doc, byte[] fileStore, String description, String fileDisplay, PdfName mimeType, PdfDictionary fileParameter, PdfName afRelationshipValue)
Embed a file to a PdfDocument.
|
static PdfFileSpec |
createEmbeddedFileSpec(PdfDocument doc, InputStream is, String description, String fileDisplay, PdfName mimeType, PdfDictionary fileParameter, PdfName afRelationshipValue)
Embed a file to a PdfDocument.
|
static PdfFileSpec |
createEmbeddedFileSpec(PdfDocument doc, InputStream is, String description, String fileDisplay, PdfName mimeType, PdfName afRelationshipValue)
Embed a file to a PdfDocument.
|
static PdfFileSpec |
createEmbeddedFileSpec(PdfDocument doc, String filePath, String fileDisplay, PdfName afRelationshipValue)
Embed a file to a PdfDocument.
|
static PdfFileSpec |
createEmbeddedFileSpec(PdfDocument doc, String filePath, String description, String fileDisplay, PdfName afRelationshipValue)
Embed a file to a PdfDocument.
|
static PdfFileSpec |
createEmbeddedFileSpec(PdfDocument doc, String filePath, String description, String fileDisplay, PdfName mimeType, PdfDictionary fileParameter, PdfName afRelationshipValue)
Embed a file to a PdfDocument.
|
static PdfFileSpec |
createEmbeddedFileSpec(PdfDocument doc, String filePath, String description, String fileDisplay, PdfName mimeType, PdfName afRelationshipValue)
Embed a file to a PdfDocument.
|
static PdfFileSpec |
createExternalFileSpec(PdfDocument doc, String filePath) |
static PdfFileSpec |
createExternalFileSpec(PdfDocument doc, String filePath, PdfName afRelationshipValue) |
PdfArray |
getFileIdentifier() |
PdfImageXObject |
getThumbnailImage()
PDF 2.0.
|
PdfBoolean |
isVolatile() |
protected boolean |
isWrappedObjectMustBeIndirect()
Defines if the object behind this wrapper must be an indirect object in the resultant document.
|
PdfFileSpec |
put(PdfName key, PdfObject value) |
PdfFileSpec |
setCollectionItem(PdfCollectionItem item) |
PdfFileSpec |
setFileIdentifier(PdfArray fileIdentifier) |
PdfFileSpec |
setThumbnailImage(PdfImageXObject thumbnailImage)
PDF 2.0.
|
PdfFileSpec |
setVolatile(PdfBoolean isVolatile) |
static PdfFileSpec |
wrapFileSpecObject(PdfObject fileSpecObject) |
ensureObjectIsAddedToDocument, ensureUnderlyingObjectHasIndirectReference, flush, getPdfObject, isFlushed, makeIndirect, makeIndirect, markObjectAsIndirect, setForbidRelease, setModified, setPdfObject, unsetForbidRelease
protected PdfFileSpec(PdfObject pdfObject)
public static PdfFileSpec wrapFileSpecObject(PdfObject fileSpecObject)
public static PdfFileSpec createExternalFileSpec(PdfDocument doc, String filePath, PdfName afRelationshipValue)
public static PdfFileSpec createExternalFileSpec(PdfDocument doc, String filePath)
public static PdfFileSpec createEmbeddedFileSpec(PdfDocument doc, byte[] fileStore, String description, String fileDisplay, PdfName mimeType, PdfDictionary fileParameter, PdfName afRelationshipValue)
doc
- PdfDocument to add the file to
fileStore
- byte[] containing the file
description
- file description
fileDisplay
- actual file name stored in the pdf
mimeType
- mime-type of the file
fileParameter
- Pdfdictionary containing fil parameters
afRelationshipValue
- AFRelationship key value, @see AFRelationshipValue. If null
, @see AFRelationshipValue.Unspecified will be added.
public static PdfFileSpec createEmbeddedFileSpec(PdfDocument doc, byte[] fileStore, String description, String fileDisplay, PdfDictionary fileParameter, PdfName afRelationshipValue)
doc
- PdfDocument to add the file to
fileStore
- byte[] containing the file
fileDisplay
- actual file name stored in the pdf
fileParameter
- Pdfdictionary containing fil parameters
afRelationshipValue
- AFRelationship key value, @see AFRelationshipValue. If null
, @see AFRelationshipValue.Unspecified will be added.
public static PdfFileSpec createEmbeddedFileSpec(PdfDocument doc, byte[] fileStore, String fileDisplay, PdfDictionary fileParameter, PdfName afRelationshipValue)
doc
- PdfDocument to add the file to
fileStore
- byte[] containing the file
fileDisplay
- actual file name stored in the pdf
fileParameter
- Pdfdictionary containing fil parameters
afRelationshipValue
- AFRelationship key value, @see AFRelationshipValue. If null
, @see AFRelationshipValue.Unspecified will be added.
public static PdfFileSpec createEmbeddedFileSpec(PdfDocument doc, byte[] fileStore, String fileDisplay, PdfName afRelationshipValue)
doc
- PdfDocument to add the file to
fileStore
- byte[] containing the file
fileDisplay
- actual file name stored in the pdf
afRelationshipValue
- AFRelationship key value, @see AFRelationshipValue. If null
, @see AFRelationshipValue.Unspecified will be added.
public static PdfFileSpec createEmbeddedFileSpec(PdfDocument doc, byte[] fileStore, String description, String fileDisplay, PdfName afRelationshipValue)
doc
- PdfDocument to add the file to
fileStore
- byte[] containing the file
description
- file description
fileDisplay
- actual file name stored in the pdf
afRelationshipValue
- AFRelationship key value, @see AFRelationshipValue. If null
, @see AFRelationshipValue.Unspecified will be added.
public static PdfFileSpec createEmbeddedFileSpec(PdfDocument doc, String filePath, String description, String fileDisplay, PdfName mimeType, PdfDictionary fileParameter, PdfName afRelationshipValue) throws IOException
doc
-
filePath
-
description
-
fileDisplay
-
mimeType
-
fileParameter
-
afRelationshipValue
-
IOException
public static PdfFileSpec createEmbeddedFileSpec(PdfDocument doc, String filePath, String description, String fileDisplay, PdfName mimeType, PdfName afRelationshipValue) throws IOException
doc
-
filePath
-
description
-
fileDisplay
-
mimeType
-
afRelationshipValue
-
IOException
public static PdfFileSpec createEmbeddedFileSpec(PdfDocument doc, String filePath, String description, String fileDisplay, PdfName afRelationshipValue) throws IOException
doc
-
filePath
-
description
-
fileDisplay
-
afRelationshipValue
-
IOException
public static PdfFileSpec createEmbeddedFileSpec(PdfDocument doc, String filePath, String fileDisplay, PdfName afRelationshipValue) throws IOException
doc
-
filePath
-
fileDisplay
-
afRelationshipValue
-
IOException
public static PdfFileSpec createEmbeddedFileSpec(PdfDocument doc, InputStream is, String description, String fileDisplay, PdfName mimeType, PdfDictionary fileParameter, PdfName afRelationshipValue)
doc
-
is
-
description
-
fileDisplay
-
mimeType
-
fileParameter
-
afRelationshipValue
-
public static PdfFileSpec createEmbeddedFileSpec(PdfDocument doc, InputStream is, String description, String fileDisplay, PdfName mimeType, PdfName afRelationshipValue)
doc
-
is
-
description
-
fileDisplay
-
mimeType
-
afRelationshipValue
-
public PdfFileSpec setFileIdentifier(PdfArray fileIdentifier)
public PdfArray getFileIdentifier()
public PdfFileSpec setVolatile(PdfBoolean isVolatile)
public PdfBoolean isVolatile()
public PdfFileSpec setCollectionItem(PdfCollectionItem item)
public PdfFileSpec setThumbnailImage(PdfImageXObject thumbnailImage)
thumbnailImage
- image used as a thumbnail
PdfFileSpec
instance
public PdfImageXObject getThumbnailImage()
null
if it is not set
public PdfFileSpec put(PdfName key, PdfObject value)
protected boolean isWrappedObjectMustBeIndirect()
PdfObjectWrapper
isWrappedObjectMustBeIndirect
in class PdfObjectWrapper<PdfObject>
Copyright © 1998–2020 iText Group NV. All rights reserved.