Documentos de informação
Resumo geral
Document é uma classe em Aspose.PDF FOSS para Java. Herdeiros de: Closeable.
A classe central para o trabalho com documentos PDF (ISO 32000-1:2008).
Esta classe fornece 96 métodos para trabalhar com objetos Document em programas Java. Os métodos disponíveis incluem: Document, allocateObjectNumber, close, convert, convertToPdfA2B, decrypt, encrypt, exportAnnotationsToXfdf, flatten, getActions, getBackground, getCatalog, e 59 métodos adicionais. Todos os membros públicos são acessíveis a qualquer aplicação Java após instalar o pacote Aspose.PDF FOSS para Java. Propriedades: actions, background, catalog, centerWindow, collection, displayDocTitle, e mais 32 .
Propriedades
| Nome: | Tipo de veículo: | Acessos | Descrição: |
|---|---|---|---|
background | Color | Leia. | Retorna a cor de fundo do documento definida através da opção “Fonte” |
| {@link #setBackground(Color)}, ou { @code null} para nenhum. | |||
pages | PageCollection | Leia. | - Leva as páginas. |
info | DocumentInfo | Leia. | Retorna o dicionário de informações do documento (ISO 32000-1:2008, §14.3.3). |
orCreateInfo | DocumentInfo | Leia. | Alias deprimido para {@link #getInfo()}. |
metadata | XmpMetadata | Leia. | Retorna os metadados XMP deste documento. |
version | String | Leia. | Retorna a sequência de versão PDF (por exemplo:. |
catalog | PdfDictionary | Leia. | Retorna o dicionário de catálogo raiz. |
actions | DocumentActions | Leia. | Retorna os gatilhos de ação ao nível do documento (ISO 32000-1:2008, §12.6.4.1): |
| {@code /OpenAction} mais as entradas { @code &AA} (will-close, will/did-save, | |||
| (ou seja, será/fez-impressão). | |||
trailer | PdfDictionary | Leia. | Retorna o dicionário do trailer. |
parser | PDFParser | Leia. | Retorna o parser PDF subjacente (para uso interno por componentes do motor). |
outlines | OutlineCollection | Leia. | Retorna a coleção de contornos (marcas) do documento. |
form | Form | Leia. | Devolve a forma interativa (AcroForm) deste documento. |
embeddedFiles | EmbeddedFileCollection | Leia. | Retorna a coleção de arquivos incorporados (anexos). |
collection | Collection | Leia. | Retorna o portfólio do documento {@link Collection}, instanciando um |
| Vazio na primeira entrada. | |||
fontUtilities | FontUtilities | Leia. | Retorna os utilitários de fonte para este documento. |
embedStandardFonts | boolean | Leia. | Devolve se as fontes PDF padrão 14 devem ser incorporadas ao salvar. |
layers | java.util.List<Layer> | Leia. | Devolve a lista de grupos (camadas) de conteúdo opcionais. |
viewerPreferences | ViewerPreferences | Leia. | Retorna as preferências do espectador. |
hideToolbar | boolean | Leia. | Esconda as preferências da barra de ferramentas. |
hideMenubar | boolean | Leia. | Esconde preferências da barra de menus. |
hideWindowUI | boolean | Leia. | Esconda preferências de interface da janela. |
fitWindow | boolean | Leia. | Ajuste a preferência da janela. |
centerWindow | boolean | Leia. | Preferência de janela central. |
displayDocTitle | boolean | Leia. | Exibe a preferência de título do documento. |
pageLayout | String | Leia. | Designação da página (SinglePage, OneColumn e TwoColumnLeft). |
pageMode | PageMode | Leia. | - Está no modo página. |
pageInfo | PageInfo | Leia. | Salva o documento num ficheiro. |
linearized | boolean | Leia. | Devolve se o documento atual é linearizado para visualização rápida na web. |
sourcePath | String | Leia. | Retorna o caminho do arquivo a partir do qual este documento foi carregado, ou {@code null} para novos documentos. |
| ou documentos carregados a partir de fluxos. | |||
fileName | String | Leia. | Retorna o nome do ficheiro (caminho) a partir do qual foi aberto este documento. |
namedDestinations | NamedDestinations | Leia. | Retorna a coleção de destinos nomeados do documento. |
pageLabels | PageLabels | Leia. | Retorna os rótulos da página, ou {@code null} se o { @ code /PageLabels} não estiver presente. |
taggedContent | TaggedContent | Leia. | Retorna o conteúdo marcado do documento, fornecendo acesso à árvore de estrutura lógica. |
logicalStructure | StructTreeRoot | Leia. | Retorna a árvore de estrutura lógica para leitura. |
encrypted | boolean | Leia. | Retorna verdadeiro se o documento estiver criptografado. |
javaScript | JavaScriptCollection | Leia. | Retorna a coleção JavaScript da árvore de nomes do documento. |
pdfaCompliant | boolean | Leia. | Devolve true se este documento for compatível com PDF/A (definido após convert ((() ou validate (())). |
pdfFormat | PdfFormat | Leia. | Retorna o formato PDF deste documento após a conversão. |
Métodos de avaliação
| Assinatura | Descrição: |
|---|---|
Document(filePath: String) | Abre um documento PDF a partir de uma rota para o ficheiro. |
Document(filePath: String, password: String) | Abre um documento PDF a partir de uma rota para o ficheiro com uma senha. |
Document(filePath: String, password: String, customHandler: ICustomSecurityHandler) | Abre um documento PDF a partir de uma rota para o arquivo usando um manipulador de segurança personalizado. |
Document(stream: InputStream) | Abre um documento PDF a partir de uma entrada. |
Document(stream: InputStream, password: String) | Abre um documento PDF a partir de uma entrada com senha. |
Document(stream: InputStream, password: String, customHandler: ICustomSecurityHandler) | Abre um documento PDF a partir de uma entrada usando um manipulador de segurança personalizado. |
Document() | Cria um novo documento PDF vazio. |
Document(filePath: String, options: HtmlLoadOptions) | Cria um documento PDF a partir de um ficheiro HTML. |
Document(stream: InputStream, options: HtmlLoadOptions) | Cria um documento PDF a partir de uma entrada HTML. |
getBackground() → Color | Retorna a cor de fundo do documento definida através da opção “Fonte” |
| {@link #setBackground(Color)}, ou { @code null} para nenhum. | |
setBackground(color: Color) | Aplica uma cor de fundo sólida a cada página do documento |
| (via {@link Page#setBackground(Color)}). | |
getPages() → PageCollection | Retorna as páginas. |
getInfo() → DocumentInfo | Retorna o dicionário de informações do documento (ISO 32000-1:2008, §14.3.3). |
getOrCreateInfo() → DocumentInfo | Alias deprimido para {@link #getInfo()}. |
getMetadata() → XmpMetadata | Retorna os metadados XMP deste documento. |
setXmpMetadata(stream: InputStream) | Defina os metadados XMP de bytes XML brutos lidos a partir de um fluxo. |
getXmpMetadata(stream: OutputStream) | Escreve os bytes XML dos metadados XMP para o fluxo de saída dado. |
getVersion() → String | Retorna a sequência de versão PDF (por exemplo:. |
getCatalog() → PdfDictionary | Retorna o dicionário de catálogo raiz. |
getActions() → DocumentActions | Retorna os gatilhos de ação ao nível do documento (ISO 32000-1:2008, §12.6.4.1): |
| {@code /OpenAction} mais as entradas { @code &AA} (will-close, will/did-save, | |
| (ou seja, será/fez-impressão). | |
getTrailer() → PdfDictionary | Retorna o dicionário do trailer. |
getParser() → PDFParser | Retorna o parser PDF subjacente (para uso interno por componentes do motor). |
getOutlines() → OutlineCollection | Retorna a coleção de contornos (marcas) do documento. |
getForm() → Form | Devolve a forma interativa (AcroForm) deste documento. |
getEmbeddedFiles() → EmbeddedFileCollection | Retorna a coleção de arquivos incorporados (anexos). |
getCollection() → Collection | Retorna o portfólio do documento {@link Collection}, instanciando um |
| Vazio na primeira entrada. | |
setCollection(value: Collection) | Substitui (ou remove, quando {@code value == null}) o documento |
| Portfólio. | |
getFontUtilities() → FontUtilities | Retorna os utilitários de fonte para este documento. |
isEmbedStandardFonts() → boolean | Devolve se as fontes PDF padrão 14 devem ser incorporadas ao salvar. |
setEmbedStandardFonts(embed: boolean) | Indica se as fontes PDF padrão 14 devem ser incorporadas ao salvar. |
getLayers() → java.util.List<Layer> | Devolve a lista de grupos (camadas) de conteúdo opcionais. |
getViewerPreferences() → ViewerPreferences | Retorna as preferências do espectador. |
getHideToolbar() → boolean | Esconda as preferências da barra de ferramentas. |
setHideToolbar(v: boolean) | Configura preferência de barra de ferramentas. |
getHideMenubar() → boolean | Esconde preferências da barra de menus. |
setHideMenubar(v: boolean) | Configura preferência de barra de menu. |
getHideWindowUI() → boolean | Esconda preferências de interface da janela. |
setHideWindowUI(v: boolean) | Configura preferência de interface da janela. |
getFitWindow() → boolean | Ajuste a preferência da janela. |
setFitWindow(v: boolean) | Configuração de preferências da janela. |
getCenterWindow() → boolean | Preferência de janela central. |
setCenterWindow(v: boolean) | Defina preferência de janela central. |
getDisplayDocTitle() → boolean | Exibe a preferência de título do documento. |
setDisplayDocTitle(v: boolean) | Indica preferência de título do documento. |
getPageLayout() → String | Designação da página (SinglePage, OneColumn e TwoColumnLeft). |
setPageLayout(layout: String) | Configuração da página. |
getPageMode() → PageMode | Retorna o modo de página. |
setPageMode(mode: PageMode) | Configura o modo de página. |
getPageInfo() → PageInfo | Salva o documento num ficheiro. |
processParagraphs() | Processar parágrafos para todas as páginas (passagem de layout). |
save(filePath: String) | @param filePath o caminho do arquivo de saída |
| @ throws IOException se a escrita falhar | |
| @ throws IllegalArgumentException se o filePath for nulo | |
| / | |
save() | Salva o documento de volta para a sua rota do destino associado. |
save(outputStream: OutputStream) | Salva o documento para um fluxo de saída. |
hasIncrementalUpdate() → boolean | Devolve se o documento actual contém atualizações incrementais. |
optimize() | Solicita uma reescrita completa na próxima salva em vez de um apêndice incremental. |
requestFullRewrite() | Solicita que a próxima operação de salva execute uma reescrita completa mesmo se: |
| A economia incremental seria, de outro modo, possível. | |
isLinearized() → boolean | Devolve se o documento atual é linearizado para visualização rápida na web. |
optimizeResources() | Remove recursos não utilizados no nível da página antes do próximo salvar. |
optimizeResources(options: org.aspose.pdf.optimization.OptimizationOptions) | Optimiza o documento de acordo com as opções fornecidas antes da próxima fase. |
| Salva-me. | |
save(filePath: String, format: SaveFormat) | Salva o documento no formato especificado. |
save(filePath: String, options: PdfSaveOptions) | Salva o documento com as opções de salva PDF especificadas. |
save(filePath: String, options: HtmlSaveOptions) | Salva o documento como HTML com as opções especificadas. |
getSourcePath() → String | Retorna o caminho do arquivo a partir do qual este documento foi carregado, ou {@code null} para novos documentos. |
| ou documentos carregados a partir de fluxos. | |
getFileName() → String | Retorna o nome do ficheiro (caminho) a partir do qual foi aberto este documento. |
setFileName(fileName: String) | Indica o nome do ficheiro associado a este documento. |
exportAnnotationsToXfdf(filePath: String) | Exporta todas as anotações deste documento para um arquivo XFDF. |
exportAnnotationsToXfdf(stream: OutputStream) | Exporta todas as anotações deste documento para um fluxo de saída XFDF. |
importAnnotationsFromXfdf(filePath: String) | Importa anotações de um arquivo XFDF para este documento. |
importAnnotationsFromXfdf(stream: InputStream) | Importa anotações de um fluxo de entrada XFDF para este documento. |
flatten() | Alarga todo o documento: prepara todas as anotações e forma aparências de campo |
| em fluxos de conteúdo da página, depois remove anotações e campos de formulário. | |
flatten(settings: Form.FlattenSettings) | Aplanar o documento usando as configurações de aplanamento do formulário especificadas. |
getNamedDestinations() → NamedDestinations | Retorna a coleção de destinos nomeados do documento. |
getPageLabels() → PageLabels | Retorna os rótulos da página, ou {@code null} se o { @ code /PageLabels} não estiver presente. |
getTaggedContent() → TaggedContent | Retorna o conteúdo marcado do documento, fornecendo acesso à árvore de estrutura lógica. |
getLogicalStructure() → StructTreeRoot | Retorna a árvore de estrutura lógica para leitura. |
allocateObjectNumber() → int | Alocar um novo número de objeto para um objecto indirecto. |
registerImportedObject(body: PdfBase) → PdfObjectReference | Regista um objeto importado de outro documento sob uma nova atribuição. |
| - A chave. | |
isEncrypted() → boolean | Retorna verdadeiro se o documento estiver criptografado. |
encrypt(userPassword: String, ownerPassword: String, permissions: int, cryptoAlgorithm: CryptoAlgorithm) | Criptografa o documento com as senhas do utilizador e do proprietário utilizando o algoritmo especificado. |
encrypt(userPassword: String, ownerPassword: String, privilege: org.aspose.pdf.facades.DocumentPrivilege, customHandler: ICustomSecurityHandler) | Criptografa o documento com um manipulador de segurança personalizado. |
encrypt(userPassword: String, ownerPassword: String, privilege: org.aspose.pdf.facades.DocumentPrivilege, cryptoAlgorithm: CryptoAlgorithm, usePdf20: boolean) | Criptografa o documento com senhas de usuário e proprietário usando o algoritmo especificado |
| e um conjunto de privilégios. | |
decrypt() | Descifra o documento, removendo a encriptação. |
getJavaScript() → JavaScriptCollection | Retorna a coleção JavaScript da árvore de nomes do documento. |
validate(outputLogPath: String, format: PdfFormat) → boolean | Valida o documento em relação ao perfil de formato PDF especificado. |
validate(logStream: OutputStream, format: PdfFormat) → boolean | Valida o documento em relação ao perfil de formato PDF especificado. |
validate(options: PdfFormatConversionOptions) → boolean | Valida o documento usando um objeto de opção PDF/A. |
convert(outputLogPath: String, format: PdfFormat, action: ConvertErrorAction) → boolean | Converte o documento para o formato PDF especificado. |
convert(logStream: OutputStream, format: PdfFormat, action: ConvertErrorAction) → boolean | Converte o documento para o formato PDF especificado. |
convert(logStream: OutputStream, format: PdfFormat, action: ConvertErrorAction, transparencyAction: ConvertTransparencyAction) → boolean | Conversões com manipulação de transparência explícita. |
convert(options: PdfFormatConversionOptions) → boolean | Conversões utilizando opções de conversão detalhadas. |
convertToPdfA2B(outputLogPath: String) → boolean | Converte este PDF para o formato PDF/A-2B. |
convertToPdfA2B(logStream: OutputStream) → boolean | Converte este PDF para o formato PDF/A-2B. |
repair() | Tentativas de reparação de problemas estruturais menores antes da salva, validação ou eliminação do produto. |
| fluxos de trabalho de conversão. | |
isPdfaCompliant() → boolean | Devolve true se este documento for compatível com PDF/A (definido após convert ((() ou validate (())). |
getPdfFormat() → PdfFormat | Retorna o formato PDF deste documento após a conversão. |
close() | Fecha o documento e libera os recursos subjacentes. |