Adicionar cabeçalho e rodapé em PDF usando Java REST API

Um cabeçalho é um texto que é colocado na área de margem no topo de uma página, enquanto um rodapé é colocado na parte inferior, ou pé, de uma página. Normalmente, essas áreas são usadas para inserir informações do documento, como o nome do documento, o título do capítulo, números de página, data de criação, etc. Essas informações são repetidas em cada página e, portanto, permitem que o leitor navegue facilmente pelo documento.

Além disso, esteja ciente de que os cabeçalhos e rodapés são úteis para fornecer informações rápidas sobre seu documento em um formato previsível e também ajudam a definir diferentes partes de um documento. Neste artigo, aprenderemos sobre como adicionar texto e imagens às áreas de cabeçalho e rodapé de arquivos PDF usando Aspose.PDF Cloud SDK para Java.

Adicionar texto ao cabeçalho usando cURL
Adicionar cabeçalho de texto em PDF usando Java
Imagem no cabeçalho PDF usando o cURL
Adicionar imagem no cabeçalho usando Java

Adicionar texto ao cabeçalho usando cURL

Os comandos cURL são uma maneira interessante de acessar APIs RESTFul por meio do terminal de linha de comando. Como o Aspose.PDF Cloud SDK é desenvolvido de acordo com os princípios REST, ele pode ser acessado facilmente por meio do prompt de comando. No entanto, observe que, para garantir a privacidade do usuário e a integridade dos dados, todas as nossas APIs são acessíveis apenas a pessoas autorizadas. Portanto, você precisa primeiro visitar o painel Aspose.Cloud e, se tiver uma conta GitHub ou Google, basta se inscrever. Caso contrário, clique no botão Criar uma nova conta e forneça as informações necessárias. Agora, faça login no painel usando credenciais e expanda a seção Aplicativos no painel e role para baixo em direção à seção Credenciais do cliente para ver os detalhes do ID do cliente e do segredo do cliente.

O comando a seguir mostra como criar um token de acesso JWT que será usado para adicionar texto na área Cabeçalho do documento PDF.

curl -v "https://api.aspose.cloud/connect/token" \
-X POST \
-d "grant_type=client_credentials&client_id=c235e685-1aab-4cda-a95b-54afd63eb87f&client_secret=b8da4ee37494f2ef8da3c727f3a0acb9" \
-H "Content-Type: application/x-www-form-urlencoded" \
-H "Accept: application/json"

Use o seguinte comando cURL para adicionar texto na seção de cabeçalho do documento PDF.

curl -X POST "https://api.aspose.cloud/v3.0/pdf/PdfWithAnnotations.pdf/header/text?startPageNumber=2&endPageNumber=2" \
-H  "accept: application/json" \
-H  "authorization: Bearer <JWT Token>" \
-H  "Content-Type: application/json" \
-d "{  \"Background\": true,  \"HorizontalAlignment\": \"CENTER\",  \"Opacity\": 0.8,  \"Rotate\": \"None\",  \"RotateAngle\": 0,  \"XIndent\": 0,  \"YIndent\": 0,  \"Zoom\": 1,  \"TextAlignment\": \"CENTER\",  \"Value\": \"Aspose.PDF Cloud SDK for Java via cURL\",  \"TextState\": {    \"FontSize\": 16,    \"Font\": \"Arial\",    \"ForegroundColor\": {      \"A\": 0,      \"R\": 0xDA,      \"G\": 0xA5,      \"B\": 0x20    },    \"BackgroundColor\": {      \"A\": 0,      \"R\": 0xFA,      \"G\": 0xEB,      \"B\": 0xD7    },  },  \"LeftMargin\": 1,  \"TopMargin\": 20,  \"RightMargin\": 200}"

Os arquivos de amostra usados neste exemplo podem ser baixados de:

Adicionar cabeçalho de texto em PDF usando Java

Para usar o SDK, você precisa primeiro instalá-lo do Maven ou do GitHub. Abaixo estão os detalhes sobre como baixar e usar o Aspose.Pdf.jar no projeto de construção do Maven.

Adicione as seguintes dependências no seu arquivo pom.xml.

<repositories>
 <repository>
        <id>aspose-cloud</id>
        <name>artifact.aspose-cloud-releases</name>
        <url>https://artifact.aspose.cloud/repo</url>
    </repository>   
</repositories>
<dependencies>
 <dependency>
        <groupId>com.aspose</groupId>
        <artifactId>aspose-pdf-cloud</artifactId>
        <version>21.1.0</version>
        <scope>compile</scope>
    </dependency>
 </dependencies>

Abaixo estão as etapas sobre como cumprir esse requisito.

