rst.pdfbox.layout.elements

Interface Drawable

All Known Implementing Classes:

Cutter, Frame, HorizontalRuler, ImageElement, Paragraph, VerticalSpacer

public interface Drawable

Common interface for drawable objects.

Method Summary

Modifier and Type	Method and Description
void	draw(org.apache.pdfbox.pdmodel.PDDocument pdDocument, org.apache.pdfbox.pdmodel.PDPageContentStream contentStream, Position upperLeft, DrawListener drawListener) Draws the object at the given position.
Position	getAbsolutePosition() If an absolute position is given, the drawable will be drawn at this position ignoring any Layout.
float	getHeight()
float	getWidth()
Drawable	removeLeadingEmptyVerticalSpace()

Method Detail

getWidth

float getWidth()
        throws IOException

Returns:

the width of the drawable.

Throws:

IOException - by pdfbox

getHeight

float getHeight()
         throws IOException

Returns:

the height of the drawable.

Throws:

IOException - by pdfbox

getAbsolutePosition

Position getAbsolutePosition()
                      throws IOException

If an absolute position is given, the drawable will be drawn at this position ignoring any Layout.

Returns:

the absolute position.

Throws:

IOException - by pdfbox

draw

void draw(org.apache.pdfbox.pdmodel.PDDocument pdDocument,
          org.apache.pdfbox.pdmodel.PDPageContentStream contentStream,
          Position upperLeft,
          DrawListener drawListener)
   throws IOException

Draws the object at the given position.

Parameters:

pdDocument - the underlying pdfbox document.

contentStream - the stream to draw to.

upperLeft - the upper left position to start drawing.

drawListener - the listener to notify on drawn objects.

Throws:

IOException - by pdfbox

removeLeadingEmptyVerticalSpace

Drawable removeLeadingEmptyVerticalSpace()
                                  throws IOException

Returns:

a copy of this drawable where any leading empty vertical space is removed, if possible. This is useful for avoiding leading empty space on a new page.

Throws:

IOException - by pdfbox