|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectnet.sf.jasperreports.engine.base.JRBaseElement
public abstract class 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.
| 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(JRDefaultStyleProvider defaultStyleProvider)
|
protected |
JRBaseElement(JRElement element,
JRBaseObjectFactory factory)
Initializes basic properties of the element. |
| Method Summary | |
|---|---|
java.lang.Object |
clone()
|
java.lang.Object |
clone(JRElementGroup parentGroup)
|
java.awt.Color |
getBackcolor()
|
protected JRStyle |
getBaseStyle()
|
JRDefaultStyleProvider |
getDefaultStyleProvider()
|
JRElementGroup |
getElementGroup()
Indicates the logical group that the element belongs to. |
JRPropertyChangeSupport |
getEventSupport()
Returns the property change support object for this instance. |
java.awt.Color |
getForecolor()
|
int |
getHeight()
|
java.lang.String |
getKey()
Returns the string value that uniquely identifies the element. |
byte |
getMode()
Deprecated. Replaced by getModeValue(). |
ModeEnum |
getModeValue()
Returns the element transparency mode. |
java.awt.Color |
getOwnBackcolor()
|
java.awt.Color |
getOwnForecolor()
|
java.lang.Byte |
getOwnMode()
Deprecated. Replaced by getOwnModeValue(). |
ModeEnum |
getOwnModeValue()
|
JRPropertiesHolder |
getParentProperties()
Returns the parent properties holder, whose properties are used as defaults for this object. |
byte |
getPositionType()
Deprecated. Replaced by getPositionTypeValue(). |
PositionTypeEnum |
getPositionTypeValue()
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. |
JRPropertiesMap |
getPropertiesMap()
Returns this object's properties map. |
JRPropertyExpression[] |
getPropertyExpressions()
Returns the list of dynamic/expression-based properties for this report element. |
byte |
getStretchType()
Deprecated. Replaced by getStretchTypeValue(). |
StretchTypeEnum |
getStretchTypeValue()
Indicates the stretch type for the element |
JRStyle |
getStyle()
Returns this object's style. |
java.lang.String |
getStyleNameReference()
Returns the name of an external style which is to be used by this object. |
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 |
hasProperties()
Checks whether the object has any properties. |
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)
Deprecated. Replaced by setMode(ModeEnum). |
void |
setMode(java.lang.Byte mode)
Deprecated. Replaced by setMode(ModeEnum). |
void |
setMode(ModeEnum modeValue)
Sets the element transparency mode. |
void |
setPositionType(byte positionType)
Deprecated. Replaced by setPositionType(PositionTypeEnum). |
void |
setPositionType(PositionTypeEnum positionTypeValue)
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)
Deprecated. Replaced by setStretchType(StretchTypeEnum). |
void |
setStretchType(StretchTypeEnum stretchTypeValue)
Specifies how the engine should treat a missing image. |
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 |
|---|
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.JRVisitable |
|---|
visit |
| Field Detail |
|---|
public static final java.lang.String PROPERTY_POSITION_TYPE
public static final java.lang.String PROPERTY_PRINT_IN_FIRST_WHOLE_BAND
public static final java.lang.String PROPERTY_PRINT_REPEATED_VALUES
public static final java.lang.String PROPERTY_PRINT_WHEN_DETAIL_OVERFLOWS
public static final java.lang.String PROPERTY_REMOVE_LINE_WHEN_BLANK
public static final java.lang.String PROPERTY_STRETCH_TYPE
public static final java.lang.String PROPERTY_WIDTH
public static final java.lang.String PROPERTY_X
protected java.lang.String key
protected PositionTypeEnum positionTypeValue
protected StretchTypeEnum stretchTypeValue
protected boolean isPrintRepeatedValues
protected ModeEnum modeValue
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
protected JRDefaultStyleProvider defaultStyleProvider
protected JRStyle parentStyle
protected java.lang.String parentStyleNameReference
| Constructor Detail |
|---|
protected JRBaseElement(JRDefaultStyleProvider defaultStyleProvider)
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 process| Method Detail |
|---|
public JRDefaultStyleProvider getDefaultStyleProvider()
getDefaultStyleProvider in interface JRStyleContainerprotected JRStyle getBaseStyle()
public java.lang.String getKey()
JRElement
getKey in interface JRCommonElementgetKey in interface JRElementpublic byte getPositionType()
getPositionTypeValue().
getPositionType in interface JRElementpublic PositionTypeEnum getPositionTypeValue()
JRElement
getPositionTypeValue in interface JRElementpublic void setPositionType(byte positionType)
setPositionType(PositionTypeEnum).
setPositionType in interface JRElementpublic void setPositionType(PositionTypeEnum positionTypeValue)
JRElement
setPositionType in interface JRElementpositionTypeValue - the position typepublic byte getStretchType()
getStretchTypeValue().
getStretchType in interface JRElementpublic void setStretchType(byte stretchType)
setStretchType(StretchTypeEnum).
setStretchType in interface JRElementpublic StretchTypeEnum getStretchTypeValue()
JRElement
getStretchTypeValue in interface JRElementStretchTypeEnumpublic void setStretchType(StretchTypeEnum stretchTypeValue)
JRElement
setStretchType in interface JRElementstretchTypeValue - a value representing one of the stretch type constants in StretchTypeEnumpublic boolean isPrintRepeatedValues()
JRElement
isPrintRepeatedValues in interface JRElementJRElement.isRemoveLineWhenBlank(),
JRElement.isPrintInFirstWholeBand()public void setPrintRepeatedValues(boolean isPrintRepeatedValues)
setPrintRepeatedValues in interface JRElementpublic byte getMode()
getModeValue().
getMode in interface JRCommonElementpublic java.lang.Byte getOwnMode()
getOwnModeValue().
getOwnMode in interface JRCommonElementpublic ModeEnum getModeValue()
JRCommonElement
getModeValue in interface JRCommonElementpublic ModeEnum getOwnModeValue()
getOwnModeValue in interface JRCommonElementpublic void setMode(byte mode)
setMode(ModeEnum).
setMode in interface JRCommonElementpublic void setMode(java.lang.Byte mode)
setMode(ModeEnum).
setMode in interface JRCommonElementpublic void setMode(ModeEnum modeValue)
JRCommonElement
setMode in interface JRCommonElementpublic int getX()
JRElement
getX in interface JRElementpublic void setX(int x)
JRElement
setX in interface JRElementpublic int getY()
JRElement
getY in interface JRElementpublic int getWidth()
getWidth in interface JRCommonElementpublic void setWidth(int width)
setWidth in interface JRElementpublic int getHeight()
getHeight in interface JRCommonElementpublic boolean isRemoveLineWhenBlank()
JRElement
isRemoveLineWhenBlank in interface JRElementpublic void setRemoveLineWhenBlank(boolean isRemoveLine)
JRElement
setRemoveLineWhenBlank in interface JRElementpublic boolean isPrintInFirstWholeBand()
JRElement
isPrintInFirstWholeBand in interface JRElementJRElement.isPrintRepeatedValues()public void setPrintInFirstWholeBand(boolean isPrint)
JRElement
setPrintInFirstWholeBand in interface JRElementJRElement.isPrintRepeatedValues()public boolean isPrintWhenDetailOverflows()
JRElement
isPrintWhenDetailOverflows in interface JRElementpublic void setPrintWhenDetailOverflows(boolean isPrint)
JRElement
setPrintWhenDetailOverflows in interface JRElementpublic java.awt.Color getForecolor()
getForecolor in interface JRCommonElementpublic java.awt.Color getOwnForecolor()
getOwnForecolor in interface JRCommonElementpublic void setForecolor(java.awt.Color forecolor)
setForecolor in interface JRCommonElementpublic java.awt.Color getBackcolor()
getBackcolor in interface JRCommonElementpublic java.awt.Color getOwnBackcolor()
getOwnBackcolor in interface JRCommonElementpublic void setBackcolor(java.awt.Color backcolor)
setBackcolor in interface JRCommonElementpublic JRExpression getPrintWhenExpression()
JRElement
getPrintWhenExpression in interface JRElementpublic JRGroup getPrintWhenGroupChanges()
JRElement
getPrintWhenGroupChanges in interface JRElementJRElement.isPrintRepeatedValues()public JRElementGroup getElementGroup()
JRElement
getElementGroup in interface JRElementJRElement.STRETCH_TYPE_RELATIVE_TO_TALLEST_OBJECTpublic JRStyle getStyle()
JRStyleContainer
getStyle in interface JRStyleContainerpublic java.lang.String getStyleNameReference()
JRStyleContainertemplates and are resolved
at fill time.
This attribute is only effective if no direct style (as returned by getStyle()
is specified for this object.
getStyleNameReference in interface JRStyleContainerpublic JRPropertyChangeSupport getEventSupport()
JRChangeEventsSupport
getEventSupport in interface JRChangeEventsSupportpublic java.lang.Object clone()
clone in interface JRCloneableclone in class java.lang.Objectpublic java.lang.Object clone(JRElementGroup parentGroup)
clone in interface JRChildpublic boolean hasProperties()
JRPropertiesHolder
hasProperties in interface JRPropertiesHolderpublic JRPropertiesMap getPropertiesMap()
JRPropertiesHolder
getPropertiesMap in interface JRPropertiesHolderpublic JRPropertiesHolder getParentProperties()
JRPropertiesHolder
getParentProperties in interface JRPropertiesHoldernull if no parentpublic JRPropertyExpression[] getPropertyExpressions()
JRElement
getPropertyExpressions in interface JRElement
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||