rst.pdfbox.layout.elements

Class HorizontalRuler

java.lang.Object

rst.pdfbox.layout.elements.HorizontalRuler

All Implemented Interfaces:

Drawable, Element, WidthRespecting

public class HorizontalRuler
extends Object
implements Drawable, Element, WidthRespecting

A horizontal ruler that adjust its width to the given max width.

Constructor Summary

Constructors

Constructor and Description
HorizontalRuler(Stroke stroke, Color color)

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.
Color	getColor()
float	getHeight()
float	getMaxWidth()
Stroke	getStroke()
float	getWidth()
Drawable	removeLeadingEmptyVerticalSpace()
void	setMaxWidth(float maxWidth) Sets the max width to respect.

Methods inherited from class java.lang.Object

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

Constructor Detail

HorizontalRuler

public HorizontalRuler(Stroke stroke,
                       Color color)

Method Detail

getStroke

public Stroke getStroke()

Returns:

the stroke to draw the ruler with.

getColor

public Color getColor()

Returns:

the color to draw the ruler with.

getMaxWidth

public float getMaxWidth()

Specified by:

getMaxWidth in interface WidthRespecting

Returns:

the max width to respect.

setMaxWidth

public void setMaxWidth(float maxWidth)

Description copied from interface: WidthRespecting

Sets the max width to respect.

Specified by:

setMaxWidth in interface WidthRespecting

Parameters:

maxWidth - the maximum width.

getWidth

public float getWidth()
               throws IOException

Specified by:

getWidth in interface Drawable

Returns:

the width of the drawable.

Throws:

IOException - by pdfbox

getHeight

public float getHeight()
                throws IOException

Specified by:

getHeight in interface Drawable

Returns:

the height of the drawable.

Throws:

IOException - by pdfbox

getAbsolutePosition

public Position getAbsolutePosition()

Description copied from interface: Drawable

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

Specified by:

getAbsolutePosition in interface Drawable

Returns:

the absolute position.

draw

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

Description copied from interface: Drawable

Draws the object at the given position.

Specified by:

draw in interface Drawable

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

public Drawable removeLeadingEmptyVerticalSpace()

Specified by:

removeLeadingEmptyVerticalSpace in interface Drawable

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.