RelativeVerticalSize

Inheritance: java.lang.Object

public class RelativeVerticalSize

Specifies relatively to what the height of a shape or a text frame is calculated vertically.

Examples:

Shows how to set relative size and position.


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

 // Adding a simple shape with absolute size and position.
 Shape shape = builder.insertShape(ShapeType.RECTANGLE, 100.0, 40.0);
 // Set WrapType to WrapType.None since Inline shapes are automatically converted to absolute units.
 shape.setWrapType(WrapType.NONE);

 // Checking and setting the relative horizontal size.
 if (shape.getRelativeHorizontalSize() == RelativeHorizontalSize.DEFAULT)
 {
     // Setting the horizontal size binding to Margin.
     shape.setRelativeHorizontalSize(RelativeHorizontalSize.MARGIN);
     // Setting the width to 50% of Margin width.
     shape.setWidthRelative(50f);
 }

 // Checking and setting the relative vertical size.
 if (shape.getRelativeVerticalSize() == RelativeVerticalSize.DEFAULT)
 {
     // Setting the vertical size binding to Margin.
     shape.setRelativeVerticalSize(RelativeVerticalSize.MARGIN);
     // Setting the heigh to 30% of Margin height.
     shape.setHeightRelative(30f);
 }

 // Checking and setting the relative vertical position.
 if (shape.getRelativeVerticalPosition() == RelativeVerticalPosition.PARAGRAPH)
 {
     // etting the position binding to TopMargin.
     shape.setRelativeVerticalPosition(RelativeVerticalPosition.TOP_MARGIN);
     // Setting relative Top to 30% of TopMargin position.
     shape.setTopRelative(30f);
 }

 // Checking and setting the relative horizontal position.
 if (shape.getRelativeHorizontalPosition() == RelativeHorizontalPosition.DEFAULT)
 {
     // Setting the position binding to RightMargin.
     shape.setRelativeHorizontalPosition(RelativeHorizontalPosition.RIGHT_MARGIN);
     // The position relative value can be negative.
     shape.setLeftRelative(-260);
 }

 doc.save(getArtifactsDir() + "Shape.RelativeSizeAndPosition.docx");

Fields

Field	Description
BOTTOM_MARGIN	Specifies that the height is calculated relatively to the bottom margin area size.
DEFAULT	Default value is MARGIN.
INNER_MARGIN	Specifies that the height is calculated relatively to the inside margin area size, to the top margin area size for odd pages and to the bottom margin area size for even pages.
MARGIN	Specifies that the height is calculated relatively to the space between the top and the bottom margins.
OUTER_MARGIN	Specifies that the height is calculated relatively to the outside margin area size, to the bottom margin area size for odd pages and to the top margin area size for even pages.
PAGE	Specifies that the height is calculated relatively to the page height.
TOP_MARGIN	Specifies that the height is calculated relatively to the top margin area size.
length

Methods

Method	Description
fromName(String relativeVerticalSizeName)
getName(int relativeVerticalSize)
getValues()
toString(int relativeVerticalSize)

BOTTOM_MARGIN

public static int BOTTOM_MARGIN

Specifies that the height is calculated relatively to the bottom margin area size.

DEFAULT

public static int DEFAULT

Default value is MARGIN.

INNER_MARGIN

public static int INNER_MARGIN

Specifies that the height is calculated relatively to the inside margin area size, to the top margin area size for odd pages and to the bottom margin area size for even pages.

MARGIN

public static int MARGIN

Specifies that the height is calculated relatively to the space between the top and the bottom margins.

OUTER_MARGIN

public static int OUTER_MARGIN

Specifies that the height is calculated relatively to the outside margin area size, to the bottom margin area size for odd pages and to the top margin area size for even pages.

PAGE

public static int PAGE

Specifies that the height is calculated relatively to the page height.

TOP_MARGIN

public static int TOP_MARGIN

Specifies that the height is calculated relatively to the top margin area size.

length

public static int length

fromName(String relativeVerticalSizeName)

public static int fromName(String relativeVerticalSizeName)

Parameters:

Parameter	Type	Description
relativeVerticalSizeName	java.lang.String

Returns: int

getName(int relativeVerticalSize)

public static String getName(int relativeVerticalSize)

Parameters:

Parameter	Type	Description
relativeVerticalSize	int

Returns: java.lang.String

getValues()

public static int[] getValues()

Returns: int[]

toString(int relativeVerticalSize)

public static String toString(int relativeVerticalSize)

Parameters:

Parameter	Type	Description
relativeVerticalSize	int

Returns: java.lang.String

RelativeVerticalPosition ReplaceAction