Добавить верхний и нижний колонтитулы в PDF с помощью Java REST API

Верхний колонтитул — это текст, который размещается в области полей в верхней части страницы, а нижний колонтитул размещается в нижней части или подножии страницы. Обычно эти области используются для вставки информации о документе, такой как название документа, заголовок главы, номера страниц, дата создания и т. д. Эта информация повторяется на каждой странице и, таким образом, позволяет читателю легко ориентироваться в документе.

Кроме того, имейте в виду, что заголовки и нижние колонтитулы полезны для предоставления быстрой информации о вашем документе в предсказуемом формате, а также помогают в оформлении различных частей документа. В этой статье мы узнаем о добавлении текста и изображений в области заголовков и нижних колонтитулов файлов PDF с помощью Aspose.PDF Cloud SDK for Java.

Добавить текст в заголовок с помощью cURL
Добавление текстового заголовка в PDF с помощью Java
Изображение в заголовке PDF с использованием cURL
Добавить изображение в заголовок с помощью Java

Добавить текст в заголовок с помощью cURL

Команды cURL — это захватывающий способ доступа к API RESTFul через терминал командной строки. Поскольку Aspose.PDF Cloud SDK разработан в соответствии с принципами REST, к нему можно легко получить доступ через командную строку. Однако обратите внимание, что для обеспечения конфиденциальности пользователей и целостности данных все наши API доступны только авторизованным лицам. Поэтому вам сначала необходимо посетить панель управления Aspose.Cloud и, если у вас есть учетная запись GitHub или Google, просто зарегистрироваться. В противном случае нажмите кнопку Создать новую учетную запись и укажите необходимую информацию. Теперь войдите в панель управления, используя учетные данные, разверните раздел «Приложения» на панели управления и прокрутите вниз до раздела «Учетные данные клиента», чтобы увидеть сведения об идентификаторе клиента и секретном ключе клиента.

Следующая команда показывает, как создать токен доступа JWT, который будет использоваться для добавления текста в область заголовка документа 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"

Используйте следующую команду cURL для добавления текста в раздел заголовка 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}"

Текстовый заголовок в PDF — Изображение 1: Текстовый заголовок добавлен с помощью команды cURL.

Образцы файлов, использованные в этом примере, можно загрузить по адресу:

Добавление текстового заголовка в PDF с помощью Java

Чтобы использовать SDK, вам необходимо сначала установить его либо из Maven, либо из GitHub. Ниже приведены сведения о том, как загрузить и использовать Aspose.Pdf.jar в проекте сборки Maven.

Добавьте следующие зависимости в файл 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>

Ниже приведены шаги по выполнению этого требования.

Прежде всего, создайте экземпляр PdfApi, указав данные ClientSecret и ClientId.
Во-вторых, создайте объект Color для определения деталей цвета переднего и заднего плана.
Во-вторых, создайте объект класса TextState.
Используйте метод fontSize(..) для установки деталей размера шрифта. Метод font(..) для определения гарнитуры шрифта. Метод foregroundColor(…) определяет детали переднего плана текста, а метод backgroundColor(…) — информацию о фоне.
Теперь создайте объект TextHeader и определите параметры полей.
Используйте методы value(..) для указания содержимого объекта Text Header.
Теперь вызовите метод textState(…) и передайте созданный выше экземпляр TextState в качестве аргумента.
Чтобы отобразить заголовок позади содержимого страницы, передайте истинное значение в качестве аргумента методу background(…) класса TextHeader.
Теперь, чтобы отобразить изображение с левой стороны, передайте значение HorizontalAlignment.CENTER методу HorizontalAlignment(…).
Метод opacity(…) указывает непрозрачность штампа. Значение по умолчанию — 1,0.
После того, как мы установили значение масштабирования, создаем объект AsposeResponse.
Наконец, вызовите метод PdfApi .postDocumentTextHeader(…) и передайте в качестве аргументов имя исходного PDF-файла, объект TextHeader, начальную и конечную страницы (где необходимо добавить штамп).