Primeiro, crie uma instância de PdfApi enquanto fornece detalhes de ClientSecret e ClientId
Em segundo lugar, crie um objeto Color para definir os detalhes de cor do primeiro e segundo plano.
Em segundo lugar, crie um objeto da classe TextState.
Use o método fontSize(..) para definir detalhes do tamanho da fonte. O método font(..) para definir a face da fonte. O método foregroundColor(…) define detalhes do primeiro plano do texto, e o método backgroundColor(…) para definir informações de segundo plano.
Agora crie o objeto TextHeader e defina os detalhes da margem.
Use métodos value(..) para especificar o conteúdo do objeto Cabeçalho de Texto.
Agora chame o método textState(…) e passe a instância TextState criada acima como argumento.
Para exibir o cabeçalho atrás do conteúdo da página, passe o valor true como um argumento para o método background(…) da classe TextHeader.
Agora, para renderizar a imagem no lado esquerdo, passe o valor HorizontalAlignment.CENTER para o método horizontalAlignment(…).
O método opacity(…) indica a opacidade do carimbo. O valor padrão é 1.0.
Depois de definir o valor do zoom, crie o objeto AsposeResponse.
Por fim, chame o método PdfApi .postDocumentTextHeader(…) e passe o nome do arquivo PDF de origem, o objeto TextHeader, as páginas inicial e final (onde o carimbo precisa ser adicionado) como argumentos.

// Obtenha ClientID e ClientSecret de https://dashboard.aspose.cloud/
String clientId = "29ac1517-753f-4303-b755-7185e35cf939";
String clientSecret = "c537caf71eafc8a75a5ee7813b703276";
				
// instância createPdfApi
PdfApi pdfApi = new PdfApi(clientSecret,clientId);
				
// documento PDF de entrada
String sourcePDF = "PdfWithAnnotations.pdf";

// página inicial do PDF para colocar a imagem do cabeçalho
int startPage = 2;

// página final do PDF para colocar a imagem do cabeçalho
int endPage = 3;
		        
// especifique a cor do primeiro plano como SlateBlue no código Hex
Color foregroundColor = new Color();
foregroundColor.setA(0x00);
foregroundColor.setR(0x6A);
foregroundColor.setG(0x5A);
foregroundColor.setB(0xCD);

// especifique a cor de fundo como AntiqueWhite no código Hex
Color backgroundColor = new Color();
backgroundColor.setA(0x00);
backgroundColor.setR(0xFA);
backgroundColor.setG(0xEB);
backgroundColor.setB(0xD7);

// Crie um objeto TextState para definir o tamanho da fonte, a face e os detalhes da cor
TextState textState = new TextState()
  .fontSize(16.)
  .foregroundColor(foregroundColor)
  .backgroundColor(backgroundColor)
  .font("Arial");
		        
// crie uma instância do objeto TextHeader
TextHeader headerObject = new TextHeader()    
  .leftMargin(1.)
  .rightMargin(200.)
  .topMargin(10.)
	
  // o conteúdo do cabeçalho de texto a ser renderizado
  .value("Aspose.PDF Cloud SDK For Java")
	
  // definir alinhamento como central
  .textAlignment(com.aspose.asposecloudpdf.model.HorizontalAlignment.CENTER)
  .textState(textState);
	
  // definir texto do cabeçalho atrás do conteúdo da página
  headerObject.background(true)
	
  // definir alinhamento do cabeçalho de texto como centralizado
  .horizontalAlignment(com.aspose.asposecloudpdf.model.HorizontalAlignment.CENTER)
	
  // defina a opacidade do cabeçalho de texto como 0,8
  .opacity(0.8)
  .rotate(com.aspose.asposecloudpdf.model.Rotation.NONE)
  .rotateAngle(0.)
  .xindent(2.0)
  .yindent(5.0)
  .zoom(1.0);

// chamar método API para adicionar cabeçalho de texto ao PDF
AsposeResponse response = pdfApi.postDocumentTextHeader(sourcePDF, headerObject,startPage, endPage, null, null);
assertEquals(200, (int)response.getCode());

Cabeçalho de texto adicionado em Java — Imagem 2:- Visualização do Cabeçalho de Texto adicionado com Java.

Para adicionar texto na área de rodapé, crie uma instância da classe TextFooter e chame o método postDocumentTextFooter(…) da classe PdfApi. As etapas e detalhes restantes permanecerão os mesmos mencionados acima para adicionar o Cabeçalho de Texto.

Imagem no cabeçalho PDF usando o cURL

Podemos adicionar facilmente arquivos de imagem usando a API PostDocumentImageHeader na seção de cabeçalho do arquivo PDF usando o comando cURL. Ao adicionar um carimbo de imagem, temos a opção de especificar HorizontalAlignment, Opacity, RotateAngle, fator de zoom da imagem, Width, Height, LeftMargin, TopMargin, RightMargin, etc.

O parâmetro name define o documento PDF de entrada/origem, imageHeader especifica o arquivo de imagem a ser carimbado, a propriedade startPageNumber define a página inicial e endPageNumber a página final do documento PDF para conter carimbos de imagem. No comando cURL a seguir, a propriedade Background é definida como false para que a imagem fique visível. O HorizontalAlignment é especificado como Left, o valor Opacity é definido como 0.8, o fator Zoom é definido como 1, a Width é definida como 250, Height é definida como 80 pontos e RightMargin é especificado como 500 pontos.

curl -X POST "https://api.aspose.cloud/v3.0/pdf/PdfWithAnnotations.pdf/header/image?startPageNumber=2&endPageNumber=2" \
-H  "accept: application/json" \
-H  "authorization: Bearer <JWT Token>"  \
-H  "Content-Type: application/json" \
-d "{"Background":false,"HorizontalAlignment":'Left',"Opacity": .8,"Rotate":'None',"RotateAngle": 0,"XIndent": 2,"YIndent": 5,"Zoom": 1,"FileName": 'asposetoolsnew.png',"Width": 250,"Height": 80,"LeftMargin": 1,"TopMargin": 10,"RightMargin": 500}"

Carimbo de imagem no cabeçalho — Imagem 3:- Carimbo de imagem na seção Cabeçalho do PDF.

Os arquivos de amostra usados no exemplo acima podem ser baixados do seguinte link:

Adicionar imagem no cabeçalho usando Java

Aspose.PDF Cloud SDK para Java fornece um recurso notável para adicionar um cabeçalho de imagem em um arquivo PDF com menos linhas de código.

Abaixo estão as etapas sobre como adicionar cabeçalho de imagem em um documento PDF

Crie um objeto de PdfApi fornecendo detalhes de ClientSecret e ClientId.
Em segundo lugar, crie um objeto da classe ImageHeader.
Use os métodos width(..) e height(…) da classe ImageHeader para definir detalhes de largura e altura da imagem.
Agora use o método fileName(…) para definir os detalhes do caminho para a imagem do cabeçalho.
Para exibir a imagem por trás do conteúdo da página, passe o argumento false para o método background(…).
Agora, para renderizar a imagem no lado esquerdo, passe o valor HorizontalAlignment.LEFT para o método horizontalAlignment(…).
O método opacity(…) indica a opacidade do carimbo. O valor padrão é 1.0.
Depois de definir o valor do zoom, crie o objeto AsposeResponse.
Por fim, chame o método PdfApi.postDocumentImageHeader(…) enquanto passa o nome do arquivo PDF de origem, o objeto ImageHeader, as páginas inicial e final (onde o carimbo precisa ser adicionado) como argumentos para este método.

// Obtenha ClientID e ClientSecret de https://dashboard.aspose.cloud/
String clientId = "29ac1517-753f-4303-b755-7185e35cf939";
String clientSecret = "c537caf71eafc8a75a5ee7813b703276";
				
// instância createPdfApi
PdfApi pdfApi = new PdfApi(clientSecret,clientId);
				
// documento PDF de entrada
String sourcePDF = "PdfWithAnnotations.pdf";

// página inicial do PDF para colocar a imagem do cabeçalho
int startPage = 2;

// página final do PDF para colocar a imagem do cabeçalho
int endPage = 3;
		        
// crie uma instância do objeto ImageHeader
ImageHeader headerObject = new ImageHeader()
	.width(250.0)
	.height(80.0)
	.leftMargin(1.)
	.rightMargin(500.)
	.topMargin(10.)
	.fileName("asposetoolsnew.png");
	
	// trazer a imagem do cabeçalho para o primeiro plano/visível
	headerObject.background(false)
	
	// definir alinhamento do cabeçalho da imagem como Esquerda
	.horizontalAlignment(com.aspose.asposecloudpdf.model.HorizontalAlignment.LEFT)
	.opacity(0.8)
	.rotate(com.aspose.asposecloudpdf.model.Rotation.NONE)
	.rotateAngle(0.)
	.xindent(2.0)
	.yindent(5.0)
	.zoom(1.0);

// chamar método API para adicionar imagem de cabeçalho em PDF
AsposeResponse response = pdfApi.postDocumentImageHeader(sourcePDF, headerObject,startPage, endPage, null, null);

Para adicionar uma imagem na área do rodapé, crie um objeto da classe ImageFooter e chame o método postDocumentImageFooter(…) da classe pdfApi. O restante das etapas permanecerá o mesmo que explicado acima para a seção Imagem no Cabeçalho acima.

Conclusão

Neste artigo, discutimos as etapas sobre como acessar o Aspose.PDF Cloud por meio de comandos cURL para adicionar texto e imagens em áreas de cabeçalho/rodapé de documentos PDF. Também exploramos as etapas para instalar o Aspose.PDF Cloud SDK para Java e usá-lo na linguagem Java para adicionar texto e imagem na seção de cabeçalho ou rodapé do arquivo PDF. Para obter mais detalhes sobre outros recursos interessantes da API, explore a documentação do produto.

Todos os nossos SDKs em nuvem são OpenSource, portanto, um código-fonte completo pode ser baixado do GitHub.

Adicionar texto ao cabeçalho usando cURL#

Adicionar cabeçalho de texto em PDF usando Java#

Imagem no cabeçalho PDF usando o cURL#

Adicionar imagem no cabeçalho usando Java#

Conclusão#

Adicionar texto ao cabeçalho usando cURL

Adicionar cabeçalho de texto em PDF usando Java

Imagem no cabeçalho PDF usando o cURL

Adicionar imagem no cabeçalho usando Java

Conclusão