|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnet.sf.jasperreports.engine.base.JRBaseElement
This class provides a skeleton implementation for a report element. It mostly provides internal variables, representing the most common element properties, and their getter/setter methods. It also has a constructor for initializing these properties.
Field Summary | |
protected java.awt.Color |
backcolor
|
protected JRElementGroup |
elementGroup
|
protected java.awt.Color |
forecolor
|
protected int |
height
|
protected boolean |
isPrintInFirstWholeBand
|
protected boolean |
isPrintRepeatedValues
|
protected boolean |
isPrintWhenDetailOverflows
|
protected boolean |
isRemoveLineWhenBlank
|
protected java.lang.String |
key
|
protected byte |
mode
|
protected byte |
positionType
|
protected JRExpression |
printWhenExpression
|
protected JRGroup |
printWhenGroupChanges
|
protected byte |
stretchType
|
protected int |
width
|
protected int |
x
|
protected int |
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 | |
protected |
JRBaseElement()
Empty constructor. |
protected |
JRBaseElement(JRElement element,
JRBaseObjectFactory factory)
Initializes basic properties of the element. |
Method Summary | |
java.awt.Color |
getBackcolor()
|
JRElementGroup |
getElementGroup()
Indicates the logical group that the element belongs to. |
java.awt.Color |
getForecolor()
|
int |
getHeight()
|
java.lang.String |
getKey()
Returns the string value that uniquely identifies the element. |
byte |
getMode()
Returns the element transparency mode. |
byte |
getPositionType()
Returns the position type for the element |
JRExpression |
getPrintWhenExpression()
Gets the the expression that is evaluated in order to decide if the element should be displayed. |
JRGroup |
getPrintWhenGroupChanges()
Returns the group for which an element with a printRepeatedValues attribute set to true will be redisplayed even if the value has not changed. |
byte |
getStretchType()
Returns the stretch type for the element |
int |
getWidth()
|
int |
getX()
Gets the the section relative horizontal offset of the element top left corner. |
int |
getY()
Gets the the section relative vertical offset of the element top left corner. |
boolean |
isPrintInFirstWholeBand()
Returns true if an element with a printRepeatedValues attribute set to true will be redisplayed for every new page or column that is not an overflow from a previous page or column. |
boolean |
isPrintRepeatedValues()
Specifies if the element value will be printed for every iteration, even if its value has not changed. |
boolean |
isPrintWhenDetailOverflows()
If this is set to true, the element will be reprinted on the next page if the band does not fit in the current page. |
boolean |
isRemoveLineWhenBlank()
Returns true if the remaining blank space appearing when the value is not printed will be removed. |
void |
setBackcolor(java.awt.Color backcolor)
|
void |
setForecolor(java.awt.Color forecolor)
|
void |
setMode(byte mode)
Returns the element transparency mode. |
void |
setPositionType(byte positionType)
Sets the position type for the element. |
void |
setPrintInFirstWholeBand(boolean isPrint)
Specifies whether an element with a printRepeatedValues attribute set to true should be redisplayed for every new page or column that is not an overflow from a previous page or column. |
void |
setPrintRepeatedValues(boolean isPrintRepeatedValues)
|
void |
setPrintWhenDetailOverflows(boolean isPrint)
If this is set to true, the element will be reprinted on the next page if the band does not fit in the current page. |
void |
setRemoveLineWhenBlank(boolean isRemoveLine)
Specifies whether the remaining blank space appearing when the value is not printed will be removed. |
void |
setStretchType(byte stretchType)
Sets the stretch type for the element. |
void |
setWidth(int width)
|
void |
setX(int x)
Sets the the section relative horizontal offset of the element top left corner. |
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 |
collectExpressions |
Methods inherited from interface net.sf.jasperreports.engine.JRChild |
getCopy, writeXml |
Field Detail |
protected java.lang.String key
protected byte positionType
protected byte stretchType
protected boolean isPrintRepeatedValues
protected byte mode
protected int x
protected int y
protected int width
protected int height
protected boolean isRemoveLineWhenBlank
protected boolean isPrintInFirstWholeBand
protected boolean isPrintWhenDetailOverflows
protected java.awt.Color forecolor
protected java.awt.Color backcolor
protected JRExpression printWhenExpression
protected JRGroup printWhenGroupChanges
protected JRElementGroup elementGroup
Constructor Detail |
protected JRBaseElement()
protected JRBaseElement(JRElement element, JRBaseObjectFactory factory)
element
- an element whose properties are copied to this element. Usually it is a
JRDesignElement
that must be transformed into an
JRBaseElement at compile time.factory
- a factory used in the compile processMethod Detail |
public java.lang.String getKey()
JRElement
getKey
in interface JRElement
public byte getPositionType()
JRElement
getPositionType
in interface JRElement
public void setPositionType(byte positionType)
JRElement
setPositionType
in interface JRElement
positionType
- a byte value that must be one of the position type constants in this classpublic byte getStretchType()
JRElement
getStretchType
in interface JRElement
public void setStretchType(byte stretchType)
JRElement
setStretchType
in interface JRElement
stretchType
- a byte value that must be one of the stretch type constants in this classpublic boolean isPrintRepeatedValues()
JRElement
isPrintRepeatedValues
in interface JRElement
JRElement.isRemoveLineWhenBlank()
,
JRElement.isPrintInFirstWholeBand()
public void setPrintRepeatedValues(boolean isPrintRepeatedValues)
setPrintRepeatedValues
in interface JRElement
public byte getMode()
JRElement
getMode
in interface JRElement
public void setMode(byte mode)
JRElement
setMode
in interface JRElement
public int getX()
JRElement
getX
in interface JRElement
public void setX(int x)
JRElement
setX
in interface JRElement
public int getY()
JRElement
getY
in interface JRElement
public int getWidth()
getWidth
in interface JRElement
public void setWidth(int width)
setWidth
in interface JRElement
public int getHeight()
getHeight
in interface JRElement
public boolean isRemoveLineWhenBlank()
JRElement
isRemoveLineWhenBlank
in interface JRElement
public void setRemoveLineWhenBlank(boolean isRemoveLine)
JRElement
setRemoveLineWhenBlank
in interface JRElement
public boolean isPrintInFirstWholeBand()
JRElement
isPrintInFirstWholeBand
in interface JRElement
JRElement.isPrintRepeatedValues()
public void setPrintInFirstWholeBand(boolean isPrint)
JRElement
setPrintInFirstWholeBand
in interface JRElement
JRElement.isPrintRepeatedValues()
public boolean isPrintWhenDetailOverflows()
JRElement
isPrintWhenDetailOverflows
in interface JRElement
public void setPrintWhenDetailOverflows(boolean isPrint)
JRElement
setPrintWhenDetailOverflows
in interface JRElement
public java.awt.Color getForecolor()
getForecolor
in interface JRElement
public void setForecolor(java.awt.Color forecolor)
setForecolor
in interface JRElement
public java.awt.Color getBackcolor()
getBackcolor
in interface JRElement
public void setBackcolor(java.awt.Color backcolor)
setBackcolor
in interface JRElement
public JRExpression getPrintWhenExpression()
JRElement
getPrintWhenExpression
in interface JRElement
public JRGroup getPrintWhenGroupChanges()
JRElement
getPrintWhenGroupChanges
in interface JRElement
JRElement.isPrintRepeatedValues()
public JRElementGroup getElementGroup()
JRElement
getElementGroup
in interface JRElement
JRElement.STRETCH_TYPE_RELATIVE_TO_TALLEST_OBJECT
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |