Package com.storedobject.pdf

Class PDFRectangle

java.lang.Object

com.storedobject.pdf.PDFRectangle

All Implemented Interfaces:

PDFElement

Direct Known Subclasses:

PDFCell, PDFImage

public class PDFRectangle
extends Object
implements PDFElement

Representation of "PDF rectangle".

Author:

Syam

Field Summary

Fields

Modifier and Type	Field	Description
static int	BOTTOM	Represents bottom side.
static int	BOX	Represents all sides (as a box).
static int	LEFT	Represents left side.
static int	NO_BORDER	Represents "no border".
static int	RIGHT	Represents right side.
static int	TOP	Represents top side.
static int	UNDEFINED	Uses to represent an "undefined" value.

Fields inherited from interface com.storedobject.pdf.PDFElement

ALIGN_BASELINE, ALIGN_BOTTOM, ALIGN_CENTER, ALIGN_JUSTIFIED, ALIGN_JUSTIFIED_ALL, ALIGN_LEFT, ALIGN_MIDDLE, ALIGN_RIGHT, ALIGN_TOP, ALIGN_UNDEFINED, TEXT_DIRECTION_DEFAULT, TEXT_DIRECTION_LTR, TEXT_DIRECTION_NO_BIDI, TEXT_DIRECTION_RTL

Constructor Summary

Constructors

Constructor	Description
PDFRectangle(float x2, float y2)	Constructor.
PDFRectangle(float x1, float y1, float x2, float y2)	Constructor.
PDFRectangle(float x1, float y1, float x2, float y2, int rotation)	Constructor.
PDFRectangle(float x2, float y2, int rotation)	Constructor.
PDFRectangle(PDFRectangle another)	Construct from another.

Method Summary

Modifier and Type	Method	Description
PDFColor	getBackgroundColor()	Get the background color.
int	getBorder()	Get the border value.
PDFColor	getBorderColor()	Get the border color.
PDFColor	getBorderColorBottom()	Get the color for the bottom border.
PDFColor	getBorderColorLeft()	Get the color for the left border.
PDFColor	getBorderColorRight()	Get the color for the right border.
PDFColor	getBorderColorTop()	Get the color for the top border.
float	getBorderWidth()	Get the border thickness.
float	getBorderWidthBottom()	Get the thickness of the bottom border.
float	getBorderWidthLeft()	Get the thickness of the left border.
float	getBorderWidthRight()	Get the thickness of the right border.
float	getBorderWidthTop()	Get the thickness of the top border.
float	getBottom()	Get the bottom value.
float	getGrayFill()	Get the gray fill value.
float	getHeight()	Get the height.
float	getLeft()
float	getRight()	Get the right value.
int	getRotation()	Get the rotation value.
float	getTop()	Get the top value.
float	getWidth()	Get the width.
PDFRectangle	rotate()	Create a rotated instance.
void	setBackgroundColor(PDFColor color)	Set the background color.
void	setBorder(int borders)	Set borders.
void	setBorderColor(PDFColor color)	Set the border color.
void	setBorderColorBottom(PDFColor color)	Set the color for the bottom border.
void	setBorderColorLeft(PDFColor color)	Set the color for the left border.
void	setBorderColorRight(PDFColor color)	Set the color for the right border.
void	setBorderColorTop(PDFColor color)	Set the color for the top border.
void	setBorderWidth(float thickness)	Set the border thickness.
void	setBorderWidthBottom(float thickness)	Set the thickness of the bottom border.
void	setBorderWidthLeft(float thickness)	Set the thickness of the left border.
void	setBorderWidthRight(float thickness)	Set the thickness of the right border.
void	setBorderWidthTop(float thickness)	Set the thickness of the top border.
void	setBottom(float value)	Set the bottom value.
void	setGrayFill(float fillValue)	Set the gray fill value (between 0.0 and 1.0).
void	setLeft(float value)	Set the left value.
void	setRight(float value)	Set the right value.
void	setRotation(int rotation)	Set rotation in degrees.
void	setTop(float value)	Set the top value.

Methods inherited from class java.lang.Object

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

Field Details

UNDEFINED

public static int UNDEFINED

Uses to represent an "undefined" value.

TOP

public static int TOP

Represents top side.

BOTTOM

public static int BOTTOM

Represents bottom side.

LEFT

public static int LEFT

Represents left side.

RIGHT

public static int RIGHT

Represents right side.

NO_BORDER

public static int NO_BORDER

Represents "no border".

BOX

public static int BOX

Represents all sides (as a box).

Constructor Details

PDFRectangle

public PDFRectangle(float x1,
 float y1,
 float x2,
 float y2)

Constructor.

Parameters:

x1 - Coordinate x1 (Lower left).

y1 - Coordinate y1 (Lower left).

x2 - Coordinate x2 (Upper right).

y2 - Coordinate y2 (Upper right).

PDFRectangle

public PDFRectangle(float x1,
 float y1,
 float x2,
 float y2,
 int rotation)

Constructor.

Parameters:

x1 - Coordinate x1 (Lower left).

y1 - Coordinate y1 (Lower left).

