|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
An abstract representation of a report element. All report elements implement this interface. The interface contains constants and methods that apply to all report elements.
Field Summary | |
static byte |
MODE_OPAQUE
Specifies that the element is opaque. |
static byte |
MODE_TRANSPARENT
Specifies that the element is transparent. |
static byte |
POSITION_TYPE_FIX_RELATIVE_TO_BOTTOM
If the height of the parent report section is affected by elements that stretch, the current element will try to conserve the original distance between its bottom margin and the bottom of the band. |
static byte |
POSITION_TYPE_FIX_RELATIVE_TO_TOP
The element will simply ignore what happens to the other section elements and tries to conserve the y offset measured from the top of its parent report section. |
static byte |
POSITION_TYPE_FLOAT
The element will float in its parent section if it is pushed downwards by other elements fount above it. |
static byte |
STRETCH_TYPE_NO_STRETCH
The element preserves its original specified height. |
static byte |
STRETCH_TYPE_RELATIVE_TO_BAND_HEIGHT
The graphic element will adapt its height to match the new height of the report section it placed on, which has been affected by stretch. |
static byte |
STRETCH_TYPE_RELATIVE_TO_TALLEST_OBJECT
Users have the possibility to group the elements of a report section in multiple imbricate groups. |
Method Summary | |
void |
collectExpressions(JRExpressionCollector collector)
|
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 isPrintInFirstWholeBand)
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 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. |
void |
setRemoveLineWhenBlank(boolean isRemoveLineWhenBlank)
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 interface net.sf.jasperreports.engine.JRChild |
getCopy, writeXml |
Field Detail |
public static final byte POSITION_TYPE_FLOAT
public static final byte POSITION_TYPE_FIX_RELATIVE_TO_TOP
public static final byte POSITION_TYPE_FIX_RELATIVE_TO_BOTTOM
public static final byte MODE_OPAQUE
public static final byte MODE_TRANSPARENT
public static final byte STRETCH_TYPE_NO_STRETCH
public static final byte STRETCH_TYPE_RELATIVE_TO_TALLEST_OBJECT
public static final byte STRETCH_TYPE_RELATIVE_TO_BAND_HEIGHT
Method Detail |
public java.lang.String getKey()
public byte getPositionType()
public void setPositionType(byte positionType)
positionType
- a byte value that must be one of the position type constants in this classpublic byte getStretchType()
public void setStretchType(byte stretchType)
stretchType
- a byte value that must be one of the stretch type constants in this classpublic boolean isPrintRepeatedValues()
isRemoveLineWhenBlank()
,
isPrintInFirstWholeBand()
public void setPrintRepeatedValues(boolean isPrintRepeatedValues)
public byte getMode()
public void setMode(byte mode)
public int getX()
public void setX(int x)
public int getY()
public int getWidth()
public void setWidth(int width)
public int getHeight()
public boolean isRemoveLineWhenBlank()
public void setRemoveLineWhenBlank(boolean isRemoveLineWhenBlank)
public boolean isPrintInFirstWholeBand()
isPrintRepeatedValues()
public void setPrintInFirstWholeBand(boolean isPrintInFirstWholeBand)
isPrintRepeatedValues()
public boolean isPrintWhenDetailOverflows()
public void setPrintWhenDetailOverflows(boolean isPrintWhenDetailOverflows)
public java.awt.Color getForecolor()
public void setForecolor(java.awt.Color forecolor)
public java.awt.Color getBackcolor()
public void setBackcolor(java.awt.Color backcolor)
public JRExpression getPrintWhenExpression()
public JRGroup getPrintWhenGroupChanges()
isPrintRepeatedValues()
public JRElementGroup getElementGroup()
STRETCH_TYPE_RELATIVE_TO_TALLEST_OBJECT
public void collectExpressions(JRExpressionCollector collector)
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |