Package | Description |
---|---|
com.realobjects.pdfreactor |
Main access to the API of PDFreactor.
|
com.realobjects.pdfreactor.legacy |
Main access to the legacy API of PDFreactor, use of
com.realobjects.pdfreactor.PDFreactor is preferred. |
Modifier and Type | Method and Description |
---|---|
Configuration |
Configuration.setAddAttachments(Boolean value)
Enables or disables attachments specified in style sheets.
|
Configuration |
Configuration.setAddBookmarks(Boolean value)
Enables or disables bookmarks in the PDF document.
|
Configuration |
Configuration.setAddComments(Boolean value)
Enables or disables comments in the PDF document.
|
Configuration |
Configuration.setAddLinks(Boolean value)
Enables or disables links in the PDF document.
|
Configuration |
Configuration.setAddOverprint(Boolean value)
Enables or disables overprinting.
|
Configuration |
Configuration.setAddPreviewImages(Boolean value)
Enables or disables embedding of image previews per page in the PDF document.
|
Configuration |
Configuration.setAddTags(Boolean value)
Enables or disables tagging of the PDF document.
|
Configuration |
Configuration.setAllowAnnotations(Boolean value)
Enables or disables the 'annotations' restriction in the PDF document.
|
Configuration |
Configuration.setAllowAssembly(Boolean value)
Enables or disables the 'assembly' restriction in the PDF document.
|
Configuration |
Configuration.setAllowCopy(Boolean value)
Enables or disables the 'copy' restriction in the PDF document.
|
Configuration |
Configuration.setAllowDegradedPrinting(Boolean value)
Enables or disables the 'degraded printing' restriction in the PDF document.
|
Configuration |
Configuration.setAllowFillIn(Boolean value)
Enables or disables the 'fill in' restriction in the PDF document.
|
Configuration |
Configuration.setAllowModifyContents(Boolean value)
Enables or disables the 'modify contents' restriction in the PDF document.
|
Configuration |
Configuration.setAllowPrinting(Boolean value)
Enables or disables the 'printing' restriction in the PDF document.
|
Configuration |
Configuration.setAllowScreenReaders(Boolean value)
Enables or disables the 'screen readers' restriction in the PDF document.
|
Configuration |
Configuration.setAppendLog(Boolean value)
Specifies whether or not the log data should be added to the PDF document.
|
Configuration |
Configuration.setAttachments(Configuration.Attachment[] values)
Adds a file attachment to PDF document.
|
Configuration |
Configuration.setAuthenticationCredentials(Configuration.KeyValuePair value)
Enables access to resources that are secured via Basic or Digest authentication.
|
Configuration |
Configuration.setAuthor(String value)
Sets the value of the author field of the PDF document.
|
Configuration |
Configuration.setBaseURL(String value)
Sets the base URL of the document.
|
Configuration |
Configuration.setBookletMode(Configuration.BookletMode value)
Convenience method to set pages-per-sheet properties and page order
in one step to create a booklet.
|
Configuration |
Configuration.setCacheFonts(Boolean value)
Enables or disables caching of font information.
|
Configuration |
Configuration.setCleanupTool(Configuration.Cleanup value)
Sets the cleanup tool to use for documents with unparsable content.
|
Configuration |
Configuration.setColorSpaceSettings(Configuration.ColorSpaceSettings colorSpaceSettings)
Specifies color space related settings.
|
Configuration |
Configuration.setConformance(Configuration.Conformance value)
Sets the conformance of the PDF.
|
Configuration |
Configuration.setContentObserver(Configuration.ContentObserver value)
Specifies parts of the document's content that should be observed and logged in
greater detail.
|
Configuration |
Configuration.setContinuousOutput(Configuration.ContinuousOutput value)
Enables the conversion of the input document into one image.
|
Configuration |
Configuration.setConversionName(String value)
Sets a name for the conversion.
|
Configuration |
Configuration.setCookies(Configuration.KeyValuePair[] values)
Adds a cookie to all outgoing HTTP connections.
|
Configuration |
Configuration.setCreator(String value)
Sets the value of creator field of the PDF document.
|
Configuration |
Configuration.setCssSettings(Configuration.CssSettings settings)
Specifies the behavior of PDFreactor regarding the support and validation
of CSS properties and their declaration.
|
Configuration |
Configuration.setCustomDocumentProperties(Configuration.KeyValuePair[] values)
Adds a custom property to the PDF document.
|
Configuration |
Configuration.setCustomUrlStreamHandlers(Configuration.CustomUrlStreamHandler[] values)
Adds a
URLStreamHandler for the specified protocol which will be used for all connections
to retrieve the input document and resources. |
Configuration |
Configuration.setDebugSettings(Configuration.DebugSettings value)
Enables and configures debug settings, which add additional information to the output.
|
Configuration |
Configuration.setDefaultColorSpace(Configuration.ColorSpace value)
Deprecated.
|
Configuration |
Configuration.setDisableFontEmbedding(Boolean value)
Sets whether fonts will not be embedded into the resulting PDF.
|
Configuration |
Configuration.setDisableFontRegistration(Boolean value)
Enables or disables the font registration.
|
Configuration |
Configuration.setDisableSystemFonts(Boolean value)
Enables or disables the use of system fonts.
|
Configuration |
Configuration.setDocument(byte[] value)
The input document as a byte array.
|
Configuration |
Configuration.setDocument(InputSource value)
The document as
InputSource . |
Configuration |
Configuration.setDocument(Object value)
Deprecated.
|
Configuration |
Configuration.setDocument(String value)
The input document.
|
Configuration |
Configuration.setDocumentDefaultLanguage(String value)
Sets the language used for documents having no explicit language attribute set.
|
Configuration |
Configuration.setDocumentType(Configuration.Doctype value)
Sets the document type.
|
Configuration |
Configuration.setEnableDebugMode(Boolean value)
Deprecated.
|
Configuration |
Configuration.setEncoding(String value)
Sets the encoding of the document.
|
Configuration |
Configuration.setEncryption(Configuration.Encryption value)
Sets the encryption.
|
Configuration |
Configuration.setErrorPolicies(Configuration.ErrorPolicy[] values)
Specifies error policies that will be used for the conversion.
|
Configuration |
Configuration.setFontAliases(Configuration.Font[] values)
Registers an alias font family for an existing font.
|
Configuration |
Configuration.setFontCachePath(String value)
Sets the path of the font cache.
|
Configuration |
Configuration.setFontDirectories(String[] values)
Registers an additional font directory to load fonts from.
|
Configuration |
Configuration.setFontFallback(String[] values)
Sets a list of fallback font families used for character substitution.
|
Configuration |
Configuration.setFonts(Configuration.Font[] values)
Loads a font from a URL which can be used via the CSS property
font-family . |
Configuration |
Configuration.setForceGrayscaleImage(Boolean value)
If the output format is an image format, this setting controls whether a
grayscale image should be returned.
|
Configuration |
Configuration.setFullCompression(Boolean value)
Enables or disables full compression of the PDF document.
|
Configuration |
Configuration.setHttpsMode(Configuration.HttpsMode value)
Sets the HTTPS mode.
|
Configuration |
Configuration.setIgnoreAlpha(Boolean value)
Sets whether the alpha value of CSS RGBA colors is ignored.
|
Configuration |
Configuration.setIntegrationStyleSheets(Configuration.Resource[] values)
Adds an integration style sheet to the document.
|
Configuration |
Configuration.setJavaScriptMode(Configuration.JavaScriptMode value)
Deprecated.
|
Configuration |
Configuration.setJavaScriptSettings(Configuration.JavaScriptSettings value)
Specifies JavaScript related settings.
|
Configuration |
Configuration.setKeywords(String value)
Sets the value of the keywords field of the PDF document.
|
Configuration |
Configuration.setLicenseKey(String value)
Sets the license key using a string.
|
Configuration |
Configuration.setLogExceedingContent(Configuration.LogExceedingContent value)
Deprecated.
|
Configuration |
Configuration.setLogger(Logger value)
Sets a
Logger to receive log messages. |
Configuration |
Configuration.setLogLevel(Configuration.LogLevel value)
Sets the log level.
|
Configuration |
Configuration.setMediaFeatureValues(Configuration.MediaFeatureValue[] values)
Defines the value of a Media Feature which is used to resolve CSS3 media queries.
|
Configuration |
Configuration.setMediaTypes(String[] values)
Sets the media types that are used to resolve CSS3 media queries.
|
Configuration |
Configuration.setMergeByteArray(byte[] value)
Deprecated.
|
Configuration |
Configuration.setMergeByteArrays(byte[][] values)
Deprecated.
|
Configuration |
Configuration.setMergeDocuments(Configuration.Resource[] documents)
This method sets external PDF documents which will be
merged with the PDF document generated by the HTML source.
|
Configuration |
Configuration.setMergeMode(Configuration.MergeMode value)
Sets the merge mode.
|
Configuration |
Configuration.setMergeURL(String value)
Deprecated.
|
Configuration |
Configuration.setMergeURLs(String[] values)
Deprecated.
|
Configuration |
Configuration.setOutputFormat(Configuration.OutputFormat value)
Sets the
Configuration.OutputFormat . |
Configuration |
Configuration.setOutputIntent(Configuration.OutputIntent value)
Sets the output intent including the identifier and the ICC profile to be embedded into the PDF.
|
Configuration |
Configuration.setOverlayRepeat(Configuration.OverlayRepeat value)
If one of the documents of an overlay process is shorter than the other, this method
allows repeating either its last page or all of its pages in order to overlay all pages of
the longer document.
|
Configuration |
Configuration.setOwnerPassword(String value)
Sets the owner password of the PDF document.
|
Configuration |
Configuration.setPageOrder(Configuration.PageOrder value)
Sets the page order of the direct result of the conversion.
|
Configuration |
Configuration.setPageOrder(String value)
Sets the page order of the direct result of the conversion.
|
Configuration |
Configuration.setPagesPerSheetProperties(Configuration.PagesPerSheetProperties value)
Sets the properties of a sheet on which multiple pages are being arranged.
|
Configuration |
Configuration.setPdfScriptAction(Configuration.PdfScriptAction[] values)
Sets a pair of trigger event and PDF script.
|
Configuration |
Configuration.setPixelsPerInch(Integer value)
Sets the pixels per inch.
|
Configuration |
Configuration.setPixelsPerInchShrinkToFit(Boolean value)
Whether the pixels per inch should be adapted automatically to avoid content exceeding pages.
|
Configuration |
Configuration.setPostTransformationDocumentType(Configuration.Doctype value)
Sets the document type after the XSL-Transformations have been applied.
|
Configuration |
Configuration.setPrintDialogPrompt(Boolean value)
Enables or disables a print dialog to be shown upon opening
the generated PDF document by a PDF viewer.
|
Configuration |
Configuration.setProcessingPreferences(Configuration.ProcessingPreferences[] values)
Preferences that influence the conversion process without changing
the output.
|
Configuration |
Configuration.setProgressEventListeners(ProgressEventListener[] values)
Adds a
ProgressEventListener . |
Configuration |
Configuration.setQuirksSettings(Configuration.QuirksSettings quirksSettings)
Allows to enable or disable behaviors
that are otherwise depend on the doctype of the input document.
|
Configuration |
Configuration.setRawCookies(Configuration.KeyValuePair[] values)
Adds a cookie to all outgoing HTTP connections.
|
Configuration |
Configuration.setRequestHeaders(Configuration.KeyValuePair[] values)
Adds a request header to all outgoing HTTP connections.
|
Configuration |
Configuration.setResourceConnectTimeout(Integer value)
Sets a timeout in milliseconds for connecting to resources, such as HTTP requests to
style sheets, images etc.
|
Configuration |
Configuration.setResourceReadTimeout(Integer value)
Sets a timeout in milliseconds for reading resources, such as HTTP requests to
style sheets, images etc.
|
Configuration |
Configuration.setResourceRequestTimeout(Integer value)
Deprecated.
|
Configuration |
Configuration.setSecuritySettings(Configuration.SecuritySettings securitySettings)
Specifies resource loading and document processing behavior with regards to
security to protect against untrusted code or content.
|
Configuration |
Configuration.setSegmentationSettings(Configuration.SegmentationSettings segmentationSettings)
This property configures segmentation of the conversion,
which helps with very large documents.
|
Configuration |
Configuration.setSignPDF(Configuration.SignPDF value)
Sets a digital certificate to sign the newly created PDF.
|
Configuration |
Configuration.setSubject(String value)
Sets the value of the subject field of the PDF document.
|
Configuration |
Configuration.setThrowLicenseExceptions(Boolean value)
Deprecated.
|
Configuration |
Configuration.setTitle(String value)
Sets the value of the title field of the PDF document.
|
Configuration |
Configuration.setUserPassword(String value)
Sets the user password of the PDF document.
|
Configuration |
Configuration.setUserScripts(Configuration.Resource[] values)
Adds an user script to the document.
|
Configuration |
Configuration.setUserStyleSheets(Configuration.Resource[] values)
Adds a user style sheet to the document.
|
Configuration |
Configuration.setValidateConformance(Boolean value)
Enables PDFreactor to validate the generated PDF against the
Configuration.Conformance specified via Configuration.setConformance(Conformance) . |
Configuration |
Configuration.setViewerPreferences(Configuration.ViewerPreferences[] values)
Sets the page layout and page mode preferences of the PDF.
|
Configuration |
Configuration.setXmp(Configuration.Xmp value)
Sets custom XMP to be embedded into the PDF document.
|
Configuration |
Configuration.setXsltMode(Boolean value)
Enables or disables XSLT transformations.
|
Configuration |
Configuration.setXsltStyleSheets(Configuration.Resource[] values)
Adds an XSLT style sheet to the document.
|
Modifier and Type | Method and Description |
---|---|
Result |
PDFreactor.convert(Configuration configuration)
Converts the specified
Configuration into PDF or image. |
Result |
PDFreactor.convert(Configuration configuration,
OutputStream outputStream)
Converts the specified
Configuration into PDF or image and writes it directly
in the supplied OutputStream . |
byte[] |
PDFreactor.convertAsBinary(Configuration configuration)
Converts the specified
Configuration into PDF or image. |
void |
PDFreactor.convertAsBinary(Configuration configuration,
OutputStream outputStream)
Converts the specified
Configuration into PDF or image and writes it directly
in the supplied OutputStream . |
Constructor and Description |
---|
PDFreactorCompatibilityLayer(Configuration config,
com.realobjects.pdfreactor.core.util.CachingLogHandler handler)
Creates an instance of
PDFreactor . |
This doc was generated on 2020-09-17. Copyright © 2002-2020 RealObjects GmbH. All Rights Reserved.