Package com.ironsoftware.ironpdf.internal.staticapi

Class BackgroundForeground_Api

java.lang.Object

com.ironsoftware.ironpdf.internal.staticapi.BackgroundForeground_Api

public final class BackgroundForeground_Api
extends Object

The type Background foreground api.

Constructor Summary

Constructors

Constructor	Description
BackgroundForeground_Api()

Method Summary

Modifier and Type	Method	Description
static void	addBackground(InternalPdfDocument baseDocument, InternalPdfDocument backgroundDocument)	Adds the background to specified pages of this PDF.
static void	addBackground(InternalPdfDocument baseDocument, InternalPdfDocument backgroundDocument, List<Integer> basePdfPageIndexes)	Adds the background to specified pages of this PDF.
static void	addBackground(InternalPdfDocument baseDocument, InternalPdfDocument backgroundDocument, List<Integer> basePdfPageIndexes, int backgroundPdfPageIndex)	Adds the background to specified pages of this PDF.
static void	addForeground(InternalPdfDocument baseDocument, InternalPdfDocument foregroundDocument)	Adds an overlay to a range or pages of this PDF.
static void	addForeground(InternalPdfDocument baseDocument, InternalPdfDocument foregroundDocument, List<Integer> basePdfPageIndexes)	Adds an overlay to a range or pages of this PDF.
static void	addForeground(InternalPdfDocument baseDocument, InternalPdfDocument foregroundDocument, List<Integer> basePdfPageIndexes, int foregroundPdfPageIndex)	Adds an overlay to a range or pages of this PDF.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BackgroundForeground_Api

public BackgroundForeground_Api()

Method Detail

addBackground

public static void addBackground(InternalPdfDocument baseDocument,
                                 InternalPdfDocument backgroundDocument,
                                 List<Integer> basePdfPageIndexes)

Adds the background to specified pages of this PDF. The background is copied from a page in another PDF document.

Parameters:

baseDocument - the base document

backgroundDocument - The background PDF path.

basePdfPageIndexes - A list of Indexes (zero-based page numbers) of pages in this PDF to which the background will be applied to.

addBackground

public static void addBackground(InternalPdfDocument baseDocument,
                                 InternalPdfDocument backgroundDocument,
                                 List<Integer> basePdfPageIndexes,
                                 int backgroundPdfPageIndex)

Adds the background to specified pages of this PDF. The background is copied from a page in another PDF document.

Parameters:

baseDocument - the base document

backgroundDocument - The background PDF path.

basePdfPageIndexes - A list of Indexes (zero-based page numbers) of pages in this PDF to which the background will be applied to.

backgroundPdfPageIndex - Index (zero-based page number) to copy from the BackgroundPdf.

addBackground

public static void addBackground(InternalPdfDocument baseDocument,
                                 InternalPdfDocument backgroundDocument)

Adds the background to specified pages of this PDF. The background is copied from a page in another PDF document.

Parameters:

baseDocument - the base document

backgroundDocument - The background PDF path.

addForeground

public static void addForeground(InternalPdfDocument baseDocument,
                                 InternalPdfDocument foregroundDocument,
                                 List<Integer> basePdfPageIndexes)

Adds an overlay to a range or pages of this PDF. The foreground overlay is copied from a page in another PDF document.

Parameters:

baseDocument - the base document

foregroundDocument - The overlay PDF path.

basePdfPageIndexes - A list of Indexes (zero-based page numbers) of pages in this PDF to which the overlay will be applied to.

addForeground

public static void addForeground(InternalPdfDocument baseDocument,
                                 InternalPdfDocument foregroundDocument,
                                 List<Integer> basePdfPageIndexes,
                                 int foregroundPdfPageIndex)

Adds an overlay to a range or pages of this PDF. The foreground overlay is copied from a page in another PDF document.

Parameters:

baseDocument - the base document

foregroundDocument - The overlay PDF path.

basePdfPageIndexes - A list of Indexes (zero-based page numbers) of pages in this PDF to which the overlay will be applied to.

foregroundPdfPageIndex - Index (zero-based page number) to copy from the Overlay PDF.

addForeground

public static void addForeground(InternalPdfDocument baseDocument,
                                 InternalPdfDocument foregroundDocument)

Adds an overlay to a range or pages of this PDF. The foreground overlay is copied from a page in another PDF document.

Parameters:

baseDocument - the base document

foregroundDocument - The overlay PDF path.