rst.pdfbox.layout.elements

Class PositionControl

java.lang.Object

rst.pdfbox.layout.elements.ControlElement

rst.pdfbox.layout.elements.PositionControl

All Implemented Interfaces:

Element

Direct Known Subclasses:

PositionControl.MarkPosition, PositionControl.MovePosition, PositionControl.SetPosition

public class PositionControl
extends ControlElement

Utility class to create elements that allow the manipulation of the current layout position. Use carefully.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PositionControl.MarkPosition
static class	PositionControl.MovePosition
static class	PositionControl.SetPosition

Field Summary

Fields

Modifier and Type	Field and Description
static Float	MARKED_POSITION Use this value in createSetPosition(Float, Float) to reset either one or both coordinates to the marked position.

Fields inherited from class rst.pdfbox.layout.elements.ControlElement

NEWPAGE

Method Summary

Modifier and Type	Method and Description
static PositionControl.MarkPosition	createMarkPosition() Add this element to a document to mark the current position.
static PositionControl.MovePosition	createMovePosition(float relativeX, float relativeY) Add this element to a document to manipulate the current layout position by a relative amount.
static PositionControl.SetPosition	createSetPosition(Float newX, Float newY) Add this element to a document to manipulate the current layout position.

Methods inherited from class rst.pdfbox.layout.elements.ControlElement

toString

Methods inherited from class java.lang.Object

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

Field Detail

MARKED_POSITION

public static final Float MARKED_POSITION

Use this value in createSetPosition(Float, Float) to reset either one or both coordinates to the marked position.

Method Detail

createMarkPosition

public static PositionControl.MarkPosition createMarkPosition()

Add this element to a document to mark the current position.

Returns:

the created element

createSetPosition

public static PositionControl.SetPosition createSetPosition(Float newX,
                                                            Float newY)

Add this element to a document to manipulate the current layout position. If null, the position won't be changed (useful if you want to change only X or Y). If the value is MARKED_POSITION, it wil be (re-)set to the marked position.

Parameters:

newX - the new X position.

newY - new new Y position.

Returns:

the created element

createMovePosition

public static PositionControl.MovePosition createMovePosition(float relativeX,
                                                              float relativeY)

Add this element to a document to manipulate the current layout position by a relative amount. If null, the position won't be changed (useful if you want to change only X or Y).

Parameters:

relativeX - the value to change position in X direction.

relativeY - the value to change position in Y direction.

Returns:

the created element