net.sf.jasperreports.engine.fill

Class JRTemplateFrame

java.lang.Object

net.sf.jasperreports.engine.fill.JRTemplateElement

net.sf.jasperreports.engine.fill.JRTemplateFrame

All Implemented Interfaces:

java.io.Serializable, JRBox, JRBoxContainer, JRCommonElement, JRPropertiesHolder, JRStyleContainer

public class JRTemplateFrame
extends JRTemplateElement
implements JRBox, JRBoxContainer

Frame information shared by multiple print frame objects.

Version:

$Id: JRTemplateFrame.java 3939 2010-08-20 09:52:00Z teodord $

Author:

Lucian Chirita (lucianc@users.sourceforge.net)

See Also:

JRTemplatePrintFrame, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected JRLineBox	lineBox

Fields inherited from class net.sf.jasperreports.engine.fill.JRTemplateElement

defaultStyleProvider, origin, parentStyle

Constructor Summary

Constructors

Constructor and Description
JRTemplateFrame(JROrigin origin, JRDefaultStyleProvider defaultStyleProvider) Creates a template frame.
JRTemplateFrame(JROrigin origin, JRDefaultStyleProvider defaultStyleProvider, JRFillCellContents cell) Creates a template frame for a crosstab cell.
JRTemplateFrame(JROrigin origin, JRDefaultStyleProvider defaultStyleProvider, JRFillFrame frame) Creates a template frame for a frame.

Method Summary

Methods

Modifier and Type	Method and Description
void	copyBox(JRLineBox lineBox)
byte	getBorder() Deprecated. Replaced by getBox()
java.awt.Color	getBorderColor() Deprecated. Replaced by getBox()
byte	getBottomBorder() Deprecated. Replaced by getBox()
java.awt.Color	getBottomBorderColor() Deprecated. Replaced by getBox()
int	getBottomPadding() Deprecated. Replaced by getBox()
JRBox	getBox() Deprecated. Replaced by getLineBox()
java.awt.Color	getDefaultLineColor()
byte	getLeftBorder() Deprecated. Replaced by getBox()
java.awt.Color	getLeftBorderColor() Deprecated. Replaced by getBox()
int	getLeftPadding() Deprecated. Replaced by getBox()
JRLineBox	getLineBox()
ModeEnum	getModeValue() Returns the element transparency mode.
java.lang.Byte	getOwnBorder() Deprecated. Replaced by getBox()
java.awt.Color	getOwnBorderColor() Deprecated. Replaced by getBox()
java.lang.Byte	getOwnBottomBorder() Deprecated. Replaced by getBox()
java.awt.Color	getOwnBottomBorderColor() Deprecated. Replaced by getBox()
java.lang.Integer	getOwnBottomPadding() Deprecated. Replaced by getBox()
java.lang.Byte	getOwnLeftBorder() Deprecated. Replaced by getBox()
java.awt.Color	getOwnLeftBorderColor() Deprecated. Replaced by getBox()
java.lang.Integer	getOwnLeftPadding() Deprecated. Replaced by getBox()
java.lang.Integer	getOwnPadding() Deprecated. Replaced by getBox()
java.lang.Byte	getOwnRightBorder() Deprecated. Replaced by getBox()
java.awt.Color	getOwnRightBorderColor() Deprecated. Replaced by getBox()
java.lang.Integer	getOwnRightPadding() Deprecated. Replaced by getBox()
java.lang.Byte	getOwnTopBorder() Deprecated. Replaced by getBox()
java.awt.Color	getOwnTopBorderColor() Deprecated. Replaced by getBox()
java.lang.Integer	getOwnTopPadding() Deprecated. Replaced by getBox()
int	getPadding() Deprecated. Replaced by getBox()
byte	getRightBorder() Deprecated. Replaced by getBox()
java.awt.Color	getRightBorderColor() Deprecated. Replaced by getBox()
int	getRightPadding() Deprecated. Replaced by getBox()
byte	getTopBorder() Deprecated. Replaced by getBox()
java.awt.Color	getTopBorderColor() Deprecated. Replaced by getBox()
int	getTopPadding() Deprecated. Replaced by getBox()
void	setBorder(byte border) Deprecated. Replaced by getBox()
void	setBorder(java.lang.Byte border) Deprecated. Replaced by getBox()
void	setBorderColor(java.awt.Color borderColor) Deprecated. Replaced by getBox()
void	setBottomBorder(byte bottomBorder) Deprecated. Replaced by getBox()
void	setBottomBorder(java.lang.Byte bottomBorder) Deprecated. Replaced by getBox()
void	setBottomBorderColor(java.awt.Color bottomBorderColor) Deprecated. Replaced by getBox()
void	setBottomPadding(int bottomPadding) Deprecated. Replaced by getBox()
void	setBottomPadding(java.lang.Integer bottomPadding) Deprecated. Replaced by getBox()
void	setBox(JRBox box) Deprecated. Replaced by copyBox(JRLineBox)
void	setLeftBorder(byte leftBorder) Deprecated. Replaced by getBox()
void	setLeftBorder(java.lang.Byte leftBorder) Deprecated. Replaced by getBox()
void	setLeftBorderColor(java.awt.Color leftBorderColor) Deprecated. Replaced by getBox()
void	setLeftPadding(int leftPadding) Deprecated. Replaced by getBox()
void	setLeftPadding(java.lang.Integer leftPadding) Deprecated. Replaced by getBox()
void	setPadding(int padding) Deprecated. Replaced by getBox()
void	setPadding(java.lang.Integer padding) Deprecated. Replaced by getBox()
void	setRightBorder(byte rightBorder) Deprecated. Replaced by getBox()
void	setRightBorder(java.lang.Byte rightBorder) Deprecated. Replaced by getBox()
void	setRightBorderColor(java.awt.Color rightBorderColor) Deprecated. Replaced by getBox()
void	setRightPadding(int rightPadding) Deprecated. Replaced by getBox()
void	setRightPadding(java.lang.Integer rightPadding) Deprecated. Replaced by getBox()
void	setTopBorder(byte topBorder) Deprecated. Replaced by getBox()
void	setTopBorder(java.lang.Byte topBorder) Deprecated. Replaced by getBox()
void	setTopBorderColor(java.awt.Color topBorderColor) Deprecated. Replaced by getBox()
void	setTopPadding(int topPadding) Deprecated. Replaced by getBox()
void	setTopPadding(java.lang.Integer topPadding) Deprecated. Replaced by getBox()