x2 - Coordinate x2 (Upper right).

y2 - Coordinate y2 (Upper right).

rotation - Rotation in degrees (multiples fo 90 only).

PDFRectangle

public PDFRectangle(float x2,
 float y2)

Constructor. (x1, y1) will be (0, 0).

Parameters:

x2 - Coordinate x2 (Upper right).

y2 - Coordinate y2 (Upper right).

PDFRectangle

public PDFRectangle(float x2,
 float y2,
 int rotation)

Constructor. (x1, y1) will be (0, 0).

Parameters:

x2 - Coordinate x2 (Upper right).

y2 - Coordinate y2 (Upper right).

rotation - Rotation in degrees (multiples fo 90 only).

PDFRectangle

public PDFRectangle(PDFRectangle another)

Construct from another.

Parameters:

another - Another instance.

Method Details

rotate

public PDFRectangle rotate()

Create a rotated instance. (by 90 degree)

Returns:

Rotated instance.

setBorderWidth

public void setBorderWidth(float thickness)

Set the border thickness.

Parameters:

thickness - Border thickness.

setBorder

public void setBorder(int borders)

Set borders. (Can be ORed values of TOP, BOTTOM etc.)

Parameters:

borders - Borders.

getWidth

public float getWidth()

Get the width.

Returns:

Width.

getHeight

public float getHeight()

Get the height.

Returns:

Height.

setGrayFill

public void setGrayFill(float fillValue)

Set the gray fill value (between 0.0 and 1.0).

Parameters:

fillValue - Gray fill value.

setRotation

public void setRotation(int rotation)

Set rotation in degrees.

Parameters:

rotation - Rotation (multiples of 90).

setLeft

public void setLeft(float value)

Set the left value.

Parameters:

value - Left.

getLeft

public float getLeft()

setRight

public void setRight(float value)

Set the right value.

Parameters:

value - Right.

getRight

public float getRight()

Get the right value.

Returns:

Right.

setTop

public void setTop(float value)

Set the top value.

Parameters:

value - Top.

getTop

public float getTop()

Get the top value.

Returns:

Top.

setBottom

public void setBottom(float value)

Set the bottom value.

Parameters:

value - Bottom.

getBottom

public float getBottom()

Get the bottom value.

Returns:

Bottom.

getRotation

public int getRotation()

Get the rotation value.

Returns:

Rotation.

getBackgroundColor

public PDFColor getBackgroundColor()

Get the background color.

Returns:

Background color.

setBackgroundColor

public void setBackgroundColor(PDFColor color)

Set the background color.

Parameters:

color - Color.

getGrayFill

public float getGrayFill()

Get the gray fill value.

Returns:

Gray fill.

getBorder

public int getBorder()

Get the border value.

Returns:

Border.

getBorderWidth

public float getBorderWidth()

Get the border thickness.

Returns:

Border thickness.

getBorderWidthLeft

public float getBorderWidthLeft()

Get the thickness of the left border.

Returns:

Border thickness.

setBorderWidthLeft

public void setBorderWidthLeft(float thickness)

Set the thickness of the left border.

Parameters:

thickness - Thickness.

getBorderWidthRight

public float getBorderWidthRight()

Get the thickness of the right border.

Returns:

Border thickness.

setBorderWidthRight

public void setBorderWidthRight(float thickness)

Set the thickness of the right border.

Parameters:

thickness - Thickness.

getBorderWidthTop

public float getBorderWidthTop()

Get the thickness of the top border.

Returns:

Border thickness.

setBorderWidthTop

public void setBorderWidthTop(float thickness)

Set the thickness of the top border.

Parameters:

thickness - Thickness.

getBorderWidthBottom

public float getBorderWidthBottom()

Get the thickness of the bottom border.

Returns:

Border thickness.

setBorderWidthBottom

public void setBorderWidthBottom(float thickness)

Set the thickness of the bottom border.

Parameters:

thickness - Thickness.

getBorderColor

public PDFColor getBorderColor()

Get the border color.

Returns:

Color.

setBorderColor

public void setBorderColor(PDFColor color)

Set the border color.

Parameters:

color - Color.

getBorderColorLeft

public PDFColor getBorderColorLeft()

Get the color for the left border.

Returns:

Color.

setBorderColorLeft

public void setBorderColorLeft(PDFColor color)

Set the color for the left border.

Parameters:

color - Color.

getBorderColorRight

public PDFColor getBorderColorRight()

Get the color for the right border.

Returns:

Color.

setBorderColorRight

public void setBorderColorRight(PDFColor color)

Set the color for the right border.

Parameters:

color - Color.

getBorderColorTop

public PDFColor getBorderColorTop()

Get the color for the top border.

Returns:

Color.

setBorderColorTop

public void setBorderColorTop(PDFColor color)

Set the color for the top border.

Parameters:

color - Color.

getBorderColorBottom

public PDFColor getBorderColorBottom()

Get the color for the bottom border.

Returns:

Color.

setBorderColorBottom

public void setBorderColorBottom(PDFColor color)

Set the color for the bottom border.

Parameters:

color - Color.