net.sf.jasperreports.engine.base
Class JRBaseBox

java.lang.Object
  net.sf.jasperreports.engine.base.JRBaseBox

All Implemented Interfaces:

java.io.Serializable, JRBox

public class JRBaseBox
extends java.lang.Object
implements JRBox, java.io.Serializable

This is useful for drawing borders around text elements and images. Boxes can have borders and paddings, which can have different width and colour on each side of the element.

Version:

$Id: JRBaseBox.java,v 1.17 2005/10/09 21:34:26 teodord Exp $

Author:

Teodor Danciu (teodord@users.sourceforge.net)

See Also:

Serialized Form

Field Summary

protected byte	border
protected java.awt.Color	borderColor
protected java.lang.Byte	bottomBorder
protected java.awt.Color	bottomBorderColor
protected java.lang.Integer	bottomPadding
protected java.lang.Byte	leftBorder
protected java.awt.Color	leftBorderColor
protected java.lang.Integer	leftPadding
protected int	padding
protected java.lang.Byte	rightBorder
protected java.awt.Color	rightBorderColor
protected java.lang.Integer	rightPadding
protected java.lang.Byte	topBorder
protected java.awt.Color	topBorderColor
protected java.lang.Integer	topPadding

Constructor Summary

JRBaseBox()

Method Summary

byte	getBorder() Gets the default border pen size (can be overwritten by individual settings).
java.awt.Color	getBorderColor() Gets the default border color (can be overwritten by individual settings).
byte	getBottomBorder()
java.awt.Color	getBottomBorderColor()
int	getBottomPadding()
byte	getLeftBorder()
java.awt.Color	getLeftBorderColor()
int	getLeftPadding()
java.lang.Byte	getOwnBottomBorder()
java.awt.Color	getOwnBottomBorderColor()
java.lang.Integer	getOwnBottomPadding()
java.lang.Byte	getOwnLeftBorder()
java.awt.Color	getOwnLeftBorderColor()
java.lang.Integer	getOwnLeftPadding()
java.lang.Byte	getOwnRightBorder()
java.awt.Color	getOwnRightBorderColor()
java.lang.Integer	getOwnRightPadding()
java.lang.Byte	getOwnTopBorder() Gets the top border pen size (if the default value was overwritten).
java.awt.Color	getOwnTopBorderColor() Gets the top border color (if the default value was overwritten).
java.lang.Integer	getOwnTopPadding()
int	getPadding() Gets the default padding in pixels (can be overwritten by individual settings).
byte	getRightBorder()
java.awt.Color	getRightBorderColor()
int	getRightPadding()
byte	getTopBorder() Gets the top border pen size.
java.awt.Color	getTopBorderColor() Gets the top border color.
int	getTopPadding()
void	setBorder(byte border) Sets the default border pen size (can be overwritten by individual settings).
void	setBorderColor(java.awt.Color borderColor) Sets the default border color (can be overwritten by individual settings).
void	setBottomBorder(byte bottomBorder)
void	setBottomBorderColor(java.awt.Color bottomBorderColor)
void	setBottomPadding(int bottomPadding)
void	setLeftBorder(byte leftBorder)
void	setLeftBorderColor(java.awt.Color leftBorderColor)
void	setLeftPadding(int leftPadding)
void	setPadding(int padding) Sets the default padding in pixels (can be overwritten by individual settings).
void	setRightBorder(byte rightBorder)
void	setRightBorderColor(java.awt.Color rightBorderColor)
void	setRightPadding(int rightPadding)
void	setTopBorder(byte topBorder) Sets the top border pen size.
void	setTopBorderColor(java.awt.Color topBorderColor) Sets the top border color.
void	setTopPadding(int topPadding)

Methods inherited from class java.lang.Object

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

Field Detail

border

protected byte border

topBorder

protected java.lang.Byte topBorder

leftBorder

protected java.lang.Byte leftBorder

bottomBorder

protected java.lang.Byte bottomBorder

rightBorder

protected java.lang.Byte rightBorder

borderColor

protected java.awt.Color borderColor

topBorderColor

protected java.awt.Color topBorderColor

leftBorderColor

protected java.awt.Color leftBorderColor

bottomBorderColor

protected java.awt.Color bottomBorderColor

rightBorderColor

protected java.awt.Color rightBorderColor

padding

protected int padding

topPadding

protected java.lang.Integer topPadding

leftPadding

protected java.lang.Integer leftPadding

bottomPadding

protected java.lang.Integer bottomPadding

rightPadding

protected java.lang.Integer rightPadding

Constructor Detail

JRBaseBox

public JRBaseBox()

Method Detail

getBorder

public byte getBorder()

Description copied from interface: JRBox

Gets the default border pen size (can be overwritten by individual settings).

Specified by:

getBorder in interface JRBox

setBorder

public void setBorder(byte border)

Description copied from interface: JRBox

Sets the default border pen size (can be overwritten by individual settings).

Specified by:

setBorder in interface JRBox

getBorderColor

public java.awt.Color getBorderColor()

Description copied from interface: JRBox

Gets the default border color (can be overwritten by individual settings).

Specified by:

getBorderColor in interface JRBox

setBorderColor

public void setBorderColor(java.awt.Color borderColor)

Description copied from interface: JRBox

Sets the default border color (can be overwritten by individual settings).