// Получите ClientID и ClientSecret с https://dashboard.aspose.cloud/
String clientId = "29ac1517-753f-4303-b755-7185e35cf939";
String clientSecret = "c537caf71eafc8a75a5ee7813b703276";
				
// экземпляр createPdfApi
PdfApi pdfApi = new PdfApi(clientSecret,clientId);
				
// входной PDF-документ
String sourcePDF = "PdfWithAnnotations.pdf";

// начальная страница PDF для размещения изображения заголовка
int startPage = 2;

// Конечная страница PDF-файла для размещения изображения заголовка
int endPage = 3;
		        
// указать цвет переднего плана как SlateBlue в шестнадцатеричном коде
Color foregroundColor = new Color();
foregroundColor.setA(0x00);
foregroundColor.setR(0x6A);
foregroundColor.setG(0x5A);
foregroundColor.setB(0xCD);

// укажите цвет фона как AntiqueWhite в шестнадцатеричном коде
Color backgroundColor = new Color();
backgroundColor.setA(0x00);
backgroundColor.setR(0xFA);
backgroundColor.setG(0xEB);
backgroundColor.setB(0xD7);

// Создайте объект TextState для определения размера шрифта, начертания и цвета.
TextState textState = new TextState()
  .fontSize(16.)
  .foregroundColor(foregroundColor)
  .backgroundColor(backgroundColor)
  .font("Arial");
		        
// создать экземпляр объекта TextHeader
TextHeader headerObject = new TextHeader()    
  .leftMargin(1.)
  .rightMargin(200.)
  .topMargin(10.)
	
  // содержимое текстового заголовка, которое будет отображаться
  .value("Aspose.PDF Cloud SDK For Java")
	
  // установить выравнивание по центру
  .textAlignment(com.aspose.asposecloudpdf.model.HorizontalAlignment.CENTER)
  .textState(textState);
	
  // установить текст заголовка позади содержимого страницы
  headerObject.background(true)
	
  // установить выравнивание заголовка текста по центру
  .horizontalAlignment(com.aspose.asposecloudpdf.model.HorizontalAlignment.CENTER)
	
  // установите непрозрачность текстового заголовка на 0,8
  .opacity(0.8)
  .rotate(com.aspose.asposecloudpdf.model.Rotation.NONE)
  .rotateAngle(0.)
  .xindent(2.0)
  .yindent(5.0)
  .zoom(1.0);

// вызовите метод API для добавления текстового заголовка в PDF
AsposeResponse response = pdfApi.postDocumentTextHeader(sourcePDF, headerObject,startPage, endPage, null, null);
assertEquals(200, (int)response.getCode());

Текстовый заголовок добавлен в Java — Изображение 2: Предварительный просмотр текстового заголовка, добавленного с помощью Java.

Чтобы добавить текст в область нижнего колонтитула, создайте экземпляр класса TextFooter и вызовите метод postDocumentTextFooter(…) класса PdfApi. Остальные шаги и детали останутся такими же, как указано выше для добавления текстового заголовка.

Изображение в заголовке PDF с использованием cURL

Мы можем легко добавлять файлы изображений с помощью API PostDocumentImageHeader в заголовочном разделе файла PDF с помощью команды cURL. При добавлении штампа изображения мы получаем возможность указать HorizontalAlignment, Opacity, RotateAngle, Zoom factor изображения, Width, Height, LeftMargin, TopMargin, RightMargin и т. д.

Параметр name определяет входной/исходный PDF-документ, imageHeader указывает файл изображения, на который нужно нанести штамп, свойство startPageNumber определяет начальную страницу, а endPageNumber — конечную страницу PDF-документа, на которой будут размещены штампы изображений. В следующей команде cURL свойство Background установлено как false, чтобы изображение было видно. HorizontalAlignment указано как Left, значение Opacity определено как 0.8, коэффициент Zoom установлен как 1, Width определен как 250, Height определен как 80 точек, а RightMargin определен как 500 точек.

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}"