Methods inherited from class net.sf.jasperreports.engine.fill.JRTemplateElement

getBackcolor, getBaseStyle, getDefaultStyleProvider, getForecolor, getHeight, getId, getKey, getMode, getOrigin, getOwnBackcolor, getOwnForecolor, getOwnMode, getOwnModeValue, getParentProperties, getPropertiesMap, getStyle, getStyleNameReference, getWidth, hasProperties, setBackcolor, setElement, setForecolor, setKey, setMode, setMode, setMode, setStyle

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.jasperreports.engine.JRStyleContainer

getDefaultStyleProvider, getStyle, getStyleNameReference

Field Detail

lineBox

protected JRLineBox lineBox

Constructor Detail

JRTemplateFrame

public JRTemplateFrame(JROrigin origin,
               JRDefaultStyleProvider defaultStyleProvider,
               JRFillCellContents cell)

Creates a template frame for a crosstab cell.

Parameters:

cell - the cell

JRTemplateFrame

public JRTemplateFrame(JROrigin origin,
               JRDefaultStyleProvider defaultStyleProvider,
               JRFillFrame frame)

Creates a template frame for a frame.

Parameters:

frame - the frame

JRTemplateFrame

public JRTemplateFrame(JROrigin origin,
               JRDefaultStyleProvider defaultStyleProvider)

Creates a template frame.

Parameters:

origin - the origin of the elements that will use this template

defaultStyleProvider - the default style provider to use for this template

Method Detail

getBox

public JRBox getBox()

Deprecated. Replaced by getLineBox()

getLineBox

public JRLineBox getLineBox()

Specified by:

getLineBox in interface JRBoxContainer

setBox

public void setBox(JRBox box)

Deprecated. Replaced by copyBox(JRLineBox)

copyBox

public void copyBox(JRLineBox lineBox)

getModeValue

public ModeEnum getModeValue()

Description copied from interface: JRCommonElement

Returns the element transparency mode. The default value depends on the type of the report element. Graphic elements like rectangles and lines are opaque by default, but the images are transparent. Both static texts and text fields are transparent by default, and so are the subreport elements.

Specified by:

getModeValue in interface JRCommonElement

Overrides:

getModeValue in class JRTemplateElement

getDefaultLineColor

public java.awt.Color getDefaultLineColor()

Specified by:

getDefaultLineColor in interface JRBoxContainer

getBorder

public byte getBorder()

