PageVerticalAlignment

Inheritance: java.lang.Object

public class PageVerticalAlignment

Specifies vertical justification of text on each page.

Examples:

Shows how to apply and revert page setup settings to sections in a document.

 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 // Modify the page setup properties for the builder's current section and add text.
 builder.getPageSetup().setOrientation(Orientation.LANDSCAPE);
 builder.getPageSetup().setVerticalAlignment(PageVerticalAlignment.CENTER);
 builder.writeln("This is the first section, which landscape oriented with vertically centered text.");

 // If we start a new section using a document builder,
 // it will inherit the builder's current page setup properties.
 builder.insertBreak(BreakType.SECTION_BREAK_NEW_PAGE);

 Assert.assertEquals(Orientation.LANDSCAPE, doc.getSections().get(1).getPageSetup().getOrientation());
 Assert.assertEquals(PageVerticalAlignment.CENTER, doc.getSections().get(1).getPageSetup().getVerticalAlignment());

 // We can revert its page setup properties to their default values using the "ClearFormatting" method.
 builder.getPageSetup().clearFormatting();

 Assert.assertEquals(Orientation.PORTRAIT, doc.getSections().get(1).getPageSetup().getOrientation());
 Assert.assertEquals(PageVerticalAlignment.TOP, doc.getSections().get(1).getPageSetup().getVerticalAlignment());

 builder.writeln("This is the second section, which is in default Letter paper size, portrait orientation and top alignment.");

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

Fields

Field	Description
BOTTOM	Text is aligned at the bottom of the page.
CENTER	Text is aligned in the middle of the page.
JUSTIFY	Text is spread to fill the page.
TOP	Text is aligned at the top of the page.
length

Methods

Method	Description
fromName(String pageVerticalAlignmentName)
getName(int pageVerticalAlignment)
getValues()
toString(int pageVerticalAlignment)

BOTTOM

public static int BOTTOM

Text is aligned at the bottom of the page.

CENTER

public static int CENTER

Text is aligned in the middle of the page.

JUSTIFY

public static int JUSTIFY

Text is spread to fill the page.

TOP

public static int TOP

Text is aligned at the top of the page.

length

public static int length

fromName(String pageVerticalAlignmentName)

public static int fromName(String pageVerticalAlignmentName)

Parameters:

Parameter	Type	Description
pageVerticalAlignmentName	java.lang.String

Returns: int

getName(int pageVerticalAlignment)

public static String getName(int pageVerticalAlignment)

Parameters:

Parameter	Type	Description
pageVerticalAlignment	int

Returns: java.lang.String

getValues()

public static int[] getValues()

Returns: int[]

toString(int pageVerticalAlignment)

public static String toString(int pageVerticalAlignment)

Parameters:

Parameter	Type	Description
pageVerticalAlignment	int

Returns: java.lang.String