Изображение штампа в заголовке — Изображение 3:- Штамп изображения в разделе «Заголовок» PDF-файла.

Образцы файлов, использованные в примере выше, можно загрузить по следующей ссылке:

Добавить изображение в заголовок с помощью Java

Aspose.PDF Cloud SDK для Java предоставляет замечательную функцию добавления заголовка изображения в файл PDF с меньшим количеством строк кода.

Ниже приведены шаги по добавлению заголовка изображения в документ PDF.

Создайте объект PdfApi, указав данные ClientSecret и ClientId.
Во-вторых, создайте объект класса ImageHeader.
Используйте методы width(..) и height(…) класса ImageHeader для установки ширины и высоты изображения.
Теперь используйте метод fileName(…), чтобы задать путь к изображению заголовка.
Чтобы отобразить изображение позади содержимого страницы, передайте методу background(…) аргумент false.
Теперь, чтобы отобразить изображение с левой стороны, передайте значение HorizontalAlignment.LEFT методу HorizontalAlignment(…).
Метод opacity(…) указывает непрозрачность штампа. Значение по умолчанию — 1,0.
После того, как мы установили значение масштабирования, создаем объект AsposeResponse.
Наконец, вызовите метод PdfApi.postDocumentImageHeader(…), передав в качестве аргументов этому методу имя исходного PDF-файла, объект ImageHeader, начальную и конечную страницы (где необходимо добавить штамп).

// Получите ClientID и ClientSecret с https://dashboard.aspose.cloud/
String clientId = "29ac1517-753f-4303-b755-7185e35cf939";
String clientSecret = "c537caf71eafc8a75a5ee7813b703276";
				
// экземпляр createPdfApi
PdfApi pdfApi = new PdfApi(clientSecret,clientId);
				
// входной PDF-документ
String sourcePDF = "PdfWithAnnotations.pdf";

// начальная страница PDF для размещения изображения заголовка
int startPage = 2;

// Конечная страница PDF-файла для размещения изображения заголовка
int endPage = 3;
		        
// создать экземпляр объекта ImageHeader
ImageHeader headerObject = new ImageHeader()
	.width(250.0)
	.height(80.0)
	.leftMargin(1.)
	.rightMargin(500.)
	.topMargin(10.)
	.fileName("asposetoolsnew.png");
	
	// вывести изображение заголовка на передний план/видимое
	headerObject.background(false)
	
	// установить выравнивание заголовка изображения по левому краю
	.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);

// вызовите метод API для добавления изображения заголовка в PDF
AsposeResponse response = pdfApi.postDocumentImageHeader(sourcePDF, headerObject,startPage, endPage, null, null);

Чтобы добавить изображение в область нижнего колонтитула, создайте объект класса ImageFooter и вызовите метод postDocumentImageFooter(…) класса pdfApi. Остальные шаги останутся такими же, как описано выше для раздела Изображение в заголовке.

Заключение

В этой статье мы обсудили шаги по доступу к Aspose.PDF Cloud через команды cURL для добавления текста и изображений в области верхнего/нижнего колонтитула PDF-документов. Мы также изучили шаги по установке Aspose.PDF Cloud SDK для Java и его использованию на языке Java для добавления текста и изображения в раздел верхнего или нижнего колонтитула PDF-файла. Для получения более подробной информации о других интересных функциях API, пожалуйста, изучите документацию по продукту.

Все наши облачные SDK имеют открытый исходный код, поэтому полный исходный код можно загрузить с GitHub.

Добавить текст в заголовок с помощью cURL#

Добавление текстового заголовка в PDF с помощью Java#

Изображение в заголовке PDF с использованием cURL#

Добавить изображение в заголовок с помощью Java#

Заключение#

Добавить текст в заголовок с помощью cURL

Добавление текстового заголовка в PDF с помощью Java

Изображение в заголовке PDF с использованием cURL

Добавить изображение в заголовок с помощью Java

Заключение