net.sf.jasperreports.engine.base
Class JRBaseFrame

java.lang.Object
  extended by net.sf.jasperreports.engine.base.JRBaseElement
      extended by net.sf.jasperreports.engine.base.JRBaseFrame
All Implemented Interfaces:
java.io.Serializable, JRBox, JRChild, JRElement, JRElementGroup, JRFrame, JRStyleContainer

public class JRBaseFrame
extends JRBaseElement
implements JRFrame

Base read-only implementation of JRFrame.

Version:
$Id: JRBaseFrame.java 1229 2006-04-19 13:27:35 +0300 (Wed, 19 Apr 2006) teodord $
Author:
Lucian Chirita (lucianc@users.sourceforge.net)
See Also:
Serialized Form

Field Summary
protected  java.lang.Byte border
           
protected  java.awt.Color borderColor
           
protected  java.lang.Byte bottomBorder
           
protected  java.awt.Color bottomBorderColor
           
protected  java.lang.Integer bottomPadding
           
protected  java.util.List children
           
protected  java.lang.Byte leftBorder
           
protected  java.awt.Color leftBorderColor
           
protected  java.lang.Integer leftPadding
           
protected  java.lang.Integer 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
           
 
Fields inherited from class net.sf.jasperreports.engine.base.JRBaseElement
backcolor, defaultStyleProvider, elementGroup, forecolor, height, isPrintInFirstWholeBand, isPrintRepeatedValues, isPrintWhenDetailOverflows, isRemoveLineWhenBlank, key, mode, parentStyle, positionType, printWhenExpression, printWhenGroupChanges, stretchType, width, x, y
 
Fields inherited from interface net.sf.jasperreports.engine.JRElement
MODE_OPAQUE, MODE_TRANSPARENT, POSITION_TYPE_FIX_RELATIVE_TO_BOTTOM, POSITION_TYPE_FIX_RELATIVE_TO_TOP, POSITION_TYPE_FLOAT, STRETCH_TYPE_NO_STRETCH, STRETCH_TYPE_RELATIVE_TO_BAND_HEIGHT, STRETCH_TYPE_RELATIVE_TO_TALLEST_OBJECT
 
Constructor Summary
JRBaseFrame(JRFrame frame, JRBaseObjectFactory factory)
           
 
Method Summary
 void collectExpressions(JRExpressionCollector collector)
           
 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()
           
 java.util.List getChildren()
          Gets a list of all direct children elements or elements groups.
 JRChild getCopy(JRAbstractObjectFactory factory)
           
 JRElement getElementByKey(java.lang.String elementKey)
          Gets an element from this group, based on its element key.
 JRElement[] getElements()
          Gets an array containing all the elements and element groups in the hierarchy.
 byte getLeftBorder()
           
 java.awt.Color getLeftBorderColor()
           
 int getLeftPadding()
           
 byte getMode()
          Returns the element transparency mode.
 java.lang.Byte getOwnBorder()
           
 java.awt.Color getOwnBorderColor()
           
 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.Integer getOwnPadding()
           
 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 setBorder(java.lang.Byte border)
           
 void setBorderColor(java.awt.Color borderColor)
          Sets the default border color (can be overwritten by individual settings).
 void setBottomBorder(byte bottomBorder)
           
 void setBottomBorder(java.lang.Byte bottomBorder)
           
 void setBottomBorderColor(java.awt.Color bottomBorderColor)
           
 void setBottomPadding(int bottomPadding)
           
 void setBottomPadding(java.lang.Integer bottomPadding)
           
 void setLeftBorder(byte leftBorder)
           
 void setLeftBorder(java.lang.Byte leftBorder)
           
 void setLeftBorderColor(java.awt.Color leftBorderColor)
           
 void setLeftPadding(int leftPadding)
           
 void setLeftPadding(java.lang.Integer leftPadding)
           
 void setPadding(int padding)
          Sets the default padding in pixels (can be overwritten by individual settings).
 void setPadding(java.lang.Integer padding)
           
 void setRightBorder(byte rightBorder)
           
 void setRightBorder(java.lang.Byte rightBorder)
           
 void setRightBorderColor(java.awt.Color rightBorderColor)
           
 void setRightPadding(int rightPadding)
           
 void setRightPadding(java.lang.Integer rightPadding)
           
 void setTopBorder(byte topBorder)
          Sets the top border pen size.
 void setTopBorder(java.lang.Byte topBorder)
           
 void setTopBorderColor(java.awt.Color topBorderColor)
          Sets the top border color.
 void setTopPadding(int topPadding)
           
 void setTopPadding(java.lang.Integer topPadding)
           
 void writeXml(JRXmlWriter writer)
           
 