Deprecated. Replaced by getBox()

Specified by:

getBorder in interface JRBox

getOwnBorder

public java.lang.Byte getOwnBorder()

Deprecated. Replaced by getBox()

Specified by:

getOwnBorder in interface JRBox

setBorder

public void setBorder(byte border)

Deprecated. Replaced by getBox()

Specified by:

setBorder in interface JRBox

setBorder

public void setBorder(java.lang.Byte border)

Deprecated. Replaced by getBox()

Specified by:

setBorder in interface JRBox

getBorderColor

public java.awt.Color getBorderColor()

Deprecated. Replaced by getBox()

Specified by:

getBorderColor in interface JRBox

getOwnBorderColor

public java.awt.Color getOwnBorderColor()

Deprecated. Replaced by getBox()

Specified by:

getOwnBorderColor in interface JRBox

setBorderColor

public void setBorderColor(java.awt.Color borderColor)

Deprecated. Replaced by getBox()

Specified by:

setBorderColor in interface JRBox

getPadding

public int getPadding()

Deprecated. Replaced by getBox()

Specified by:

getPadding in interface JRBox

getOwnPadding

public java.lang.Integer getOwnPadding()

Deprecated. Replaced by getBox()

Specified by:

getOwnPadding in interface JRBox

setPadding

public void setPadding(int padding)

Deprecated. Replaced by getBox()

Specified by:

setPadding in interface JRBox

setPadding

public void setPadding(java.lang.Integer padding)

Deprecated. Replaced by getBox()

Specified by:

setPadding in interface JRBox

getTopBorder

public byte getTopBorder()

Deprecated. Replaced by getBox()

Specified by:

getTopBorder in interface JRBox

getOwnTopBorder

public java.lang.Byte getOwnTopBorder()

Deprecated. Replaced by getBox()

Specified by:

getOwnTopBorder in interface JRBox

setTopBorder

public void setTopBorder(byte topBorder)

Deprecated. Replaced by getBox()

Specified by:

setTopBorder in interface JRBox

setTopBorder

public void setTopBorder(java.lang.Byte topBorder)

Deprecated. Replaced by getBox()

Specified by:

setTopBorder in interface JRBox

getTopBorderColor

public java.awt.Color getTopBorderColor()

Deprecated. Replaced by getBox()

Specified by:

getTopBorderColor in interface JRBox

getOwnTopBorderColor

public java.awt.Color getOwnTopBorderColor()

Deprecated. Replaced by getBox()

Specified by:

getOwnTopBorderColor in interface JRBox

setTopBorderColor

public void setTopBorderColor(java.awt.Color topBorderColor)

Deprecated. Replaced by getBox()

Specified by:

setTopBorderColor in interface JRBox

getTopPadding

public int getTopPadding()

Deprecated. Replaced by getBox()

Specified by:

getTopPadding in interface JRBox

getOwnTopPadding

public java.lang.Integer getOwnTopPadding()

Deprecated. Replaced by getBox()

Specified by:

getOwnTopPadding in interface JRBox

setTopPadding

public void setTopPadding(int topPadding)

Deprecated. Replaced by getBox()

Specified by:

setTopPadding in interface JRBox

setTopPadding

public void setTopPadding(java.lang.Integer topPadding)

Deprecated. Replaced by getBox()

Specified by:

setTopPadding in interface JRBox

getLeftBorder

public byte getLeftBorder()

Deprecated. Replaced by getBox()

Specified by:

getLeftBorder in interface JRBox

getOwnLeftBorder

public java.lang.Byte getOwnLeftBorder()

Deprecated. Replaced by getBox()

Specified by:

getOwnLeftBorder in interface JRBox

setLeftBorder

public void setLeftBorder(byte leftBorder)

Deprecated. Replaced by getBox()

Specified by:

setLeftBorder in interface JRBox

setLeftBorder

public void setLeftBorder(java.lang.Byte leftBorder)

Deprecated. Replaced by getBox()

Specified by:

setLeftBorder in interface JRBox

getLeftBorderColor

public java.awt.Color getLeftBorderColor()

Deprecated. Replaced by getBox()

Specified by:

getLeftBorderColor in interface JRBox

getOwnLeftBorderColor

public java.awt.Color getOwnLeftBorderColor()

Deprecated. Replaced by getBox()

Specified by:

getOwnLeftBorderColor in interface JRBox

setLeftBorderColor

public void setLeftBorderColor(java.awt.Color leftBorderColor)

