net.sf.jasperreports.engine.base

Class JRBaseLineBox

java.lang.Object

net.sf.jasperreports.engine.base.JRBaseLineBox

All Implemented Interfaces:

Serializable, Cloneable, Deduplicable, JRChangeEventsSupport, JRLineBox, JRPenContainer, JRStyleContainer

public class JRBaseLineBox
extends Object
implements JRLineBox, Serializable, Cloneable, JRChangeEventsSupport, Deduplicable

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.

Author:

Teodor Danciu (teodord@users.sourceforge.net)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Integer	bottomPadding
protected JRBoxPen	bottomPen
protected JRBoxContainer	boxContainer
protected Integer	leftPadding
protected JRBoxPen	leftPen
protected Integer	padding
protected JRBoxPen	pen
static String	PROPERTY_BOTTOM_PADDING
static String	PROPERTY_LEFT_PADDING
static String	PROPERTY_PADDING
static String	PROPERTY_RIGHT_PADDING
static String	PROPERTY_TOP_PADDING
protected Integer	rightPadding
protected JRBoxPen	rightPen
protected Integer	topPadding
protected JRBoxPen	topPen

Constructor Summary

Constructors

Constructor and Description
JRBaseLineBox(JRBoxContainer boxContainer)

Method Summary

Methods

Modifier and Type	Method and Description
JRLineBox	clone(JRBoxContainer boxContainer)
void	copyBottomPen(JRBoxPen bottomPen)
void	copyLeftPen(JRBoxPen leftPen)
void	copyPen(JRBoxPen pen)
void	copyRightPen(JRBoxPen rightPen)
void	copyTopPen(JRBoxPen topPen)
Integer	getBottomPadding()
JRBoxPen	getBottomPen() Gets the pen properties for the bottom border.
JRBoxContainer	getBoxContainer()
Color	getDefaultLineColor()
Float	getDefaultLineWidth()
JRDefaultStyleProvider	getDefaultStyleProvider()
JRPropertyChangeSupport	getEventSupport() Returns the property change support object for this instance.
int	getHashCode() Returns a hash code to be used for the deduplicate map.
Integer	getLeftPadding()
JRBoxPen	getLeftPen() Gets the pen properties for the left border.
Integer	getOwnBottomPadding()
Integer	getOwnLeftPadding()
Integer	getOwnPadding()
Integer	getOwnRightPadding()
Integer	getOwnTopPadding()
Integer	getPadding() Gets the default padding in pixels (can be overwritten by individual settings).
JRBoxPen	getPen() Gets the pen properties for the border.
Integer	getRightPadding()
JRBoxPen	getRightPen() Gets the pen properties for the right border.
JRStyle	getStyle() Returns this object's style.
String	getStyleNameReference() Returns the name of an external style which is to be used by this object.
Integer	getTopPadding()
JRBoxPen	getTopPen() Gets the pen properties for the top border.
boolean	isIdentical(Object object) Determines if this instance is identical to another object.
void	setBottomPadding(int bottomPadding)
void	setBottomPadding(Integer bottomPadding)
void	setLeftPadding(int leftPadding)
void	setLeftPadding(Integer leftPadding)
void	setPadding(int padding) Sets the default padding in pixels (can be overwritten by individual settings).
void	setPadding(Integer padding)
void	setRightPadding(int rightPadding)
void	setRightPadding(Integer rightPadding)
void	setTopPadding(int topPadding)
void	setTopPadding(Integer topPadding)

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_PADDING

public static final String PROPERTY_PADDING

See Also:

Constant Field Values

PROPERTY_TOP_PADDING

public static final String PROPERTY_TOP_PADDING

See Also:

Constant Field Values

PROPERTY_LEFT_PADDING

public static final String PROPERTY_LEFT_PADDING

See Also:

Constant Field Values

PROPERTY_BOTTOM_PADDING

public static final String PROPERTY_BOTTOM_PADDING

See Also:

Constant Field Values

PROPERTY_RIGHT_PADDING

public static final String PROPERTY_RIGHT_PADDING

See Also:

Constant Field Values

boxContainer

protected JRBoxContainer boxContainer

pen

protected JRBoxPen pen

topPen

protected JRBoxPen topPen

leftPen

protected JRBoxPen leftPen

bottomPen

protected JRBoxPen bottomPen

rightPen

protected JRBoxPen rightPen

padding

protected Integer padding

topPadding

protected Integer topPadding

leftPadding

protected Integer leftPadding

bottomPadding

protected Integer bottomPadding

rightPadding

protected Integer rightPadding

Constructor Detail

JRBaseLineBox

public JRBaseLineBox(JRBoxContainer boxContainer)

Method Detail

getDefaultStyleProvider

public JRDefaultStyleProvider getDefaultStyleProvider()

Specified by:

getDefaultStyleProvider in interface JRStyleContainer

getStyle

public JRStyle getStyle()

Description copied from interface: JRStyleContainer

Returns this object's style.

Specified by:

getStyle in interface JRStyleContainer

Returns:

this object's style

getStyleNameReference

public String getStyleNameReference()

Description copied from interface: JRStyleContainer

Returns the name of an external style which is to be used by this object.

