Документът
Общ преглед
Document е клас в Aspose.PDF FOSS за Java. Наследници от: Closeable.
Централен клас за работа с PDF документи (ISO 32000-1:2008).
Този клас предоставя 96 метода за работа с документи в Java програми. Наличните методи включват: Document, allocateObjectNumber, close, convert, convertToPdfA2B, decrypt, encrypt, exportAnnotationsToXfdf, flatten, getActions, getBackground, getCatalog, и 59 допълнителни методи. Всички публични членове са достъпни за всяко приложение на Java след инсталиране на пакета Aspose.PDF FOSS for Java. Свойства: actions, background, catalog, centerWindow, collection, displayDocTitle, и още 32.
Свойства на веществата
| Име на фирмата: | Тип на изпитване | Достъп до информация | Описание на състоянието |
|---|---|---|---|
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} (ще-затваря, ще/съхранил ли е), | |||
| ще/да-печата). | |||
trailer | PdfDictionary | Прочети. | Връща речника на трейлъра. |
parser | PDFParser | Прочети. | Връща основното PDF-паразер (за вътрешно използване от компонентите на двигателя). |
outlines | OutlineCollection | Прочети. | Връща колекцията от очертания на документи (записвачи). |
form | Form | Прочети. | Връща интерактивната форма (AcroForm) на този документ. |
embeddedFiles | EmbeddedFileCollection | Прочети. | Връща колекция от вградени файлове (приложения). |
collection | Collection | Прочети. | Връща портфолиото на документа {@link Collection}, инстанцизиращо файл. |
| Празните при първия достъп. | |||
fontUtilities | FontUtilities | Прочети. | Връща утилитите за шрифта на този документ. |
embedStandardFonts | boolean | Прочети. | Връща дали стандартните 14 PDF шрифта трябва да бъдат вградени при съхранение. |
layers | java.util.List<Layer> | Прочети. | Връща списъка с опционни групи на съдържание (слоеве). |
viewerPreferences | ViewerPreferences | Прочети. | Връща предпочитанията на зрителя. |
hideToolbar | boolean | Прочети. | Скрийте предпочитанията на лентата с инструменти. |
hideMenubar | boolean | Прочети. | Скрийте предпочитанията на меню. |
hideWindowUI | boolean | Прочети. | Скрийте предпочитанията за прозореца. |
fitWindow | boolean | Прочети. | Сложи си предпочитанията на прозореца. |
centerWindow | boolean | Прочети. | Предпочитане на средното прозорче. |
displayDocTitle | boolean | Прочети. | Показване на предпочитания за заглавие на документа. |
pageLayout | String | Прочети. | Разположение на страницата (SinglePage, OneColumn и т.н.). |
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 (настроен след convert ((() или validate (())). |
pdfFormat | PdfFormat | Прочети. | Връща формата PDF на този документ след конвертиране. |
Методи за изчисляване на данните
| Подписът | Описание на състоянието |
|---|---|
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) | Записва XML байтове на XMP метаданните в даден изход. |
getVersion() → String | Връща редактирания код на PDF версия (напр. |
getCatalog() → PdfDictionary | Връща коренния каталог на речника. |
getActions() → DocumentActions | Връща активиращите действия на ниво документ (ISO 32000-1:2008, §12.6.4.1): |
| {@code /OpenAction} плюс вписванията { @code >AA} (ще-затваря, ще/съхранил ли е), | |
| ще/да-печата). | |
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 | Връща дали стандартните 14 PDF шрифта трябва да бъдат вградени при съхранение. |
setEmbedStandardFonts(embed: boolean) | Определя дали стандартните 14 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 и т.н.). |
setPageLayout(layout: String) | Настройва оформлението на страницата. |
getPageMode() → PageMode | Връща режим на страница. |
setPageMode(mode: PageMode) | Настройва режим на страницата. |
getPageInfo() → PageInfo | Съхранява документа в файл. |
processParagraphs() | Обработва параграфи за всички страници (пропускане на оформлението). |
save(filePath: String) | @param filePath път на изходния файл |
| @throws IOException ако писането се провали. | |
| @ изхвърля IllegalArgumentException ако filePath е нулева | |
| / | |
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 (настроен след convert ((() или validate (())). |
getPdfFormat() → PdfFormat | Връща формата PDF на този документ след конвертиране. |
close() | Затваря документа и освобождава основните ресурси. |