TextOrientation

Inheritance: java.lang.Object

public class TextOrientation

Specifies orientation of text on a page, in a table cell or a text frame.

Examples:

Shows how to build a formatted 2x2 table.


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

 Table table = builder.startTable();
 builder.insertCell();
 builder.getCellFormat().setVerticalAlignment(CellVerticalAlignment.CENTER);
 builder.write("Row 1, cell 1.");
 builder.insertCell();
 builder.write("Row 1, cell 2.");
 builder.endRow();

 // While building the table, the document builder will apply its current RowFormat/CellFormat property values
 // to the current row/cell that its cursor is in and any new rows/cells as it creates them.
 Assert.assertEquals(CellVerticalAlignment.CENTER, table.getRows().get(0).getCells().get(0).getCellFormat().getVerticalAlignment());
 Assert.assertEquals(CellVerticalAlignment.CENTER, table.getRows().get(0).getCells().get(1).getCellFormat().getVerticalAlignment());

 builder.insertCell();
 builder.getRowFormat().setHeight(100.0);
 builder.getRowFormat().setHeightRule(HeightRule.EXACTLY);
 builder.getCellFormat().setOrientation(TextOrientation.UPWARD);
 builder.write("Row 2, cell 1.");
 builder.insertCell();
 builder.getCellFormat().setOrientation(TextOrientation.DOWNWARD);
 builder.write("Row 2, cell 2.");
 builder.endRow();
 builder.endTable();

 // Previously added rows and cells are not retroactively affected by changes to the builder's formatting.
 Assert.assertEquals(0.0, table.getRows().get(0).getRowFormat().getHeight());
 Assert.assertEquals(HeightRule.AUTO, table.getRows().get(0).getRowFormat().getHeightRule());
 Assert.assertEquals(100.0, table.getRows().get(1).getRowFormat().getHeight());
 Assert.assertEquals(HeightRule.EXACTLY, table.getRows().get(1).getRowFormat().getHeightRule());
 Assert.assertEquals(TextOrientation.UPWARD, table.getRows().get(1).getCells().get(0).getCellFormat().getOrientation());
 Assert.assertEquals(TextOrientation.DOWNWARD, table.getRows().get(1).getCells().get(1).getCellFormat().getOrientation());

 doc.save(getArtifactsDir() + "DocumentBuilder.BuildTable.docx");
 

Fields

FieldDescription
DOWNWARDText is rotated 90 degrees to the right to appear from top to bottom (tb-rl).
HORIZONTALText is arranged horizontally (lr-tb).
HORIZONTAL_ROTATED_FAR_EASTText is arranged horizontally, but Far East characters are rotated 90 degrees to the left (lr-tb-v).
UPWARDText is rotated 90 degrees to the left to appear from bottom to top (bt-lr).
VERTICAL_FAR_EASTFar East characters appear vertical, other text is rotated 90 degrees to the right to appear from top to bottom (tb-rl-v).
VERTICAL_ROTATED_FAR_EASTFar East characters appear vertical, other text is rotated 90 degrees to the right to appear from top to bottom vertically, then left to right horizontally (tb-lr-v).
length

Methods

MethodDescription
fromName(String textOrientationName)
getName(int textOrientation)
getValues()
toString(int textOrientation)

DOWNWARD

public static int DOWNWARD

Text is rotated 90 degrees to the right to appear from top to bottom (tb-rl).

HORIZONTAL

public static int HORIZONTAL

Text is arranged horizontally (lr-tb).

HORIZONTAL_ROTATED_FAR_EAST

public static int HORIZONTAL_ROTATED_FAR_EAST

Text is arranged horizontally, but Far East characters are rotated 90 degrees to the left (lr-tb-v).

UPWARD

public static int UPWARD

Text is rotated 90 degrees to the left to appear from bottom to top (bt-lr).

VERTICAL_FAR_EAST

public static int VERTICAL_FAR_EAST

Far East characters appear vertical, other text is rotated 90 degrees to the right to appear from top to bottom (tb-rl-v).

VERTICAL_ROTATED_FAR_EAST

public static int VERTICAL_ROTATED_FAR_EAST

Far East characters appear vertical, other text is rotated 90 degrees to the right to appear from top to bottom vertically, then left to right horizontally (tb-lr-v).

length

public static int length

fromName(String textOrientationName)

public static int fromName(String textOrientationName)

Parameters:

ParameterTypeDescription
textOrientationNamejava.lang.String

Returns: int

getName(int textOrientation)

public static String getName(int textOrientation)

Parameters:

ParameterTypeDescription
textOrientationint

Returns: java.lang.String

getValues()

public static int[] getValues()

Returns: int[]

toString(int textOrientation)

public static String toString(int textOrientation)

Parameters:

ParameterTypeDescription
textOrientationint

Returns: java.lang.String