Methods inherited from class net.sf.jasperreports.engine.base.JRBaseElement
getBackcolor, getBaseStyle, getDefaultStyleProvider, getElementGroup, getForecolor, getHeight, getKey, getOwnBackcolor, getOwnForecolor, getOwnMode, getPositionType, getPrintWhenExpression, getPrintWhenGroupChanges, getStretchType, getStyle, getWidth, getX, getY, isPrintInFirstWholeBand, isPrintRepeatedValues, isPrintWhenDetailOverflows, isRemoveLineWhenBlank, setBackcolor, setForecolor, setMode, setMode, setPositionType, setPrintInFirstWholeBand, setPrintRepeatedValues, setPrintWhenDetailOverflows, setRemoveLineWhenBlank, setStretchType, setWidth, setX
 
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.JRElement
getBackcolor, getElementGroup, getForecolor, getHeight, getKey, getOwnBackcolor, getOwnForecolor, getOwnMode, getPositionType, getPrintWhenExpression, getPrintWhenGroupChanges, getStretchType, getWidth, getX, getY, isPrintInFirstWholeBand, isPrintRepeatedValues, isPrintWhenDetailOverflows, isRemoveLineWhenBlank, setBackcolor, setForecolor, setMode, setMode, setPositionType, setPrintInFirstWholeBand, setPrintRepeatedValues, setPrintWhenDetailOverflows, setRemoveLineWhenBlank, setStretchType, setWidth, setX
 
Methods inherited from interface net.sf.jasperreports.engine.JRStyleContainer
getDefaultStyleProvider, getStyle
 
Methods inherited from interface net.sf.jasperreports.engine.JRElementGroup
getElementGroup
 
Methods inherited from interface net.sf.jasperreports.engine.JRStyleContainer
getDefaultStyleProvider, getStyle
 

Field Detail

children

protected java.util.List children

border

protected java.lang.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 java.lang.Integer 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

JRBaseFrame

public JRBaseFrame(JRFrame frame,
                   JRBaseObjectFactory factory)
Method Detail

getElements

public JRElement[] getElements()
Description copied from interface: JRElementGroup
Gets an array containing all the elements and element groups in the hierarchy.

Specified by:
getElements in interface JRElementGroup

collectExpressions

public void collectExpressions(JRExpressionCollector collector)
Specified by:
collectExpressions in interface JRElement

getCopy

public JRChild getCopy(JRAbstractObjectFactory factory)
Specified by:
getCopy in interface JRChild

writeXml

public void writeXml(JRXmlWriter writer)
              throws java.io.IOException
Specified by:
writeXml in interface JRChild
Throws:
java.io.IOException

getChildren

public java.util.List getChildren()
Description copied from interface: JRElementGroup
Gets a list of all direct children elements or elements groups.

Specified by:
getChildren in interface JRElementGroup

getElementByKey

public JRElement getElementByKey(java.lang.String elementKey)
Description copied from interface: JRElementGroup
Gets an element from this group, based on its element key.

Specified by:
getElementByKey in interface JRElementGroup

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

getOwnBorder

public java.lang.Byte getOwnBorder()
Specified by:
getOwnBorder 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

setBorder

public void setBorder(java.lang.Byte border)
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

getOwnBorderColor

public java.awt.Color getOwnBorderColor()
Specified by:
getOwnBorderColor 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

getOwnPadding

public java.lang.Integer getOwnPadding()
Specified by:
getOwnPadding 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

setPadding

public void setPadding(java.lang.Integer padding)
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

setTopBorder

public void setTopBorder(java.lang.Byte topBorder)
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

setTopPadding

public void setTopPadding(java.lang.Integer 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

setLeftBorder

public void setLeftBorder(java.lang.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

setLeftPadding

public void setLeftPadding(java.lang.Integer 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

setBottomBorder

public void setBottomBorder(java.lang.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

setBottomPadding

public void setBottomPadding(java.lang.Integer 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

setRightBorder

public void setRightBorder(java.lang.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

setRightPadding

public void setRightPadding(java.lang.Integer rightPadding)
Specified by:
setRightPadding in interface JRBox

getMode

public byte getMode()
Description copied from interface: JRElement
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:
getMode in interface JRElement
Overrides:
getMode in class JRBaseElement
Returns:
MODE_OPAQUE or MODE_TRANSPARENT


© 2001-2006 JasperSoft Corporation www.jaspersoft.com