|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object net.sf.jasperreports.engine.ElementDecorator
public abstract class ElementDecorator
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. |
ModeEnum |
getModeValue()
Returns the element transparency mode. |
java.awt.Color |
getOwnBackcolor()
|
java.awt.Color |
getOwnForecolor()
|
ModeEnum |
getOwnModeValue()
|
JRPropertiesHolder |
getParentProperties()
Returns the parent properties holder, whose properties are used as defaults for this object. |
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. |
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. |
java.util.UUID |
getUUID()
|
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 JRCloneable
clone
in class java.lang.Object
public void collectExpressions(JRExpressionCollector collector)
collectExpressions
in interface JRElement
public JRElementGroup getElementGroup()
JRElement
getElementGroup
in interface JRElement
StretchTypeEnum.RELATIVE_TO_TALLEST_OBJECT
public java.util.UUID getUUID()
getUUID
in interface JRIdentifiable
public java.lang.String getKey()
JRElement
getKey
in interface JRCommonElement
getKey
in interface JRElement
public PositionTypeEnum getPositionTypeValue()
JRElement
getPositionTypeValue
in interface JRElement
public JRExpression getPrintWhenExpression()
JRElement
getPrintWhenExpression
in interface JRElement
public JRGroup getPrintWhenGroupChanges()
JRElement
getPrintWhenGroupChanges
in interface JRElement
JRElement.isPrintRepeatedValues()
public JRPropertyExpression[] getPropertyExpressions()
JRElement
getPropertyExpressions
in interface JRElement
public StretchTypeEnum getStretchTypeValue()
JRElement
getStretchTypeValue
in interface JRElement
StretchTypeEnum
public int getX()
JRElement
getX
in interface JRElement
public int getY()
JRElement
getY
in interface JRElement
public boolean isPrintInFirstWholeBand()
JRElement
isPrintInFirstWholeBand
in interface JRElement
JRElement.isPrintRepeatedValues()
public boolean isPrintRepeatedValues()
JRElement
isPrintRepeatedValues
in interface JRElement
JRElement.isRemoveLineWhenBlank()
,
JRElement.isPrintInFirstWholeBand()
public boolean isPrintWhenDetailOverflows()
JRElement
isPrintWhenDetailOverflows
in interface JRElement
public boolean isRemoveLineWhenBlank()
JRElement
isRemoveLineWhenBlank
in interface JRElement
@Deprecated public void setPositionType(byte positionType)
public void setPositionType(PositionTypeEnum positionType)
JRElement
setPositionType
in interface JRElement
positionType
- the position typepublic void setPrintInFirstWholeBand(boolean isPrintInFirstWholeBand)
JRElement
setPrintInFirstWholeBand
in interface JRElement
JRElement.isPrintRepeatedValues()
public void setPrintRepeatedValues(boolean isPrintRepeatedValues)
setPrintRepeatedValues
in interface JRElement
public void setPrintWhenDetailOverflows(boolean isPrintWhenDetailOverflows)
JRElement
setPrintWhenDetailOverflows
in interface JRElement
public void setRemoveLineWhenBlank(boolean isRemoveLineWhenBlank)
JRElement
setRemoveLineWhenBlank
in interface JRElement
@Deprecated public void setStretchType(byte stretchType)
public void setStretchType(StretchTypeEnum stretchTypeEnum)
JRElement
setStretchType
in interface JRElement
stretchTypeEnum
- a value representing one of the stretch type constants in StretchTypeEnum
public void setWidth(int width)
setWidth
in interface JRElement
public void setX(int x)
JRElement
setX
in interface JRElement
public java.lang.Object clone(JRElementGroup parentGroup)
clone
in interface JRChild
public void visit(JRVisitor visitor)
visit
in interface JRVisitable
public java.awt.Color getBackcolor()
getBackcolor
in interface JRCommonElement
public java.awt.Color getForecolor()
getForecolor
in interface JRCommonElement
public int getHeight()
getHeight
in interface JRCommonElement
public ModeEnum getModeValue()
JRCommonElement
getModeValue
in interface JRCommonElement
public java.awt.Color getOwnBackcolor()
getOwnBackcolor
in interface JRCommonElement
public java.awt.Color getOwnForecolor()
getOwnForecolor
in interface JRCommonElement
public ModeEnum getOwnModeValue()
getOwnModeValue
in interface JRCommonElement
public int getWidth()
getWidth
in interface JRCommonElement
public void setBackcolor(java.awt.Color backcolor)
setBackcolor
in interface JRCommonElement
public void setForecolor(java.awt.Color forecolor)
setForecolor
in interface JRCommonElement
@Deprecated public void setMode(byte mode)
@Deprecated public void setMode(java.lang.Byte mode)
public void setMode(ModeEnum mode)
JRCommonElement
setMode
in interface JRCommonElement
public JRDefaultStyleProvider getDefaultStyleProvider()
getDefaultStyleProvider
in interface JRStyleContainer
public JRStyle getStyle()
JRStyleContainer
getStyle
in interface JRStyleContainer
public java.lang.String getStyleNameReference()
JRStyleContainer
templates
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 JRStyleContainer
public JRPropertiesHolder getParentProperties()
JRPropertiesHolder
getParentProperties
in interface JRPropertiesHolder
null
if no parentpublic JRPropertiesMap getPropertiesMap()
JRPropertiesHolder
getPropertiesMap
in interface JRPropertiesHolder
public boolean hasProperties()
JRPropertiesHolder
hasProperties
in interface JRPropertiesHolder
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |