Index (pdfOffice 2.0.3 API)

AbstractOfficeConverterProperties - Class in com.itextpdf.pdfoffice

A class that keeps common conversion properties for different office files.

addPageSequence(int, int) - Method in class com.itextpdf.pdfoffice.OfficePageRange

Adds a page sequence to the range.

addSinglePage(int) - Method in class com.itextpdf.pdfoffice.OfficePageRange

Adds a single page to the range.

aggregate(AbstractStatisticsEvent) - Method in class com.itextpdf.pdfoffice.statistics.PdfOfficeFileTypeStatisticsAggregator

Aggregates office file type from the provided event.

apply(IPSSettings) - Method in interface com.itextpdf.pdfoffice.SheetSelector

Applies this sheet selector properties to IPSSettings settings instance.

BLANK_SHEET_NAME - Static variable in class com.itextpdf.pdfoffice.exceptions.PdfOfficeExceptionMessageConstant

Message about selecting sheet with blank name.

com.itextpdf.pdfoffice - package com.itextpdf.pdfoffice

com.itextpdf.pdfoffice.actions.data - package com.itextpdf.pdfoffice.actions.data

com.itextpdf.pdfoffice.actions.events - package com.itextpdf.pdfoffice.actions.events

com.itextpdf.pdfoffice.exceptions - package com.itextpdf.pdfoffice.exceptions

com.itextpdf.pdfoffice.logs - package com.itextpdf.pdfoffice.logs

com.itextpdf.pdfoffice.statistics - package com.itextpdf.pdfoffice.statistics

CONVERSION_FAILED - Static variable in class com.itextpdf.pdfoffice.exceptions.PdfOfficeExceptionMessageConstant

Message about a conversion failure.

CONVERT_FILE - Static variable in class com.itextpdf.pdfoffice.actions.events.PdfOfficeProductEvent

Convert file event type.

convertOfficeDocumentToPdf(File, File) - Static method in class com.itextpdf.pdfoffice.OfficeConverter

Converts an office document to a PDF.

convertOfficeDocumentToPdf(File, File, OfficeDocumentConverterProperties) - Static method in class com.itextpdf.pdfoffice.OfficeConverter

Converts an office document to a PDF with the specified conversion properties.

convertOfficeDocumentToPdf(InputStream, OutputStream) - Static method in class com.itextpdf.pdfoffice.OfficeConverter

Converts an office document to a PDF.

convertOfficeDocumentToPdf(InputStream, OutputStream, OfficeDocumentConverterProperties) - Static method in class com.itextpdf.pdfoffice.OfficeConverter

Converts an office document to a PDF with the specified conversion properties.

convertOfficePresentationToPdf(File, File) - Static method in class com.itextpdf.pdfoffice.OfficeConverter

Converts an office presentation to a PDF.

convertOfficePresentationToPdf(File, File, OfficePresentationConverterProperties) - Static method in class com.itextpdf.pdfoffice.OfficeConverter

Converts an office presentation to a PDF with the specified conversion properties.

convertOfficePresentationToPdf(InputStream, OutputStream) - Static method in class com.itextpdf.pdfoffice.OfficeConverter

Converts an office presentation to a PDF.

convertOfficePresentationToPdf(InputStream, OutputStream, OfficePresentationConverterProperties) - Static method in class com.itextpdf.pdfoffice.OfficeConverter

Converts an office presentation to a PDF with the specified conversion properties.

convertOfficeSpreadsheetToPdf(File, File) - Static method in class com.itextpdf.pdfoffice.OfficeConverter

Converts an office spreadsheet to a PDF.

convertOfficeSpreadsheetToPdf(File, File, OfficeSpreadsheetConverterProperties) - Static method in class com.itextpdf.pdfoffice.OfficeConverter

Converts an office spreadsheet to a PDF with the specified conversion properties.

convertOfficeSpreadsheetToPdf(InputStream, OutputStream) - Static method in class com.itextpdf.pdfoffice.OfficeConverter

Converts an office spreadsheet to a PDF.