Deprecated. Replaced by getBox()

Specified by:

setLeftBorderColor in interface JRBox

getLeftPadding

public int getLeftPadding()

Deprecated. Replaced by getBox()

Specified by:

getLeftPadding in interface JRBox

getOwnLeftPadding

public java.lang.Integer getOwnLeftPadding()

Deprecated. Replaced by getBox()

Specified by:

getOwnLeftPadding in interface JRBox

setLeftPadding

public void setLeftPadding(int leftPadding)

Deprecated. Replaced by getBox()

Specified by:

setLeftPadding in interface JRBox

setLeftPadding

public void setLeftPadding(java.lang.Integer leftPadding)

Deprecated. Replaced by getBox()

Specified by:

setLeftPadding in interface JRBox

getBottomBorder

public byte getBottomBorder()

Deprecated. Replaced by getBox()

Specified by:

getBottomBorder in interface JRBox

getOwnBottomBorder

public java.lang.Byte getOwnBottomBorder()

Deprecated. Replaced by getBox()

Specified by:

getOwnBottomBorder in interface JRBox

setBottomBorder

public void setBottomBorder(byte bottomBorder)

Deprecated. Replaced by getBox()

Specified by:

setBottomBorder in interface JRBox

setBottomBorder

public void setBottomBorder(java.lang.Byte bottomBorder)

Deprecated. Replaced by getBox()

Specified by:

setBottomBorder in interface JRBox

getBottomBorderColor

public java.awt.Color getBottomBorderColor()

Deprecated. Replaced by getBox()

Specified by:

getBottomBorderColor in interface JRBox

getOwnBottomBorderColor

public java.awt.Color getOwnBottomBorderColor()

Deprecated. Replaced by getBox()

Specified by:

getOwnBottomBorderColor in interface JRBox

setBottomBorderColor

public void setBottomBorderColor(java.awt.Color bottomBorderColor)

Deprecated. Replaced by getBox()

Specified by:

setBottomBorderColor in interface JRBox

getBottomPadding

public int getBottomPadding()

Deprecated. Replaced by getBox()

Specified by:

getBottomPadding in interface JRBox

getOwnBottomPadding

public java.lang.Integer getOwnBottomPadding()

Deprecated. Replaced by getBox()

Specified by:

getOwnBottomPadding in interface JRBox

setBottomPadding

public void setBottomPadding(int bottomPadding)

Deprecated. Replaced by getBox()

Specified by:

setBottomPadding in interface JRBox

setBottomPadding

public void setBottomPadding(java.lang.Integer bottomPadding)

Deprecated. Replaced by getBox()

Specified by:

setBottomPadding in interface JRBox

getRightBorder

public byte getRightBorder()

Deprecated. Replaced by getBox()

Specified by:

getRightBorder in interface JRBox

getOwnRightBorder

public java.lang.Byte getOwnRightBorder()

Deprecated. Replaced by getBox()

Specified by:

getOwnRightBorder in interface JRBox

setRightBorder

public void setRightBorder(byte rightBorder)

Deprecated. Replaced by getBox()

Specified by:

setRightBorder in interface JRBox

setRightBorder

public void setRightBorder(java.lang.Byte rightBorder)

Deprecated. Replaced by getBox()

Specified by:

setRightBorder in interface JRBox

getRightBorderColor

public java.awt.Color getRightBorderColor()

Deprecated. Replaced by getBox()

Specified by:

getRightBorderColor in interface JRBox

getOwnRightBorderColor

public java.awt.Color getOwnRightBorderColor()

Deprecated. Replaced by getBox()

Specified by:

getOwnRightBorderColor in interface JRBox

setRightBorderColor

public void setRightBorderColor(java.awt.Color rightBorderColor)

Deprecated. Replaced by getBox()

Specified by:

setRightBorderColor in interface JRBox

getRightPadding

public int getRightPadding()

Deprecated. Replaced by getBox()

Specified by:

getRightPadding in interface JRBox

getOwnRightPadding

public java.lang.Integer getOwnRightPadding()

Deprecated. Replaced by getBox()

Specified by:

getOwnRightPadding in interface JRBox

setRightPadding

public void setRightPadding(int rightPadding)

Deprecated. Replaced by getBox()

Specified by:

setRightPadding in interface JRBox

setRightPadding

public void setRightPadding(java.lang.Integer rightPadding)

Deprecated. Replaced by getBox()

Specified by:

setRightPadding in interface JRBox