|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectnet.sf.jasperreports.engine.ElementDecorator
public abstract class ElementDecorator
| Field Summary |
|---|
| 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 | |
|---|---|
ElementDecorator(JRElement decorated)
|
|
| Method Summary | |
|---|---|
java.lang.Object |
clone()
|
java.lang.Object |
clone(JRElementGroup parentGroup)
|
void |
collectExpressions(JRExpressionCollector collector)
|
java.awt.Color |
getBackcolor()
|
JRDefaultStyleProvider |
getDefaultStyleProvider()
|
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()
Deprecated. |
ModeEnum |
getModeValue()
Returns the element transparency mode. |
java.awt.Color |
getOwnBackcolor()
|
java.awt.Color |
getOwnForecolor()
|
java.lang.Byte |
getOwnMode()
Deprecated. |
ModeEnum |
getOwnModeValue()
|
JRPropertiesHolder |
getParentProperties()
Returns the parent properties holder, whose properties are used as defaults for this object. |
byte |
getPositionType()
Deprecated. |
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. |
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. |
void |
setMode(java.lang.Byte mode)
Deprecated. |
void |
setMode(ModeEnum mode)
Sets the element transparency mode. |
void |
setPositionType(byte positionType)
Deprecated. |
void |
setPositionType(PositionTypeEnum 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)
Deprecated. |
void |
setStretchType(StretchTypeEnum stretchTypeEnum)
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. |
void |
visit(JRVisitor visitor)
|
| Methods inherited from class java.lang.Object |
|---|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public ElementDecorator(JRElement decorated)
| Method Detail |
|---|
public java.lang.Object clone()
clone in interface JRCloneableclone in class java.lang.Objectpublic void collectExpressions(JRExpressionCollector collector)
collectExpressions in interface JRElementpublic JRElementGroup getElementGroup()
JRElement
getElementGroup in interface JRElementJRElement.STRETCH_TYPE_RELATIVE_TO_TALLEST_OBJECTpublic java.lang.String getKey()
JRElement
getKey in interface JRCommonElementgetKey in interface JRElement@Deprecated public byte getPositionType()
getPositionType in interface JRElementpublic PositionTypeEnum getPositionTypeValue()
JRElement
getPositionTypeValue in interface JRElementpublic JRExpression getPrintWhenExpression()
JRElement
getPrintWhenExpression in interface JRElementpublic JRGroup getPrintWhenGroupChanges()
JRElement
getPrintWhenGroupChanges in interface JRElementJRElement.isPrintRepeatedValues()public JRPropertyExpression[] getPropertyExpressions()
JRElement
getPropertyExpressions in interface JRElement@Deprecated public byte getStretchType()
getStretchType in interface JRElementpublic StretchTypeEnum getStretchTypeValue()
JRElement
getStretchTypeValue in interface JRElementStretchTypeEnumpublic int getX()
JRElement
getX in interface JRElementpublic int getY()
JRElement
getY in interface JRElementpublic boolean isPrintInFirstWholeBand()
JRElement
isPrintInFirstWholeBand in interface JRElementJRElement.isPrintRepeatedValues()public boolean isPrintRepeatedValues()
JRElement
isPrintRepeatedValues in interface JRElementJRElement.isRemoveLineWhenBlank(),
JRElement.isPrintInFirstWholeBand()public boolean isPrintWhenDetailOverflows()
JRElement
isPrintWhenDetailOverflows in interface JRElementpublic boolean isRemoveLineWhenBlank()
JRElement
isRemoveLineWhenBlank in interface JRElement@Deprecated public void setPositionType(byte positionType)
setPositionType in interface JRElementpublic void setPositionType(PositionTypeEnum positionType)
JRElement
setPositionType in interface JRElementpositionType - the position typepublic void setPrintInFirstWholeBand(boolean isPrintInFirstWholeBand)
JRElement
setPrintInFirstWholeBand in interface JRElementJRElement.isPrintRepeatedValues()public void setPrintRepeatedValues(boolean isPrintRepeatedValues)
setPrintRepeatedValues in interface JRElementpublic void setPrintWhenDetailOverflows(boolean isPrintWhenDetailOverflows)
JRElement
setPrintWhenDetailOverflows in interface JRElementpublic void setRemoveLineWhenBlank(boolean isRemoveLineWhenBlank)
JRElement
setRemoveLineWhenBlank in interface JRElement@Deprecated public void setStretchType(byte stretchType)
setStretchType in interface JRElementpublic void setStretchType(StretchTypeEnum stretchTypeEnum)
JRElement
setStretchType in interface JRElementstretchTypeEnum - a value representing one of the stretch type constants in StretchTypeEnumpublic void setWidth(int width)
setWidth in interface JRElementpublic void setX(int x)
JRElement
setX in interface JRElementpublic java.lang.Object clone(JRElementGroup parentGroup)
clone in interface JRChildpublic void visit(JRVisitor visitor)
visit in interface JRVisitablepublic java.awt.Color getBackcolor()
getBackcolor in interface JRCommonElementpublic java.awt.Color getForecolor()
getForecolor in interface JRCommonElementpublic int getHeight()
getHeight in interface JRCommonElement@Deprecated public byte getMode()
getMode in interface JRCommonElementpublic ModeEnum getModeValue()
JRCommonElement
getModeValue in interface JRCommonElementpublic java.awt.Color getOwnBackcolor()
getOwnBackcolor in interface JRCommonElementpublic java.awt.Color getOwnForecolor()
getOwnForecolor in interface JRCommonElement@Deprecated public java.lang.Byte getOwnMode()
getOwnMode in interface JRCommonElementpublic ModeEnum getOwnModeValue()
getOwnModeValue in interface JRCommonElementpublic int getWidth()
getWidth in interface JRCommonElementpublic void setBackcolor(java.awt.Color backcolor)
setBackcolor in interface JRCommonElementpublic void setForecolor(java.awt.Color forecolor)
setForecolor in interface JRCommonElement@Deprecated public void setMode(byte mode)
setMode in interface JRCommonElement@Deprecated public void setMode(java.lang.Byte mode)
setMode in interface JRCommonElementpublic void setMode(ModeEnum mode)
JRCommonElement
setMode in interface JRCommonElementpublic JRDefaultStyleProvider getDefaultStyleProvider()
getDefaultStyleProvider in interface JRStyleContainerpublic 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 JRPropertiesHolder getParentProperties()
JRPropertiesHolder
getParentProperties in interface JRPropertiesHoldernull if no parentpublic JRPropertiesMap getPropertiesMap()
JRPropertiesHolder
getPropertiesMap in interface JRPropertiesHolderpublic boolean hasProperties()
JRPropertiesHolder
hasProperties in interface JRPropertiesHolder
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||