External styles are defined in templates and are resolved at fill time. This attribute is only effective if no direct style (as returned by getStyle() is specified for this object.

Specified by:

getStyleNameReference in interface JRStyleContainer

Returns:

the name of an external style

getBoxContainer

public JRBoxContainer getBoxContainer()

Specified by:

getBoxContainer in interface JRLineBox

getDefaultLineWidth

public Float getDefaultLineWidth()

Specified by:

getDefaultLineWidth in interface JRPenContainer

getDefaultLineColor

public Color getDefaultLineColor()

Specified by:

getDefaultLineColor in interface JRPenContainer

getPen

public JRBoxPen getPen()

Description copied from interface: JRLineBox

Gets the pen properties for the border.

Specified by:

getPen in interface JRLineBox

copyPen

public void copyPen(JRBoxPen pen)

Specified by:

copyPen in interface JRLineBox

getTopPen

public JRBoxPen getTopPen()

Description copied from interface: JRLineBox

Gets the pen properties for the top border.

Specified by:

getTopPen in interface JRLineBox

copyTopPen

public void copyTopPen(JRBoxPen topPen)

Specified by:

copyTopPen in interface JRLineBox

getLeftPen

public JRBoxPen getLeftPen()

Description copied from interface: JRLineBox

Gets the pen properties for the left border.

Specified by:

getLeftPen in interface JRLineBox

copyLeftPen

public void copyLeftPen(JRBoxPen leftPen)

Specified by:

copyLeftPen in interface JRLineBox

getBottomPen

public JRBoxPen getBottomPen()

Description copied from interface: JRLineBox

Gets the pen properties for the bottom border.

Specified by:

getBottomPen in interface JRLineBox

copyBottomPen

public void copyBottomPen(JRBoxPen bottomPen)

Specified by:

copyBottomPen in interface JRLineBox

getRightPen

public JRBoxPen getRightPen()

Description copied from interface: JRLineBox

Gets the pen properties for the right border.

Specified by:

getRightPen in interface JRLineBox

copyRightPen

public void copyRightPen(JRBoxPen rightPen)

Specified by:

copyRightPen in interface JRLineBox

getPadding

public Integer getPadding()

Description copied from interface: JRLineBox

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

Specified by:

getPadding in interface JRLineBox

getOwnPadding

public Integer getOwnPadding()

Specified by:

getOwnPadding in interface JRLineBox

setPadding

public void setPadding(int padding)

Description copied from interface: JRLineBox

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

Specified by:

setPadding in interface JRLineBox

setPadding

public void setPadding(Integer padding)

Specified by:

setPadding in interface JRLineBox

getTopPadding

public Integer getTopPadding()

Specified by:

getTopPadding in interface JRLineBox

getOwnTopPadding

public Integer getOwnTopPadding()

Specified by:

getOwnTopPadding in interface JRLineBox

setTopPadding

public void setTopPadding(int topPadding)

Specified by:

setTopPadding in interface JRLineBox

setTopPadding

public void setTopPadding(Integer topPadding)

Specified by:

setTopPadding in interface JRLineBox

getLeftPadding

public Integer getLeftPadding()

Specified by:

getLeftPadding in interface JRLineBox

getOwnLeftPadding

public Integer getOwnLeftPadding()

Specified by:

getOwnLeftPadding in interface JRLineBox

setLeftPadding

public void setLeftPadding(int leftPadding)

Specified by:

setLeftPadding in interface JRLineBox

setLeftPadding

public void setLeftPadding(Integer leftPadding)

Specified by:

setLeftPadding in interface JRLineBox

getBottomPadding

public Integer getBottomPadding()

Specified by:

getBottomPadding in interface JRLineBox

getOwnBottomPadding

public Integer getOwnBottomPadding()

Specified by:

getOwnBottomPadding in interface JRLineBox

setBottomPadding

public void setBottomPadding(int bottomPadding)

Specified by:

setBottomPadding in interface JRLineBox

setBottomPadding

public void setBottomPadding(Integer bottomPadding)

Specified by:

setBottomPadding in interface JRLineBox

getRightPadding

public Integer getRightPadding()

Specified by:

getRightPadding in interface JRLineBox

getOwnRightPadding

public Integer getOwnRightPadding()

Specified by:

getOwnRightPadding in interface JRLineBox

setRightPadding

public void setRightPadding(int rightPadding)

Specified by:

setRightPadding in interface JRLineBox

setRightPadding

public void setRightPadding(Integer rightPadding)

Specified by:

setRightPadding in interface JRLineBox

clone

public JRLineBox clone(JRBoxContainer boxContainer)

Specified by:

clone in interface JRLineBox

getEventSupport

public JRPropertyChangeSupport getEventSupport()

Description copied from interface: JRChangeEventsSupport

Returns the property change support object for this instance.

Specified by:

getEventSupport in interface JRChangeEventsSupport

Returns:

the property change support object for this instance

getHashCode

public int getHashCode()

Description copied from interface: Deduplicable

Returns a hash code to be used for the deduplicate map. The returned hash code should be consitent wiwh Deduplicable.isIdentical(Object), i.e. if two objects are identical they should have the same hash code.

Specified by:

getHashCode in interface Deduplicable

Returns:

deduplication hash code

isIdentical

public boolean isIdentical(Object object)

Description copied from interface: Deduplicable

Determines if this instance is identical to another object.

Specified by:

isIdentical in interface Deduplicable

Parameters:

object - the object to compare with this instance

Returns:

true if the two objects are identical and can be deduplicated