convertOfficeSpreadsheetToPdf(InputStream, OutputStream, OfficeSpreadsheetConverterProperties) - Static method in class com.itextpdf.pdfoffice.OfficeConverter

Converts an office spreadsheet to a PDF with the specified conversion properties.

createActiveSheetSelector() - Static method in class com.itextpdf.pdfoffice.SheetSelectorFactory

Creates SheetSelector instance with active sheet selected.

createAllSheetsSelector() - Static method in class com.itextpdf.pdfoffice.SheetSelectorFactory

Creates SheetSelector instance with all sheets selected.

createConvertFileEvent(SequenceId, IMetaInfo) - Static method in class com.itextpdf.pdfoffice.actions.events.PdfOfficeProductEvent

Creates a convert-file event which is associated with a general identifier and additional meta data.

createSheetsSelector(Set) - Static method in class com.itextpdf.pdfoffice.SheetSelectorFactory

Creates SheetSelector instance with specified sheet names selected.

createStatisticsAggregatorFromName(String) - Method in class com.itextpdf.pdfoffice.statistics.PdfOfficeFileTypeStatisticsEvent

FILE_TOO_BIG_FOR_INPUT_STREAM - Static variable in class com.itextpdf.pdfoffice.logs.PdfOfficeLogMessageConstant

The constant FILE_TOO_BIG_FOR_INPUT_STREAM.

FILE_TYPE_IS_NOT_DETECTED - Static variable in class com.itextpdf.pdfoffice.exceptions.PdfOfficeExceptionMessageConstant

Message for case when office file type is not detected.

getEventType() - Method in class com.itextpdf.pdfoffice.actions.events.PdfOfficeProductEvent

getInstance() - Static method in class com.itextpdf.pdfoffice.actions.data.PdfOfficeProductData

Getter for an instance of ProductData related to iText pdfOffice module.

getMaxPagesToFitColumns() - Method in class com.itextpdf.pdfoffice.OfficeSpreadsheetConverterProperties

Gets number of pages to fit to in width.

getMaxPagesToFitRows() - Method in class com.itextpdf.pdfoffice.OfficeSpreadsheetConverterProperties

Gets number of pages to fit to in height.

getPageRange() - Method in class com.itextpdf.pdfoffice.OfficeDocumentConverterProperties

Gets the range of the document's pages which will be rendered.

getPageRange() - Method in class com.itextpdf.pdfoffice.OfficePresentationConverterProperties

Gets the range of the presentation's pages which will be rendered.

getSheetSelector() - Method in class com.itextpdf.pdfoffice.OfficeSpreadsheetConverterProperties

Gets the selector of the workbook sheets which will be rendered.

getStatisticsNames() - Method in class com.itextpdf.pdfoffice.statistics.PdfOfficeFileTypeStatisticsEvent

getThreadWaitingTimeLimit() - Method in class com.itextpdf.pdfoffice.AbstractOfficeConverterProperties

Deprecated.

this parameter does not have any effect anymore because now threads performing conversion do not wait on anything

INPUT_FILE_DOES_NOT_EXIST - Static variable in class com.itextpdf.pdfoffice.exceptions.PdfOfficeExceptionMessageConstant

Message for case when input file does not exist.

INVALID_CHARACTERS_IN_SHEET_NAME - Static variable in class com.itextpdf.pdfoffice.exceptions.PdfOfficeExceptionMessageConstant

Message about selecting sheet with name containing invalid characters.

isIgnorePrintArea() - Method in class com.itextpdf.pdfoffice.OfficeSpreadsheetConverterProperties

Gets the spreadsheet ignore print area setting.

merge(AbstractStatisticsAggregator) - Method in class com.itextpdf.pdfoffice.statistics.PdfOfficeFileTypeStatisticsAggregator

Merges data about amounts of office file types being converted from the provided aggregator into this aggregator.

MULTITHREADING_DOCUMENT_CONVERSION_IS_NOT_SUPPORTED - Static variable in class com.itextpdf.pdfoffice.logs.PdfOfficeLogMessageConstant

Deprecated.

this field will be removed in next major release

