public class JRTemplatePrintElement extends java.lang.Object implements JRPrintElement, java.io.Serializable, VirtualizationSerializable
JRPrintElement
that uses
a JRTemplateElement
instance to
store common attributes.Modifier and Type | Field and Description |
---|---|
static java.lang.String |
EXCEPTION_MESSAGE_KEY_TEMPLATE_NOT_FOUND |
protected JRTemplateElement |
template |
UNSET_PRINT_ELEMENT_ID, UNSET_SOURCE_ELEMENT_ID
Modifier | Constructor and Description |
---|---|
|
JRTemplatePrintElement() |
protected |
JRTemplatePrintElement(JRTemplateElement element)
Deprecated.
provide a source Id via
JRTemplatePrintElement(JRTemplateElement, int) |
protected |
JRTemplatePrintElement(JRTemplateElement element,
int sourceElementId)
Deprecated.
|
protected |
JRTemplatePrintElement(JRTemplateElement element,
PrintElementOriginator originator) |
Modifier and Type | Method and Description |
---|---|
<T> void |
accept(PrintElementVisitor<T> visitor,
T arg)
Accepts a print element visitor.
|
java.awt.Color |
getBackcolor() |
java.awt.Color |
getDefaultLineColor() |
JRDefaultStyleProvider |
getDefaultStyleProvider() |
java.awt.Color |
getForecolor() |
int |
getHeight() |
java.lang.String |
getKey()
Returns a string key that can be used to identify the element.
|
ModeEnum |
getModeValue()
Returns the element transparency mode.
|
JROrigin |
getOrigin() |
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.
|
int |
getPrintElementId()
Returns a numerical Id that together with
JRPrintElement.getSourceElementId() uniquely identifies a print element. |
JRPropertiesMap |
getPropertiesMap()
Returns this object's properties map.
|
int |
getSourceElementId()
Returns a numerical Id associated to the fill element that generated
this print element.
|
JRStyle |
getStyle()
Returns this object's style.
|
java.lang.String |
getStyleNameReference()
Returns null as external style references are not allowed for print objects.
|
JRTemplateElement |
getTemplate() |
java.util.UUID |
getUUID() |
int |
getWidth() |
int |
getX() |
int |
getY() |
boolean |
hasProperties()
Checks whether the object has any properties.
|
void |
readVirtualized(VirtualizationInput in) |
void |
setBackcolor(java.awt.Color color) |
void |
setForecolor(java.awt.Color color) |
void |
setHeight(int height) |
void |
setMode(ModeEnum modeValue)
Sets the element transparency mode.
|
void |
setSourceElementId(int sourceElementId)
Sets the source/fill element Id for the print element.
|
void |
setStyle(JRStyle style) |
void |
setTemplate(JRTemplateElement template) |
void |
setUUID(java.util.UUID uuid) |
void |
setWidth(int width) |
void |
setX(int x) |
void |
setY(int y) |
protected void |
updateElementTemplate(JRTemplateElement elementTemplate)
Updates the template used by this element.
|
void |
writeVirtualized(VirtualizationOutput out) |
public static final java.lang.String EXCEPTION_MESSAGE_KEY_TEMPLATE_NOT_FOUND
protected JRTemplateElement template
public JRTemplatePrintElement()
protected JRTemplatePrintElement(JRTemplateElement element)
JRTemplatePrintElement(JRTemplateElement, int)
protected JRTemplatePrintElement(JRTemplateElement element, int sourceElementId)
JRTemplatePrintElement(JRTemplateElement, PrintElementOriginator)
element
- sourceElementId
- the Id of the source elementprotected JRTemplatePrintElement(JRTemplateElement element, PrintElementOriginator originator)
element
- originator
- protected void updateElementTemplate(JRTemplateElement elementTemplate)
elementTemplate
- the new element templatepublic JRDefaultStyleProvider getDefaultStyleProvider()
getDefaultStyleProvider
in interface JRStyleContainer
public java.util.UUID getUUID()
getUUID
in interface JRIdentifiable
public void setUUID(java.util.UUID uuid)
setUUID
in interface JRPrintElement
public JROrigin getOrigin()
getOrigin
in interface JRPrintElement
public JRStyle getStyle()
JRStyleContainer
getStyle
in interface JRStyleContainer
public void setStyle(JRStyle style)
setStyle
in interface JRPrintElement
public ModeEnum getModeValue()
JRCommonElement
getModeValue
in interface JRCommonElement
public ModeEnum getOwnModeValue()
getOwnModeValue
in interface JRCommonElement
public void setMode(ModeEnum modeValue)
JRCommonElement
setMode
in interface JRCommonElement
public int getX()
getX
in interface JRPrintElement
public void setX(int x)
setX
in interface JRPrintElement
public int getY()
getY
in interface JRPrintElement
public void setY(int y)
setY
in interface JRPrintElement
public int getWidth()
getWidth
in interface JRCommonElement
getWidth
in interface JRPrintElement
public void setWidth(int width)
setWidth
in interface JRPrintElement
public int getHeight()
getHeight
in interface JRCommonElement
getHeight
in interface JRPrintElement
public void setHeight(int height)
setHeight
in interface JRPrintElement
public java.awt.Color getForecolor()
getForecolor
in interface JRCommonElement
public java.awt.Color getOwnForecolor()
getOwnForecolor
in interface JRCommonElement
public void setForecolor(java.awt.Color color)
setForecolor
in interface JRCommonElement
public java.awt.Color getBackcolor()
getBackcolor
in interface JRCommonElement
public java.awt.Color getOwnBackcolor()
getOwnBackcolor
in interface JRCommonElement
public void setBackcolor(java.awt.Color color)
setBackcolor
in interface JRCommonElement
public JRTemplateElement getTemplate()
public void setTemplate(JRTemplateElement template)
public java.lang.String getKey()
JRPrintElement
When filling a report, the report element key
is copied to all print elements generated by a report element.
Note that this means that multiple elements having the same key can
appear on the same page/filled report.
getKey
in interface JRCommonElement
getKey
in interface JRPrintElement
public java.lang.String getStyleNameReference()
getStyleNameReference
in interface JRStyleContainer
public java.awt.Color getDefaultLineColor()
public boolean hasProperties()
JRPropertiesHolder
hasProperties
in interface JRPropertiesHolder
public JRPropertiesMap getPropertiesMap()
JRPropertiesHolder
getPropertiesMap
in interface JRPropertiesHolder
public JRPropertiesHolder getParentProperties()
JRPropertiesHolder
getParentProperties
in interface JRPropertiesHolder
null
if no parentpublic <T> void accept(PrintElementVisitor<T> visitor, T arg)
JRPrintElement
The element calls the method that corresponds to the element type on the visitor.
accept
in interface JRPrintElement
T
- the type of the argument passed to the visit operationvisitor
- the visitor objectsarg
- the argument passed to the visit operationpublic int getSourceElementId()
JRPrintElement
getSourceElementId
in interface JRPrintElement
public int getPrintElementId()
JRPrintElement
JRPrintElement.getSourceElementId()
uniquely identifies a print element.getPrintElementId
in interface JRPrintElement
PrintElementId
public void setSourceElementId(int sourceElementId)
sourceElementId
- getSourceElementId()
public void writeVirtualized(VirtualizationOutput out) throws java.io.IOException
writeVirtualized
in interface VirtualizationSerializable
java.io.IOException
public void readVirtualized(VirtualizationInput in) throws java.io.IOException
readVirtualized
in interface VirtualizationSerializable
java.io.IOException
© 2001-2014 TIBCO Software Inc. www.jaspersoft.com