rst.pdfbox.layout.elements

Class Frame

java.lang.Object

rst.pdfbox.layout.elements.Frame

All Implemented Interfaces:

Dividable, Drawable, Element, WidthRespecting

public class Frame
extends Object
implements Element, Drawable, WidthRespecting, Dividable

The frame is a container for a Drawable, that allows to add margin, padding, border and background to the contained drawable. The size (width and height) is either given, or calculated based on the dimensions of the contained item. The size available for the inner element is reduced by the margin, padding and border width.

Nested Class Summary

Nested classes/interfaces inherited from interface rst.pdfbox.layout.elements.Dividable

Dividable.Divided

Constructor Summary

Constructors

Constructor and Description
Frame(Drawable inner) Creates a frame containing the inner element.
Frame(Drawable inner, Float width, Float height) Creates a frame containing the inner element, optionally constraint by the given dimensions.

Method Summary

Modifier and Type	Method and Description
protected void	copyAllButInnerAndSizeTo(Frame other) Copies all attributes but the inner drawable and size to the given frame.
Dividable.Divided	divide(float remainingHeight, float nextPageHeight) Divides the drawable vetically into pieces where the first part is to respect the given remaining height.
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	getBackgroundColor()
Color	getBorderColor()
Stroke	getBorderStroke() The stroke to use to draw the border.
protected float	getBorderWidth()
protected Float	getGivenHeight()
protected Float	getGivenWidth()
float	getHeight()
protected float	getHorizontalShapeSpacing()
protected float	getHorizontalSpacing()
float	getMarginBottom()
float	getMarginLeft()
float	getMarginRight()
float	getMarginTop()
float	getMaxWidth()
float	getPaddingBottom()
float	getPaddingLeft()
float	getPaddingRight()
float	getPaddingTop()
Shape	getShape()
protected float	getVerticalShapeSpacing()
protected float	getVerticalSpacing()
float	getWidth()
protected boolean	hasBorder()
Drawable	removeLeadingEmptyVerticalSpace()
void	setAbsolutePosition(Position absolutePosition) Sets th absolute position.
void	setBackgroundColor(Color backgroundColor) Sets the color to use to draw the background.
void	setBorder(Color borderColor, Stroke borderStroke) Convenience method for setting both border color and stroke.
void	setBorderColor(Color borderColor) Sets the color to use to draw the border.
void	setBorderStroke(Stroke borderStroke) Sets the stroke to use to draw the border.
protected void	setInnerMaxWidthIfNecessary() Propagates the max width to the inner item if there is a given size, but no absolute position.
void	setMargin(float left, float right, float top, float bottom) Sets the margin.
void	setMarginBottom(float marginBottom) Sets the bottom margin.
void	setMarginLeft(float marginLeft) Sets the left margin.
void	setMarginRight(float marginRight) Sets the right margin.
void	setMarginTop(float marginTop) Sets the top margin.
void	setMaxWidth(float maxWidth) Sets the max width to respect.
void	setPadding(float left, float right, float top, float bottom) Sets the padding.
void	setPaddingBottom(float paddingBottom) Sets the bottom padding.
void	setPaddingLeft(float paddingLeft) Sets the left padding.
void	setPaddingRight(float paddingRight) Sets the right padding.
void	setPaddingTop(float paddingTop) Sets the top padding.
void	setShape(Shape shape) Sets the shape to use as border and/or background.

Methods inherited from class java.lang.Object

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

Constructor Detail

Frame

public Frame(Drawable inner)

Creates a frame containing the inner element.

Parameters:

inner - the item to contain.

Frame

public Frame(Drawable inner,
             Float width,
             Float height)

Creates a frame containing the inner element, optionally constraint by the given dimensions. These contraints target the border-box of the frame, means: the inner element plus padding plus border width, but not the margin.

Parameters:

inner - the item to contain.

width - the width to constrain the border-box of the frame to, or null.

height - the height to constrain the border-box of the frame to, or null.

Method Detail

getShape

public Shape getShape()

Returns:

the shape to use as border and/or background.

setShape

public void setShape(Shape shape)

Sets the shape to use as border and/or background.

Parameters:

shape - the shape to use.

getBorderStroke

public Stroke getBorderStroke()

The stroke to use to draw the border.

Returns:

the stroke to use.

setBorderStroke

public void setBorderStroke(Stroke borderStroke)

Sets the stroke to use to draw the border.

Parameters:

borderStroke - the stroke to use.

getBorderWidth

protected float getBorderWidth()

Returns:

the widht of the getBorderStroke() or 0.

hasBorder

protected boolean hasBorder()

Returns:

if a shape, a stroke and color is set.

getBorderColor

public Color getBorderColor()

Returns:

the color to use to draw the border.

setBorderColor

public void setBorderColor(Color borderColor)

Sets the color to use to draw the border.

Parameters:

borderColor - the border color.

setBorder

public void setBorder(Color borderColor,
                      Stroke borderStroke)

Convenience method for setting both border color and stroke.

Parameters:

borderColor - the border color.

borderStroke - the stroke to use.

getBackgroundColor

public Color getBackgroundColor()

Returns:

the color to use to draw the background.

setBackgroundColor

public void setBackgroundColor(Color backgroundColor)

Sets the color to use to draw the background.

Parameters:

backgroundColor - the background color.

copyAllButInnerAndSizeTo

protected void copyAllButInnerAndSizeTo(Frame other)

Copies all attributes but the inner drawable and size to the given frame.

Parameters:

other - the frame to copy the attributes to.

getPaddingLeft

public float getPaddingLeft()

Returns:

the left padding

setPaddingLeft

public void setPaddingLeft(float paddingLeft)

Sets the left padding.

Parameters:

paddingLeft - left padding.

getPaddingRight

public float getPaddingRight()

Returns:

the right padding

setPaddingRight

public void setPaddingRight(float paddingRight)

Sets the right padding.

Parameters:

paddingRight - right padding.

getPaddingTop

public float getPaddingTop()

Returns:

the top padding

setPaddingTop

public void setPaddingTop(float paddingTop)

Sets the top padding.

Parameters:

paddingTop - top padding.

getPaddingBottom

public float getPaddingBottom()

Returns:

the bottom padding

setPaddingBottom

public void setPaddingBottom(float paddingBottom)

Sets the bottom padding.

Parameters:

paddingBottom - bottom padding.

setPadding

public void setPadding(float left,
                       float right,
                       float top,
                       float bottom)

Sets the padding.

Parameters:

left - left padding.

right - right padding.

top - top padding.

bottom - bottom padding.

getMarginLeft

public float getMarginLeft()

Returns:

the left margin

setMarginLeft

public void setMarginLeft(float marginLeft)

Sets the left margin.

Parameters:

marginLeft - left margin.

getMarginRight

public float getMarginRight()

Returns:

the right margin

setMarginRight

public void setMarginRight(float marginRight)

Sets the right margin.

Parameters:

marginRight - right margin.

getMarginTop

public float getMarginTop()

Returns:

the top margin

setMarginTop

public void setMarginTop(float marginTop)

Sets the top margin.

Parameters:

marginTop - top margin.

getMarginBottom

public float getMarginBottom()

Returns:

the bottom margin

setMarginBottom

public void setMarginBottom(float marginBottom)

Sets the bottom margin.

Parameters:

marginBottom - bottom margin.

setMargin

public void setMargin(float left,
                      float right,
                      float top,
                      float bottom)

Sets the margin.

Parameters:

left - left margin.

right - right margin.

top - top margin.

bottom - bottom margin.

getHorizontalShapeSpacing

protected float getHorizontalShapeSpacing()

Returns:

the sum of left/right padding and border width.

getVerticalShapeSpacing

protected float getVerticalShapeSpacing()

Returns:

the sum of top/bottom padding and border width.

getHorizontalSpacing

protected float getHorizontalSpacing()

Returns:

the sum of left/right margin, padding and border width.

getVerticalSpacing

protected float getVerticalSpacing()

Returns:

the sum of top/bottom margin, padding and border width.

getGivenHeight

protected Float getGivenHeight()

Returns:

the height given to constrain the size of the shape.

getGivenWidth

protected Float getGivenWidth()

Returns:

the width given to constrain the size of the shape.

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()
                             throws IOException

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.

Throws:

IOException - by pdfbox

setAbsolutePosition

public void setAbsolutePosition(Position absolutePosition)

Sets th absolute position.

Parameters:

absolutePosition - the absolute position to use, or null.

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.

setInnerMaxWidthIfNecessary

protected void setInnerMaxWidthIfNecessary()
                                    throws IOException

Propagates the max width to the inner item if there is a given size, but no absolute position.

Throws:

IOException - by pdfbox.

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()
                                         throws IOException

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.

Throws:

IOException - by pdfbox

divide

public Dividable.Divided divide(float remainingHeight,
                                float nextPageHeight)
                         throws IOException

Description copied from interface: Dividable

Divides the drawable vetically into pieces where the first part is to respect the given remaining height. The page height allows to make better decisions on how to divide best.

Specified by:

divide in interface Dividable

Parameters:

remainingHeight - the remaining height on the page dictating the height of the first part.

nextPageHeight - the height of the next page allows to make better decisions on how to divide best, e.g. maybe the element fits completely on the next page.

Returns:

the Divided containing the first part and the tail.

Throws:

IOException - by pdfbox.