NEGATIVE_OR_ZERO_VALUES_ARE_NOT_ALLOWED - Static variable in class com.itextpdf.pdfoffice.exceptions.PdfOfficeExceptionMessageConstant

Message about the impossibility of using negative or zero values.

NOT_POSSIBLE_TO_WRITE_OUTPUT - Static variable in class com.itextpdf.pdfoffice.exceptions.PdfOfficeExceptionMessageConstant

Message about the impossibility use the passed stream to create a PDF.

NULL_SHEET_NAME - Static variable in class com.itextpdf.pdfoffice.exceptions.PdfOfficeExceptionMessageConstant

Message about selecting sheet with null name.

OfficeConverter - Class in com.itextpdf.pdfoffice

The main class for converting office files to PDF.

OfficeDocumentConverterProperties - Class in com.itextpdf.pdfoffice

A class that keeps conversion properties specific for office documents.

OfficeDocumentConverterProperties() - Constructor for class com.itextpdf.pdfoffice.OfficeDocumentConverterProperties

Creates OfficeDocumentConverterProperties instance.

OfficePageRange - Class in com.itextpdf.pdfoffice

A class that keeps selected pages for office documents or presentations.

OfficePageRange() - Constructor for class com.itextpdf.pdfoffice.OfficePageRange

Constructs an empty OfficePageRange instance.

OfficePresentationConverterProperties - Class in com.itextpdf.pdfoffice

A class that keeps conversion properties specific for office presentations.

OfficePresentationConverterProperties() - Constructor for class com.itextpdf.pdfoffice.OfficePresentationConverterProperties

Creates OfficePresentationConverterProperties instance.

OfficeSpreadsheetConverterProperties - Class in com.itextpdf.pdfoffice

A class that keeps conversion properties specific for office sheets.

OfficeSpreadsheetConverterProperties() - Constructor for class com.itextpdf.pdfoffice.OfficeSpreadsheetConverterProperties

Creates OfficeSpreadsheetConverterProperties instance.

OUTPUT_PDF_HAS_NO_PAGES - Static variable in class com.itextpdf.pdfoffice.exceptions.PdfOfficeExceptionMessageConstant

Message about PDF which doesn't have pages.

PAGE_NUMBER_EQUALS_TO_ZERO - Static variable in class com.itextpdf.pdfoffice.exceptions.PdfOfficeExceptionMessageConstant

Message about a page number equal to zero.

PASSED_FILE_IS_UNSUPPORTED - Static variable in class com.itextpdf.pdfoffice.exceptions.PdfOfficeExceptionMessageConstant

Message about an unsupported input document type.

PASSED_RANGE_IS_EMPTY_AGAINST_PASSED_FILE - Static variable in class com.itextpdf.pdfoffice.exceptions.PdfOfficeExceptionMessageConstant

The passed range is resolved against the passed file, the resultant range is empty, so nothing is going to be converted to PDF.

PdfOfficeException - Exception in com.itextpdf.pdfoffice.exceptions

Runtime exception that gets thrown if something goes wrong in the office files to PDF conversion.

PdfOfficeException(String) - Constructor for exception com.itextpdf.pdfoffice.exceptions.PdfOfficeException

Creates PdfOfficeException instance.

PdfOfficeException(String, Throwable) - Constructor for exception com.itextpdf.pdfoffice.exceptions.PdfOfficeException

Creates PdfOfficeException instance.

PdfOfficeExceptionMessageConstant - Class in com.itextpdf.pdfoffice.exceptions

The class containing the exception messages.

PdfOfficeFileTypeStatisticsAggregator - Class in com.itextpdf.pdfoffice.statistics

Statistics aggregator which aggregates types of office files to be converted to PDF documents.

PdfOfficeFileTypeStatisticsAggregator() - Constructor for class com.itextpdf.pdfoffice.statistics.PdfOfficeFileTypeStatisticsAggregator

Creates PdfOfficeFileTypeStatisticsAggregator instance.

PdfOfficeFileTypeStatisticsEvent - Class in com.itextpdf.pdfoffice.statistics

