PageBorderAppliesTo

Inheritance: java.lang.Object

public class PageBorderAppliesTo

Specifies which pages the page border is printed on.

Examples:

Shows how to create a wide blue band border at the top of the first page.


 Document doc = new Document();

 PageSetup pageSetup = doc.getSections().get(0).getPageSetup();
 pageSetup.setBorderAlwaysInFront(false);
 pageSetup.setBorderDistanceFrom(PageBorderDistanceFrom.PAGE_EDGE);
 pageSetup.setBorderAppliesTo(PageBorderAppliesTo.FIRST_PAGE);

 Border border = pageSetup.getBorders().getByBorderType(BorderType.TOP);
 border.setLineStyle(LineStyle.SINGLE);
 border.setLineWidth(30.0);
 border.setColor(Color.BLUE);
 border.setDistanceFromText(0.0);

 doc.save(getArtifactsDir() + "PageSetup.PageBorderProperties.docx");
 

Fields

FieldDescription
ALL_PAGESPage border is shown on all pages of the section.
FIRST_PAGEPage border is shown on the first page of the section only.
OTHER_PAGESPage border is shown on all pages except the first page of the section.
length

Methods

MethodDescription
fromName(String pageBorderAppliesToName)
getName(int pageBorderAppliesTo)
getValues()
toString(int pageBorderAppliesTo)

ALL_PAGES

public static int ALL_PAGES

Page border is shown on all pages of the section.

FIRST_PAGE

public static int FIRST_PAGE

Page border is shown on the first page of the section only.

OTHER_PAGES

public static int OTHER_PAGES

Page border is shown on all pages except the first page of the section.

length

public static int length

fromName(String pageBorderAppliesToName)

public static int fromName(String pageBorderAppliesToName)

Parameters:

ParameterTypeDescription
pageBorderAppliesToNamejava.lang.String

Returns: int

getName(int pageBorderAppliesTo)

public static String getName(int pageBorderAppliesTo)

Parameters:

ParameterTypeDescription
pageBorderAppliesToint

Returns: java.lang.String

getValues()

public static int[] getValues()

Returns: int[]

toString(int pageBorderAppliesTo)

public static String toString(int pageBorderAppliesTo)

Parameters:

ParameterTypeDescription
pageBorderAppliesToint

Returns: java.lang.String