com.aspose.pdf.facades

The com.aspose.pdf.facades package provides classes originally came from Aspose.Pdf.Kit.

Interfaces

InterfaceDescription
IFacadeGeneral facade interface that defines common facades methods.
IFormClass representing Acro form object.
IFormEditorClass for editing forms (adding/deleting field etc)
IPdfFileEditorImplements operations with PDF file: concatenation, splitting, extracting pages, making booklet, etc.
IPdfFileStampinterface for adding stamps (watermark or background) to PDF files.
ISaveableFacadeFacade interface that defines methods common for all saveable facades.

Classes

ClassDescription
AlignmentTypeClass contains possibly alignment types. Use HorizontalAlignment instead
AutoRotateModeDirection of the rotation when document is printed.
BDCPropertiesBDC operator properties.
BookmarkRepresents a bookmark.
BookmarksRepresents a collection of {@code Bookmark} objects.
CgmPdfProducerRepresents a class to produce PDF from Computer Graphics Metafile(CGM) format.
DataTypeEnumerates field types definitions.
DefaultMetadataPropertiesEnumeration of standard XMP properties.
DocumentPrivilegeRepresents the privileges for accessing Pdf file. Refer to{@code PdfFileSecurity}. There are 4 ways using this class: 1.Using predefined privilege directly. 2.Based on a predefined privilege and change some specifical permissions. 3.Based on a predefined privilege and change some specifical Adobe Professional permissions combination. 4.Mixes the way2 and way3. //Way1: Using predefined privilege directly. DocumentPrivilege privilege = DocumentPrivilege.getPrint(); //Way2: Based on a predefined privilege and change some specifical permissions. DocumentPrivilege privilege = DocumentPrivilege.getAllowAll(); privilege.setAllowPrint(false); privilege.setAllowModifyContents(false); //Way3: Based on a predefined privilege and change some specifical Adobe Professional permissions combination. DocumentPrivilege privilege = DocumentPrivilege.getForbidAll(); privilege.setChangeAllowLevel(1); privilege.setPrintAllowLevel(2); //Way4: Mixes the way2 and way3 DocumentPrivilege privilege = DocumentPrivilege.getForbidAll(); privilege.setChangeAllowLevel(1); privilege.setAllowPrint(true);
EncodingTypeEnumerates encoding types of the text using.
FacadeBase facade class.
FontColorClass representing color of the text.
FormClass representing Acro form object.
Form.ImportStatusStatus of imported field
FormattedTextClass which represents formatted text. Contains information about text and its color, size, style.
FormEditorClass for editing forms (adding/deleting field etc)
FormEditorWebClass for editing forms (ading/deleting field etc)
FormFieldFacadeClass for representing field properties.
FormWebRepresenting Acro form Interface.
InternalHelperHelp class
IPdfFileEditor.ContentsResizeParametersClass for specifing page resize parameters. Allow to set the following parameters: Size of result page (width, height) in default space units or in percents of initial pages size; Left, Top, Bottom and Right margins in default space units or in percents of initial page size; Some values may be left null for automatic calculation. These values will be calculated from rest of page size after calculation explicitly specified values. For example: if page width = 100 and new page width specified 60 units then left and right margins are automatically calculated: (100 - 60) / 2 = 15. This class is used in ResizeContents method.
IPdfFileEditor.ContentsResizeValueValue of margin or content size specified in percents of default space units. This class is used in ContentsResizeParameters.
LineInfoRepresents the information of line.
PdfAnnotationEditorRepresents a class for work with PDF document annotations (comments).
PdfBookmarkEditorRepresents a class to work with PDF file’s bookmarks including create, modify, export, import and delete.
PdfContentEditorRepresents a class to edit PDF file’s content.
PdfConverterRepresents a class to convert a pdf file’s each page to images, supporting BMP, JPEG, PNG and TIFF now. Supported content in pdfs: pictures, form, comment.
PdfExtractorClass for extracting images and text from PDF document.
PdfFileEditorImplements operations with PDF file: concatenation, splitting, extracting pages, making booklet, etc.
PdfFileEditor.ConcatenateCorruptedFileActionAction performed when corrupted file was met in concatenation process.
PdfFileEditor.ConcatenationProgressHandlerRepresents class with abstract method that usually supplied by calling side and handles progress events that comes from concatenation. Usually such supplied customer’s handler can be used to show total concatenation progress on console or in progress bar. represents information about occurred progress event
PdfFileEditor.CorruptedItemClass which provides information about corrupted files in time of concatenation.
PdfFileEditor.PageBreakData of page break position.
PdfFileEditor.ProgressEventHandlerInfoThis class represents information about concatenation progress that can be used in external application.
PdfFileEditor.ProgressEventTypeThis enum describes possible progress event types that can occure during concatenation
PdfFileEditorWebRepresents PdfFileEditorWeb class Implements operations with PDF file: concatenation, splitting, extracting pages, making booklet, etc.
PdfFileInfoRepresents a class for accessing meta information of PDF document.
PdfFileMendRepresents a class for adding texts and images on the pages of existing PDF document.
PdfFileSanitizationRepresents sanitization and recovery API. Use it if you can’t create/open documents in any other way.
PdfFileSecurityRepresents encrypting or decrypting a Pdf file with owner or user password, changing the security setting and password.
PdfFileSignatureRepresents a class to sign a pdf file with a certificate.
PdfFileStampClass for adding stamps (watermark or background) to PDF files.
PdfFileStampWebClass for adding stamps (watermark or background) to PDF files. Enable to work with HttpServletResponse.
PdfJavaScriptStripperClass for removing all Java Script code.
PdfPageEditorRepresents a class to edit the PDF file’s page, including rotating page, zooming page, moving position and changing page size.
PdfPrintPageInfoRepresents an object that contains current printing page info.
PdfProducer

