Package org.apache.fop.pdf
Class VersionController
java.lang.Object
org.apache.fop.pdf.VersionController
- Direct Known Subclasses:
VersionController.DynamicVersion
,VersionController.FixedVersion
An abstraction that controls the mutability of the PDF version for a document.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprivate static final class
A class representing the version of a PDF document.private static final class
A class representing the version of a PDF document. -
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescription(package private) abstract void
static VersionController
getDynamicVersionController
(Version initialVersion, PDFDocument doc) Returns a controller that allows subsequent changes to the document's version.static VersionController
getFixedVersionController
(Version version) Returns a controller that disallows subsequent change to the document's version.Returns the PDF version of the document.abstract void
setPDFVersion
(Version version) Sets the PDF version of the document.toString()
-
Field Details
-
version
-
-
Constructor Details
-
VersionController
-
-
Method Details
-
getPDFVersion
Returns the PDF version of the document.- Returns:
- the PDF version
-
setPDFVersion
Sets the PDF version of the document.- Parameters:
version
- the PDF version- Throws:
IllegalStateException
- if the PDF version is not allowed to change.
-
addTableHeaderScopeAttribute
abstract void addTableHeaderScopeAttribute(PDFStructElem th, StandardStructureAttributes.Table.Scope scope) -
toString
-
getFixedVersionController
Returns a controller that disallows subsequent change to the document's version. The minimum allowed version is v1.4.- Parameters:
version
- the PDF version (must be >= v1.4)- Returns:
- the fixed PDF version controller
-
getDynamicVersionController
public static VersionController getDynamicVersionController(Version initialVersion, PDFDocument doc) Returns a controller that allows subsequent changes to the document's version.- Parameters:
initialVersion
- the initial PDF versiondoc
- the document whose version is being set- Returns:
- the dynamic PDF version controller
-