Specified by:

setBorderColor in interface JRBox

getPadding

public int getPadding()

Description copied from interface: JRBox

Gets the default padding in pixels (can be overwritten by individual settings).

Specified by:

getPadding in interface JRBox

setPadding

public void setPadding(int padding)

Description copied from interface: JRBox

Sets the default padding in pixels (can be overwritten by individual settings).

Specified by:

setPadding in interface JRBox

getTopBorder

public byte getTopBorder()

Description copied from interface: JRBox

Gets the top border pen size.

Specified by:

getTopBorder in interface JRBox

getOwnTopBorder

public java.lang.Byte getOwnTopBorder()

Description copied from interface: JRBox

Gets the top border pen size (if the default value was overwritten).

Specified by:

getOwnTopBorder in interface JRBox

setTopBorder

public void setTopBorder(byte topBorder)

Description copied from interface: JRBox

Sets the top border pen size.

Specified by:

setTopBorder in interface JRBox

getTopBorderColor

public java.awt.Color getTopBorderColor()

Description copied from interface: JRBox

Gets the top border color.

Specified by:

getTopBorderColor in interface JRBox

getOwnTopBorderColor

public java.awt.Color getOwnTopBorderColor()

Description copied from interface: JRBox

Gets the top border color (if the default value was overwritten).

Specified by:

getOwnTopBorderColor in interface JRBox

setTopBorderColor

public void setTopBorderColor(java.awt.Color topBorderColor)

Description copied from interface: JRBox

Sets the top border color.

Specified by:

setTopBorderColor in interface JRBox

getTopPadding

public int getTopPadding()

Specified by:

getTopPadding in interface JRBox

getOwnTopPadding

public java.lang.Integer getOwnTopPadding()

Specified by:

getOwnTopPadding in interface JRBox

setTopPadding

public void setTopPadding(int topPadding)

Specified by:

setTopPadding in interface JRBox

getLeftBorder

public byte getLeftBorder()

Specified by:

getLeftBorder in interface JRBox

getOwnLeftBorder

public java.lang.Byte getOwnLeftBorder()

Specified by:

getOwnLeftBorder in interface JRBox

setLeftBorder

public void setLeftBorder(byte leftBorder)

Specified by:

setLeftBorder in interface JRBox

getLeftBorderColor

public java.awt.Color getLeftBorderColor()

Specified by:

getLeftBorderColor in interface JRBox

getOwnLeftBorderColor

public java.awt.Color getOwnLeftBorderColor()

Specified by:

getOwnLeftBorderColor in interface JRBox

setLeftBorderColor

public void setLeftBorderColor(java.awt.Color leftBorderColor)

Specified by:

setLeftBorderColor in interface JRBox

getLeftPadding

public int getLeftPadding()

Specified by:

getLeftPadding in interface JRBox

getOwnLeftPadding

public java.lang.Integer getOwnLeftPadding()

Specified by:

getOwnLeftPadding in interface JRBox

setLeftPadding

public void setLeftPadding(int leftPadding)

Specified by:

setLeftPadding in interface JRBox

getBottomBorder

public byte getBottomBorder()

Specified by:

getBottomBorder in interface JRBox

getOwnBottomBorder

public java.lang.Byte getOwnBottomBorder()

Specified by:

getOwnBottomBorder in interface JRBox

setBottomBorder

public void setBottomBorder(byte bottomBorder)

Specified by:

setBottomBorder in interface JRBox

getBottomBorderColor

public java.awt.Color getBottomBorderColor()

Specified by:

getBottomBorderColor in interface JRBox

getOwnBottomBorderColor

public java.awt.Color getOwnBottomBorderColor()

Specified by:

getOwnBottomBorderColor in interface JRBox

setBottomBorderColor

public void setBottomBorderColor(java.awt.Color bottomBorderColor)

Specified by:

setBottomBorderColor in interface JRBox

getBottomPadding

public int getBottomPadding()

Specified by:

getBottomPadding in interface JRBox

getOwnBottomPadding

public java.lang.Integer getOwnBottomPadding()

Specified by:

getOwnBottomPadding in interface JRBox

setBottomPadding

public void setBottomPadding(int bottomPadding)

Specified by:

setBottomPadding in interface JRBox

getRightBorder

public byte getRightBorder()

Specified by:

getRightBorder in interface JRBox

getOwnRightBorder

public java.lang.Byte getOwnRightBorder()

Specified by:

getOwnRightBorder in interface JRBox

setRightBorder

public void setRightBorder(byte rightBorder)

Specified by:

setRightBorder in interface JRBox

getRightBorderColor

public java.awt.Color getRightBorderColor()

Specified by:

getRightBorderColor in interface JRBox

getOwnRightBorderColor

public java.awt.Color getOwnRightBorderColor()

Specified by:

getOwnRightBorderColor in interface JRBox

setRightBorderColor

public void setRightBorderColor(java.awt.Color rightBorderColor)

Specified by:

setRightBorderColor in interface JRBox

getRightPadding

public int getRightPadding()

Specified by:

getRightPadding in interface JRBox

getOwnRightPadding

public java.lang.Integer getOwnRightPadding()

Specified by:

getOwnRightPadding in interface JRBox

setRightPadding

public void setRightPadding(int rightPadding)

Specified by:

setRightPadding in interface JRBox