Represents a class to produce PDF from other formats.


This sample shows how to produce Pdf file from CGM file. String inputFile = “myImage.cgm”; String outputFile = “myPdf.pdf”; try { PdfProducer.produce(inputFile, ImportFormat.Cgm, outputFile); // Success produced pdf file. } catch (Exception e) { // Do something… } 
PdfQueryPageSettingsEventHandlerRepresents the method that handles the QueryPageSettings event of a PrintDocument.
PdfViewerRepresents a class to view or print a pdf.
PdfXmpMetadataClass for manipulation with XMP metadata.
PositioningModeDefines positioning mode. Possible values include Legacy (backward compatibility) and Current (updated text position calculation method)
PropertyFlagEnumeration of possible field flags.
ReplaceTextStrategyThis class contains parameters which define PdfContentEditor behavior when ReplaceText operation is performed.
SaveableFacade

Base class for all saveable facades.

SignatureNameRepresents a class for a signature name. Represents a more precise signature name. Used instead of string names. Allows you to present signatures with the same string names.
StampClass represeting stamp.
StampInfoClass representing stamp information.
TextPropertiesRepresents text properties such as: text size, color, style etc.
VerticalAlignmentTypeClass representing possible vertical alignment values. Use VerticalAlignment instead
ViewerPreferenceDescribes viewer prefereces (page mode, non full screen page mode, page layout).
WordWrapModeDefines word wrapping strategies

Enums

EnumDescription
AlgorithmRepresents algorithms which can be used to encrypt pdf document.
BlendingColorSpaceClass represents blending color space.
FieldTypeEnumeration of possible field types.
FontStyleEnumerates 14 types of font.
ImageMergeModeRepresents modes for merging images.
KeySizeDefines different key sizes which can be used to encrypt pdf documents.
ReplaceTextStrategy.NoCharacterActionAction to perform if font does not contain required character
ReplaceTextStrategy.ScopeScope where replace text operation is applied REPLACE_FIRST by default
StampTypeDescribes stamp types.
SubmitFormFlagEnumeration of possible submit form flags.