JRBasePrintFrame (JasperReports 4.0.2 API)

java.lang.Object
- net.sf.jasperreports.engine.base.JRBasePrintElement
- - net.sf.jasperreports.engine.base.JRBasePrintFrame

All Implemented Interfaces:

java.io.Serializable, JRBox, JRBoxContainer, JRCommonElement, JRPrintElement, JRPrintFrame, JRPropertiesHolder, JRStyleContainer
```
public class JRBasePrintFrame
extends JRBasePrintElement
implements JRPrintFrame
```
Base implementation of JRPrintFrame.

Version:

$Id: JRBasePrintFrame.java 3991 2010-10-12 20:10:55Z lucianc $

Author:

Lucian Chirita (lucianc@users.sourceforge.net)

See Also:

Serialized Form

Field Summary
- Fields inherited from class net.sf.jasperreports.engine.base.JRBasePrintElement
  backcolor, defaultStyleProvider, forecolor, height, key, modeValue, origin, style, width, x, y

Constructor Summary

Constructors
Constructor and Description

JRBasePrintFrame(JRDefaultStyleProvider defaultStyleProvider)

Constructors
Constructor and Description
`JRBasePrintFrame(JRDefaultStyleProvider defaultStyleProvider)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`<T> void`	`accept(PrintElementVisitor<T> visitor, T arg)` Accepts a print element visitor.
`void`	`addElement(JRPrintElement element)`
`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()`
`java.util.List`	`getElements()` Returns the list of print elements contained in the frame.
`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.base.JRBasePrintElement
getBackcolor, getDefaultStyleProvider, getForecolor, getHeight, getKey, getMode, getOrigin, getOwnBackcolor, getOwnForecolor, getOwnMode, getOwnModeValue, getParentProperties, getPropertiesMap, getStyle, getStyleNameReference, getWidth, getX, getY, hasProperties, setBackcolor, setForecolor, setHeight, setKey, setMode, setMode, setMode, setOrigin, setStyle, setWidth, setX, setY

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.JRPrintElement
getHeight, getKey, getOrigin, getWidth, getX, getY, setHeight, setStyle, setWidth, setX, setY

Methods inherited from interface net.sf.jasperreports.engine.JRCommonElement
getBackcolor, getForecolor, getMode, getOwnBackcolor, getOwnForecolor, getOwnMode, getOwnModeValue, setBackcolor, setForecolor, setMode, setMode, setMode

Methods inherited from interface net.sf.jasperreports.engine.JRStyleContainer
getDefaultStyleProvider, getStyle, getStyleNameReference

Methods inherited from interface net.sf.jasperreports.engine.JRPropertiesHolder
getParentProperties, getPropertiesMap, hasProperties

- Constructor Detail
  - JRBasePrintFrame
```
public JRBasePrintFrame(JRDefaultStyleProvider defaultStyleProvider)
```
- Method Detail
  - 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 JRBasePrintElement
  - setBox
```
public void setBox(JRBox box)
```
    Deprecated. Replaced by copyBox(JRLineBox)
  - copyBox
```
public void copyBox(JRLineBox lineBox)
```
  - getBox
```
public JRBox getBox()
```
    Deprecated. Replaced by getLineBox()
  - getLineBox
```
public JRLineBox getLineBox()
```
    Specified by:
    
    getLineBox in interface JRBoxContainer
  - addElement
```
public void addElement(JRPrintElement element)
```
  - getElements
```
public java.util.List getElements()
```
    Description copied from interface: JRPrintFrame
    
    Returns the list of print elements contained in the frame.
    
    Specified by:
    
    getElements in interface JRPrintFrame
    
    Returns:
    
    the list of sub print elements
  - 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
  - getDefaultLineColor
```
public java.awt.Color getDefaultLineColor()
```
    Specified by:
    
    getDefaultLineColor in interface JRBoxContainer
  - accept
```
public <T> void accept(PrintElementVisitor<T> visitor,
                       T arg)
```
    Description copied from interface: JRPrintElement
    
    Accepts a print element visitor.
    The element calls the method that corresponds to the element type on the visitor.
    
    Specified by:
    
    accept in interface JRPrintElement
    
    Overrides:
    
    accept in class JRBasePrintElement
    
    Type Parameters:
    
    T - the type of the argument passed to the visit operation
    
    Parameters:
    
    visitor - the visitor objects
    
    arg - the argument passed to the visit operation

Class JRBasePrintFrame

Field Summary

Fields inherited from class net.sf.jasperreports.engine.base.JRBasePrintElement

Constructor Summary

Method Summary

Methods inherited from class net.sf.jasperreports.engine.base.JRBasePrintElement

Methods inherited from class java.lang.Object

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

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

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

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

Constructor Detail

JRBasePrintFrame

Method Detail

getModeValue

setBox

copyBox

getBox

getLineBox

addElement

getElements

getBorder

getOwnBorder

setBorder

setBorder

getBorderColor

getOwnBorderColor

setBorderColor

getPadding

getOwnPadding

setPadding

setPadding

getTopBorder

getOwnTopBorder

setTopBorder

setTopBorder

getTopBorderColor

getOwnTopBorderColor

setTopBorderColor

getTopPadding

getOwnTopPadding

setTopPadding

setTopPadding

getLeftBorder

getOwnLeftBorder

setLeftBorder

setLeftBorder

getLeftBorderColor

getOwnLeftBorderColor

setLeftBorderColor

getLeftPadding

getOwnLeftPadding

setLeftPadding

setLeftPadding

getBottomBorder

getOwnBottomBorder

setBottomBorder

setBottomBorder

getBottomBorderColor

getOwnBottomBorderColor

setBottomBorderColor

getBottomPadding

getOwnBottomPadding

setBottomPadding

setBottomPadding

getRightBorder

getOwnRightBorder

setRightBorder

setRightBorder

getRightBorderColor

getOwnRightBorderColor

setRightBorderColor

getRightPadding

getOwnRightPadding

setRightPadding

setRightPadding

getDefaultLineColor

accept