Document

Огляд

Document є клас в Aspose.PDF FOSS для Java. Наследники від: Closeable.

Центральний клас для роботи з документами PDF (ISO 32000-1:2008).

Цей клас надає 96 методів для роботи з об’єктами Document в програмах Java. Доступні методи включають: Document, allocateObjectNumber, close, convert, convertToPdfA2B, decrypt, encrypt, exportAnnotationsToXfdf, flatten, getActions, getBackground, getCatalog, і 59 додаткових методів. Всі публічні члени доступні будь-якій додаткові Java після встановлення FOSS для пакету Java. Свойства: actions, background, catalog, centerWindow, collection, displayDocTitle, і 32 ще.

Свойства

Назва:	Тип	Access	Опис
`background`	`Color`	Читати.	Повертає колір фону на рівні документа, встановлений за допомогою {@link #setBackground(Color)} або { @code null} для жодного.
`pages`	`PageCollection`	Читати.	Обирає сторінки.
`info`	`DocumentInfo`	Читати.	Повертає словник інформації про документ (ISO 32000-1:2008, §14.3.3).
`orCreateInfo`	`DocumentInfo`	Читати.	Зневіровані псевдоними для {@link #getInfo()}.
`metadata`	`XmpMetadata`	Читати.	Повертає метадані XMP цього документа.
`version`	`String`	Читати.	Повертає ряд версій PDF (наприклад:.
`catalog`	`PdfDictionary`	Читати.	Повертає словник каталогу корін.
`actions`	`DocumentActions`	Читати.	Повертає триггеры дій на рівні документів (ISO 32000-1:2008, §12.6.4.1): {@code /OpenAction} плюс записи { @code &AA} (will-close, will/did-save, Will/Did-print).
`trailer`	`PdfDictionary`	Читати.	Повертає словник причетної машини.
`parser`	`PDFParser`	Читати.	Повертає базовий аналізатор PDF (для внутрішнього використання компонентами двигуна).
`outlines`	`OutlineCollection`	Читати.	Повертає колекцію контур документів (закладки).
`form`	`Form`	Читати.	Повертає інтерактивну форму (AcroForm) цього документа.
`embeddedFiles`	`EmbeddedFileCollection`	Читати.	Повертає колекцію вбудованих файлів (прикладів).
`collection`	`Collection`	Читати.	Повертає портфель документа {@link Collection}, відзначаючи порожній при першому доступі.
`fontUtilities`	`FontUtilities`	Читати.	Повертає утилити шрифту для цього документа.
`embedStandardFonts`	`boolean`	Читати.	Повертає, чи повинні бути вбудовані стандартні шрифти PDF при збереженні.
`layers`	`java.util.List<Layer>`	Читати.	Повертає список опційних груп контенту (половин).
`viewerPreferences`	`ViewerPreferences`	Читати.	Повертає налаштування глядача.
`hideToolbar`	`boolean`	Читати.	Сховати переваги панелі інструментів.
`hideMenubar`	`boolean`	Читати.	Сховати переваги меню-полоски.
`hideWindowUI`	`boolean`	Читати.	Сховати переваги інтерфейсного користувача.
`fitWindow`	`boolean`	Читати.	Зготуйте передвиборчі умови.
`centerWindow`	`boolean`	Читати.	Перевага середнього вікна.
`displayDocTitle`	`boolean`	Читати.	Виявлення пріоритету заголовку документа.
`pageLayout`	`String`	Читати.	Розгляд сторінки (SinglePage, OneColumn , TwoColumnLeft і т. д.).
`pageMode`	`PageMode`	Читати.	Починає стаття.
`pageInfo`	`PageInfo`	Читати.	Заховує документ у файл.
`linearized`	`boolean`	Читати.	Повертає, чи є поточний документ лінійним для швидкого веб-погляду.
`sourcePath`	`String`	Читати.	Повертає шлях файлу, з якого завантажувався цей документ, або {@code null} для нових документів чи документов, загружених із потоків.
`fileName`	`String`	Читати.	Повертає назву файлу (шляху), з якої відкритий цей документ.
`namedDestinations`	`NamedDestinations`	Читати.	Повертає колекцію по імені напрямків документу.
`pageLabels`	`PageLabels`	Читати.	Повертає етикети сторінки, або {@code null} якщо { @ code /PageLabels} не присутній.
`taggedContent`	`TaggedContent`	Читати.	Повертає вміст документу, що надає доступ до дерева логічної структури.
`logicalStructure`	`StructTreeRoot`	Читати.	Повертає дерево логічної структури для читання.
`encrypted`	`boolean`	Читати.	Повертає істинне, якщо документ зашифрований.
`javaScript`	`JavaScriptCollection`	Читати.	Повертає колекцію JavaScript з дерева імен документа.
`pdfaCompliant`	`boolean`	Читати.	Повертає “істинне”, якщо цей документ відповідає стандартам PDF/A (зазначений після конвертування ((() або validaate (()).
`pdfFormat`	`PdfFormat`	Читати.	Повертає формат PDF цього документа після конвертування.

Методи

Signature	Опис
`Document(filePath: String)`	Відкриває PDF-документ з шляху файлу.
`Document(filePath: String, password: String)`	Відкриває PDF-документ з шляху файлу за допомогою пароля.
`Document(filePath: String, password: String, customHandler: ICustomSecurityHandler)`	Відкриває PDF-документ з шляху файлу за допомогою персонального обробника безпеки.
`Document(stream: InputStream)`	Відкриває PDF-документ з потоку введення.
`Document(stream: InputStream, password: String)`	Відкриває PDF-документ з потоку введення паролем.
`Document(stream: InputStream, password: String, customHandler: ICustomSecurityHandler)`	Відкриває PDF-документ з потоку введення за допомогою персонального обробника безпеки.
`Document()`	Створює новий порожній документ PDF.
`Document(filePath: String, options: HtmlLoadOptions)`	Створює PDF-документ з файлу HTML.
`Document(stream: InputStream, options: HtmlLoadOptions)`	Створює PDF-документ з потоку введення HTML.
`getBackground()` → `Color`	Повертає колір фону на рівні документа, встановлений за допомогою {@link #setBackground(Color)} або { @code null} для жодного.
`setBackground(color: Color)`	Наносить твердий колір фона на кожну сторінку в документі (через {@link Page#setBackground(Color)}).
`getPages()` → `PageCollection`	Відвертає сторінки.
`getInfo()` → `DocumentInfo`	Повертає словник інформації про документ (ISO 32000-1:2008, §14.3.3).
`getOrCreateInfo()` → `DocumentInfo`	Зневіровані псевдоними для {@link #getInfo()}.
`getMetadata()` → `XmpMetadata`	Повертає метадані XMP цього документа.
`setXmpMetadata(stream: InputStream)`	Налаштовує метадані XMP з нерозроблених байтів XML, прочитаних із потоку.
`getXmpMetadata(stream: OutputStream)`	Записує метадані XMP в байти XML у даний потоковий потік.
`getVersion()` → `String`	Повертає ряд версій PDF (наприклад:.
`getCatalog()` → `PdfDictionary`	Повертає словник каталогу корін.
`getActions()` → `DocumentActions`	Повертає триггеры дій на рівні документів (ISO 32000-1:2008, §12.6.4.1): {@code /OpenAction} плюс записи { @code &AA} (will-close, will/did-save, Will/Did-print).
`getTrailer()` → `PdfDictionary`	Повертає словник причетної машини.
`getParser()` → `PDFParser`	Повертає базовий аналізатор PDF (для внутрішнього використання компонентами двигуна).
`getOutlines()` → `OutlineCollection`	Повертає колекцію контур документів (закладки).
`getForm()` → `Form`	Повертає інтерактивну форму (AcroForm) цього документа.
`getEmbeddedFiles()` → `EmbeddedFileCollection`	Повертає колекцію вбудованих файлів (прикладів).
`getCollection()` → `Collection`	Повертає портфель документа {@link Collection}, відзначаючи порожній при першому доступі.
`setCollection(value: Collection)`	Замінить (або видалять, коли {@code value == null}) портфель документів.
`getFontUtilities()` → `FontUtilities`	Повертає утилити шрифту для цього документа.
`isEmbedStandardFonts()` → `boolean`	Повертає, чи повинні бути вбудовані стандартні шрифти PDF при збереженні.
`setEmbedStandardFonts(embed: boolean)`	Налаштовує, чи повинні бути вбудовані стандартні шрифти PDF при збереженні.
`getLayers()` → `java.util.List<Layer>`	Повертає список опційних груп контенту (половин).
`getViewerPreferences()` → `ViewerPreferences`	Повертає налаштування глядача.
`getHideToolbar()` → `boolean`	Сховати переваги панелі інструментів.
`setHideToolbar(v: boolean)`	Налаштує приховати переваги панелі інструментів.
`getHideMenubar()` → `boolean`	Сховати переваги меню-полоски.
`setHideMenubar(v: boolean)`	Налаштує приховати переваги меню-полоски.
`getHideWindowUI()` → `boolean`	Сховати переваги інтерфейсного користувача.
`setHideWindowUI(v: boolean)`	Налаштує переваги інтерфейсного користувача.
`getFitWindow()` → `boolean`	Зготуйте передвиборчі умови.
`setFitWindow(v: boolean)`	Налаштування відповідних переваг вікна.
`getCenterWindow()` → `boolean`	Перевага середнього вікна.
`setCenterWindow(v: boolean)`	Налаштує переваги середнього вікна.
`getDisplayDocTitle()` → `boolean`	Виявлення пріоритету заголовку документа.
`setDisplayDocTitle(v: boolean)`	Налаштує перевагу показу заголовку документа.
`getPageLayout()` → `String`	Розгляд сторінки (SinglePage, OneColumn , TwoColumnLeft і т. д.).
`setPageLayout(layout: String)`	Налаштує макет сторінки.
`getPageMode()` → `PageMode`	Повертає режим сторінки.
`setPageMode(mode: PageMode)`	Налаштує режим сторінки.
`getPageInfo()` → `PageInfo`	Заховує документ у файл.
`processParagraphs()`	Процесує абзаці для всіх сторінок (пропуск лаяут).
`save(filePath: String)`	@param filePath шлях виведення файлу @throws IOException якщо запис не вдається @ ThrowsIllegalArgumentException , якщо file PATH є нульовим /
`save()`	Записує документ назад на його приналежний маршрут.
`save(outputStream: OutputStream)`	Записує документ у потоку виходу.
`hasIncrementalUpdate()` → `boolean`	Повертає, чи містить поточний документ додаткові оновлення.
`optimize()`	Запрошує повне перезаписування на наступному збереженні замість додаткового додатка.
`requestFullRewrite()`	Запрошує наступну операцію збереження виконати повне перезаписування навіть якщо інкрементальне зберігання було б можливо.
`isLinearized()` → `boolean`	Повертає, чи є поточний документ лінійним для швидкого веб-погляду.
`optimizeResources()`	Видає невикористовані ресурси на рівні сторінки до наступного збереження.
`optimizeResources(options: org.aspose.pdf.optimization.OptimizationOptions)`	Оптимізує документ за передбаченими параметрами перед наступним збереженням.
`save(filePath: String, format: SaveFormat)`	Заховує документ у визначеному форматі.
`save(filePath: String, options: PdfSaveOptions)`	Заховує документ з зазначеними параметрами збереження PDF.
`save(filePath: String, options: HtmlSaveOptions)`	Записувати документ як HTML з зазначеними параметрами.
`getSourcePath()` → `String`	Повертає шлях файлу, з якого завантажувався цей документ, або {@code null} для нових документів чи документов, загружених із потоків.
`getFileName()` → `String`	Повертає назву файлу (шляху), з якої відкритий цей документ.
`setFileName(fileName: String)`	Назва файлу, пов’язаного з цим документом.
`exportAnnotationsToXfdf(filePath: String)`	Експорт усіх анотацій з цього документа в файл XFDF.
`exportAnnotationsToXfdf(stream: OutputStream)`	Експорт усіх анотацій з цього документа в потоку виходу XFDF.
`importAnnotationsFromXfdf(filePath: String)`	Імпортує аннотації з файлу XFDF в цей документ.
`importAnnotationsFromXfdf(stream: InputStream)`	Імпортує аннотації з потоку введення XFDF в цей документ.
`flatten()`	Порівнює весь документ: випекає всі аннотації та форми поля в потоки змісту сторінки, а потім видаляє антотацію і форму полів.
`flatten(settings: Form.FlattenSettings)`	Вирівнює документ за допомогою заданих налаштувань вирівняння форми.
`getNamedDestinations()` → `NamedDestinations`	Повертає колекцію по імені напрямків документу.
`getPageLabels()` → `PageLabels`	Повертає етикети сторінки, або {@code null} якщо { @ code /PageLabels} не присутній.
`getTaggedContent()` → `TaggedContent`	Повертає вміст документу, що надає доступ до дерева логічної структури.
`getLogicalStructure()` → `StructTreeRoot`	Повертає дерево логічної структури для читання.
`allocateObjectNumber()` → `int`	Назначає новий номер об’єкту для нового непрямого об"екта.
`registerImportedObject(body: PdfBase)` → `PdfObjectReference`	Реєструє об’єкт, імпортуваний з іншого документа за новим ключем.
`isEncrypted()` → `boolean`	Повертає істинне, якщо документ зашифрований.
`encrypt(userPassword: String, ownerPassword: String, permissions: int, cryptoAlgorithm: CryptoAlgorithm)`	Шифрує документ паролями користувача та власника за допомогою зазначеного алгоритму.
`encrypt(userPassword: String, ownerPassword: String, privilege: org.aspose.pdf.facades.DocumentPrivilege, customHandler: ICustomSecurityHandler)`	Шифрує документ за допомогою персонального оператора безпеки.
`encrypt(userPassword: String, ownerPassword: String, privilege: org.aspose.pdf.facades.DocumentPrivilege, cryptoAlgorithm: CryptoAlgorithm, usePdf20: boolean)`	Шифрує документ паролями користувача та власника за допомогою зазначеного алгоритму і набору привілей.
`decrypt()`	Розшифрує документ, видаляючи шифровку.
`getJavaScript()` → `JavaScriptCollection`	Повертає колекцію JavaScript з дерева імен документа.
`validate(outputLogPath: String, format: PdfFormat)` → `boolean`	Перевірка документа за зазначеним профілем формату PDF.
`validate(logStream: OutputStream, format: PdfFormat)` → `boolean`	Перевірка документа за зазначеним профілем формату PDF.
`validate(options: PdfFormatConversionOptions)` → `boolean`	Перевірка документа за допомогою об’єкта варіанту перевірки PDF/A.
`convert(outputLogPath: String, format: PdfFormat, action: ConvertErrorAction)` → `boolean`	Перераховує документ у визначений формат PDF.
`convert(logStream: OutputStream, format: PdfFormat, action: ConvertErrorAction)` → `boolean`	Перераховує документ у визначений формат PDF.
`convert(logStream: OutputStream, format: PdfFormat, action: ConvertErrorAction, transparencyAction: ConvertTransparencyAction)` → `boolean`	Конверти з явною обробкою прозорості.
`convert(options: PdfFormatConversionOptions)` → `boolean`	Конвертує за допомогою детальних варіантів конвертації.
`convertToPdfA2B(outputLogPath: String)` → `boolean`	Перераховує цей PDF у формат PDF/A-2B.
`convertToPdfA2B(logStream: OutputStream)` → `boolean`	Перераховує цей PDF у формат PDF/A-2B.
`repair()`	Спроби виправити дрібні структурні проблеми перед робочими потоками збереження, валідації або конверсії.
`isPdfaCompliant()` → `boolean`	Повертає “істинне”, якщо цей документ відповідає стандартам PDF/A (зазначений після конвертування ((() або validaate (()).
`getPdfFormat()` → `PdfFormat`	Повертає формат PDF цього документа після конвертування.
`close()`	Закриває документ і випускає базові ресурси.

Див. також

Aspose.PDF for Java — Enterprise API Reference