Class which represents an event for specifying type of an office file, which has been converted to PDF.

PdfOfficeFileTypeStatisticsEvent(AbstractOfficeConverterProperties) - Constructor for class com.itextpdf.pdfoffice.statistics.PdfOfficeFileTypeStatisticsEvent

Creates an instance of this class based on the ProductData and the conversion properties.

PdfOfficeLogMessageConstant - Class in com.itextpdf.pdfoffice.logs

Class that bundles all the pdfOffice's error message templates as constants.

PdfOfficeProductData - Class in com.itextpdf.pdfoffice.actions.data

Stores an instance of ProductData related to iText pdfOffice module.

PdfOfficeProductEvent - Class in com.itextpdf.pdfoffice.actions.events

Class represents events registered in iText pdfOffice module.

RANGE_HAS_DESCENDING_ORDER - Static variable in class com.itextpdf.pdfoffice.exceptions.PdfOfficeExceptionMessageConstant

The constant RANGE_HAS_DESCENDING_ORDER.

retrieveAggregation() - Method in class com.itextpdf.pdfoffice.statistics.PdfOfficeFileTypeStatisticsAggregator

Retrieves Map where keys are office file types and values are the amounts of such input files being converted.

SAME_SHEET_NAME_HAS_BEEN_PASSED - Static variable in class com.itextpdf.pdfoffice.logs.PdfOfficeLogMessageConstant

The constant SAME_SHEET_NAME.

SELECTING_NON_EXISTING_SHEET - Static variable in class com.itextpdf.pdfoffice.logs.PdfOfficeLogMessageConstant

The constant SELECTING_NON_EXISTING_SHEET.

setEventMetaInfo(IMetaInfo) - Method in class com.itextpdf.pdfoffice.AbstractOfficeConverterProperties

Sets pdfOffice's meta info.

setIgnorePrintArea(boolean) - Method in class com.itextpdf.pdfoffice.OfficeSpreadsheetConverterProperties

Defines whether all the sheet's content, including content outside print area, should be converted.

setMaxPagesToFitColumns(Integer) - Method in class com.itextpdf.pdfoffice.OfficeSpreadsheetConverterProperties

Sets the maximal number of pages which the sheet can occupy horizontally.

setMaxPagesToFitRows(Integer) - Method in class com.itextpdf.pdfoffice.OfficeSpreadsheetConverterProperties

Sets the maximal number of pages which the sheet can occupy vertically.

setPageRange(OfficePageRange) - Method in class com.itextpdf.pdfoffice.OfficeDocumentConverterProperties

Defines the range of the document's pages which will be rendered.

setPageRange(OfficePageRange) - Method in class com.itextpdf.pdfoffice.OfficePresentationConverterProperties

Defines the range of the presentation's pages which will be rendered.

setSheetSelector(SheetSelector) - Method in class com.itextpdf.pdfoffice.OfficeSpreadsheetConverterProperties

Defines the selector of the workbook sheets which will be rendered.

setThreadWaitingTimeLimit(long) - Method in class com.itextpdf.pdfoffice.AbstractOfficeConverterProperties

Deprecated.

this parameter does not have any effect anymore because now threads performing conversion do not wait on anything

SheetSelector - Interface in com.itextpdf.pdfoffice

Interface for sheet selectors.

SheetSelectorFactory - Class in com.itextpdf.pdfoffice

Factory class for creating SheetSelector instances.

THREAD_WAITING_TIME_EXCEEDED_MAXIMUM_LIMIT - Static variable in class com.itextpdf.pdfoffice.exceptions.PdfOfficeExceptionMessageConstant

Deprecated.

this field will be removed in next major release

THREAD_WAS_INTERRUPTED_DURING_CONVERSION - Static variable in class com.itextpdf.pdfoffice.exceptions.PdfOfficeExceptionMessageConstant

Deprecated.

this field will be removed in next major release

TOO_LONG_SHEET_NAME - Static variable in class com.itextpdf.pdfoffice.exceptions.PdfOfficeExceptionMessageConstant

Message about selecting sheet with too long name.