Class PDComplexFileSpecification
java.lang.Object
org.apache.pdfbox.pdmodel.common.filespecification.PDFileSpecification
org.apache.pdfbox.pdmodel.common.filespecification.PDComplexFileSpecification
- All Implemented Interfaces:
COSObjectable
This represents a file specification.
- Author:
- Ben Litchfield
-
Constructor Summary
ConstructorsConstructorDescriptionDefault Constructor.Constructor. -
Method Summary
Modifier and TypeMethodDescriptionConvert this standard java object to a COS object.Get the embedded file.Get the embedded dos file.Get the embedded Mac file.Get the embedded unicode file.Get the embedded Unix file.getFile()
This will get the file name.This will get the description.This will get the name representing a Dos file.This will get the name representing a Mac file.Preferred method for getting the filename.This will get the unicode file name.This will get the name representing a Unix file.boolean
Get if the file is volatile.void
Set the embedded file for this spec.void
Deprecated.This method is obsolescent and should not be used by conforming writers.void
Deprecated.This method is obsolescent and should not be used by conforming writers.void
Set the embedded Unicode file for this spec.void
Deprecated.This method is obsolescent and should not be used by conforming writers.void
This will set the file name.void
setFileDescription
(String description) Set the file description.void
setFileDos
(String file) Deprecated.This method is obsolescent and should not be used by conforming writers.void
setFileMac
(String file) Deprecated.This method is obsolescent and should not be used by conforming writers.void
setFileUnicode
(String file) This will set the unicode file name.void
setFileUnix
(String file) Deprecated.This method is obsolescent and should not be used by conforming writers.void
setVolatile
(boolean fileIsVolatile) Tell if the underlying file is volatile and should not be cached by the reader application.Methods inherited from class org.apache.pdfbox.pdmodel.common.filespecification.PDFileSpecification
createFS
-
Constructor Details
-
PDComplexFileSpecification
public PDComplexFileSpecification()Default Constructor. -
PDComplexFileSpecification
Constructor. Creates empty COSDictionary if dict is null.- Parameters:
dict
- The dictionary that fulfils this file specification.
-
-
Method Details
-
getCOSObject
Convert this standard java object to a COS object.- Returns:
- The cos object that matches this Java object.
-
getFilename
Preferred method for getting the filename. It will determinate the recommended file name.
First of all we try to get the unicode filename if it exist. If it doesn't exist we take a look at the DOS, MAC UNIX filenames. If no one exist the required F entry will be returned.
- Returns:
- The preferred file name.
-
getFileUnicode
This will get the unicode file name.- Returns:
- The file name.
-
setFileUnicode
This will set the unicode file name. If you call this, then do not forget to also callsetFile(String)
or the attachment will not be visible on some viewers.- Parameters:
file
- The name of the file.
-
getFile
This will get the file name.- Specified by:
getFile
in classPDFileSpecification
- Returns:
- The file name.
-
setFile
This will set the file name. You should also callsetFileUnicode(String)
for cross-platform and cross-language compatibility.- Specified by:
setFile
in classPDFileSpecification
- Parameters:
file
- The name of the file.
-
getFileDos
This will get the name representing a Dos file.- Returns:
- The file name.
-
setFileDos
Deprecated.This method is obsolescent and should not be used by conforming writers.This will set name representing a dos file.- Parameters:
file
- The name of the file.
-
getFileMac
This will get the name representing a Mac file.- Returns:
- The file name.
-
setFileMac
Deprecated.This method is obsolescent and should not be used by conforming writers.This will set name representing a Mac file.- Parameters:
file
- The name of the file.
-
getFileUnix
This will get the name representing a Unix file.- Returns:
- The file name.
-
setFileUnix
Deprecated.This method is obsolescent and should not be used by conforming writers.This will set name representing a Unix file.- Parameters:
file
- The name of the file.
-
setVolatile
public void setVolatile(boolean fileIsVolatile) Tell if the underlying file is volatile and should not be cached by the reader application. Default: false- Parameters:
fileIsVolatile
- The new value for the volatility of the file.
-
isVolatile
public boolean isVolatile()Get if the file is volatile. Default: false- Returns:
- True if the file is volatile attribute is set.
-
getEmbeddedFile
Get the embedded file.- Returns:
- The embedded file for this file spec.
-
setEmbeddedFile
Set the embedded file for this spec. You should also callsetEmbeddedFileUnicode(PDEmbeddedFile)
for cross-platform and cross-language compatibility.- Parameters:
file
- The file to be embedded.
-
getEmbeddedFileDos
Get the embedded dos file.- Returns:
- The embedded dos file for this file spec.
-
setEmbeddedFileDos
Deprecated.This method is obsolescent and should not be used by conforming writers.Set the embedded dos file for this spec.- Parameters:
file
- The dos file to be embedded.
-
getEmbeddedFileMac
Get the embedded Mac file.- Returns:
- The embedded Mac file for this file spec.
-
setEmbeddedFileMac
Deprecated.This method is obsolescent and should not be used by conforming writers.Set the embedded Mac file for this spec.- Parameters:
file
- The Mac file to be embedded.
-
getEmbeddedFileUnix
Get the embedded Unix file.- Returns:
- The embedded file for this file spec.
-
setEmbeddedFileUnix
Deprecated.This method is obsolescent and should not be used by conforming writers.Set the embedded Unix file for this spec.- Parameters:
file
- The Unix file to be embedded.
-
getEmbeddedFileUnicode
Get the embedded unicode file.- Returns:
- The embedded unicode file for this file spec.
-
setEmbeddedFileUnicode
Set the embedded Unicode file for this spec. If you call this, then do not forget to also callsetEmbeddedFile(PDEmbeddedFile)
or the attachment will not be visible on some viewers.- Parameters:
file
- The Unicode file to be embedded.
-
setFileDescription
Set the file description.- Parameters:
description
- The file description
-
getFileDescription
This will get the description.- Returns:
- The file description.
-