|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface JRElement
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)
|
JRElementGroup |
getElementGroup()
Indicates the logical group that the element belongs to. |
int |
getHeight()
|
java.lang.String |
getKey()
Returns the string value that uniquely identifies the element. |
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)
Sets the element transparency mode. |
void |
setMode(java.lang.Byte 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 |
---|
clone |
Methods inherited from interface net.sf.jasperreports.engine.JRVisitable |
---|
visit |
Methods inherited from interface net.sf.jasperreports.engine.JRCloneable |
---|
clone |
Methods inherited from interface net.sf.jasperreports.engine.JRCommonElement |
---|
getBackcolor, getForecolor, getMode, getOwnBackcolor, getOwnForecolor, getOwnMode |
Methods inherited from interface net.sf.jasperreports.engine.JRStyleContainer |
---|
getDefaultStyleProvider, getStyle, getStyleNameReference |
Methods inherited from interface net.sf.jasperreports.engine.JRPropertiesHolder |
---|
getParentProperties, getPropertiesMap, hasProperties |
Field Detail |
---|
static final byte POSITION_TYPE_FLOAT
static final byte POSITION_TYPE_FIX_RELATIVE_TO_TOP
static final byte POSITION_TYPE_FIX_RELATIVE_TO_BOTTOM
static final byte MODE_OPAQUE
static final byte MODE_TRANSPARENT
static final byte STRETCH_TYPE_NO_STRETCH
static final byte STRETCH_TYPE_RELATIVE_TO_TALLEST_OBJECT
static final byte STRETCH_TYPE_RELATIVE_TO_BAND_HEIGHT
Method Detail |
---|
java.lang.String getKey()
getKey
in interface JRCommonElement
byte getPositionType()
void setPositionType(byte positionType)
positionType
- a byte value that must be one of the position type constants in this classbyte getStretchType()
void setStretchType(byte stretchType)
stretchType
- a byte value that must be one of the stretch type constants in this classboolean isPrintRepeatedValues()
isRemoveLineWhenBlank()
,
isPrintInFirstWholeBand()
void setPrintRepeatedValues(boolean isPrintRepeatedValues)
void setMode(byte mode)
void setMode(java.lang.Byte mode)
int getX()
void setX(int x)
int getY()
int getWidth()
void setWidth(int width)
int getHeight()
boolean isRemoveLineWhenBlank()
void setRemoveLineWhenBlank(boolean isRemoveLineWhenBlank)
boolean isPrintInFirstWholeBand()
isPrintRepeatedValues()
void setPrintInFirstWholeBand(boolean isPrintInFirstWholeBand)
isPrintRepeatedValues()
boolean isPrintWhenDetailOverflows()
void setPrintWhenDetailOverflows(boolean isPrintWhenDetailOverflows)
void setForecolor(java.awt.Color forecolor)
void setBackcolor(java.awt.Color backcolor)
JRExpression getPrintWhenExpression()
JRGroup getPrintWhenGroupChanges()
isPrintRepeatedValues()
JRElementGroup getElementGroup()
STRETCH_TYPE_RELATIVE_TO_TALLEST_OBJECT
void collectExpressions(JRExpressionCollector collector)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |