net.sf.jasperreports.engine.fill

Class JRTemplateGenericPrintElement

java.lang.Object

net.sf.jasperreports.engine.fill.JRTemplatePrintElement

net.sf.jasperreports.engine.fill.JRTemplateGenericPrintElement

All Implemented Interfaces:

Serializable, JRCommonElement, JRGenericPrintElement, JRIdentifiable, JRPrintElement, JRPropertiesHolder, JRStyleContainer, VirtualizationSerializable

Direct Known Subclasses:

JRRecordedValuesGenericPrintElement

public class JRTemplateGenericPrintElement
extends JRTemplatePrintElement
implements JRGenericPrintElement

Implementation of JRGenericPrintElement that uses a JRTemplateGenericElement instance to store common attributes.

Author:

Lucian Chirita (lucianc@users.sourceforge.net)

See Also:

JRTemplateGenericPrintElement, Serialized Form

Field Summary

Fields inherited from class net.sf.jasperreports.engine.fill.JRTemplatePrintElement

EXCEPTION_MESSAGE_KEY_TEMPLATE_NOT_FOUND, template

Fields inherited from interface net.sf.jasperreports.engine.JRPrintElement

UNSET_PRINT_ELEMENT_ID, UNSET_SOURCE_ELEMENT_ID

Constructor Summary

Constructors

Constructor and Description
JRTemplateGenericPrintElement()
JRTemplateGenericPrintElement(JRTemplateGenericElement template) Deprecated. provide a source Id via JRTemplateGenericPrintElement(JRTemplateGenericElement, int)
JRTemplateGenericPrintElement(JRTemplateGenericElement template, int sourceElementId) Deprecated. replaced by JRTemplateGenericPrintElement(JRTemplateGenericElement, PrintElementOriginator)
JRTemplateGenericPrintElement(JRTemplateGenericElement template, int sourceElementId, int parameterCount) Deprecated. replaced by JRTemplateGenericPrintElement(JRTemplateGenericElement, PrintElementOriginator, int)
JRTemplateGenericPrintElement(JRTemplateGenericElement template, PrintElementOriginator originator) Creates a generic print element.
JRTemplateGenericPrintElement(JRTemplateGenericElement template, PrintElementOriginator originator, int parameterCount) Creates a generic print element.

Method Summary

Methods

Modifier and Type	Method and Description
<T> void	accept(PrintElementVisitor<T> visitor, T arg) Accepts a print element visitor.
JRGenericElementType	getGenericType() Returns the generic type specified by the element template.
Set<String>	getParameterNames() Returns the set of parameter names for this element.
Object	getParameterValue(String name) Returns the value of a parameter.
boolean	hasParameter(String name) Determines whether the element includes a parameter having a given name.
void	readVirtualized(VirtualizationInput in)
void	setParameterValue(String name, Object value) Sets a parameter value.
void	writeVirtualized(VirtualizationOutput out)

Methods inherited from class net.sf.jasperreports.engine.fill.JRTemplatePrintElement

getBackcolor, getDefaultLineColor, getDefaultStyleProvider, getForecolor, getHeight, getKey, getModeValue, getOrigin, getOwnBackcolor, getOwnForecolor, getOwnModeValue, getParentProperties, getPrintElementId, getPropertiesMap, getSourceElementId, getStyle, getStyleNameReference, getTemplate, getUUID, getWidth, getX, getY, hasProperties, setBackcolor, setForecolor, setHeight, setMode, setSourceElementId, setStyle, setTemplate, setUUID, setWidth, setX, setY, updateElementTemplate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.sf.jasperreports.engine.JRPrintElement

getHeight, getKey, getOrigin, getPrintElementId, getSourceElementId, getWidth, getX, getY, setHeight, setStyle, setUUID, setWidth, setX, setY

Methods inherited from interface net.sf.jasperreports.engine.JRCommonElement

getBackcolor, getForecolor, getModeValue, getOwnBackcolor, getOwnForecolor, getOwnModeValue, setBackcolor, setForecolor, setMode

Methods inherited from interface net.sf.jasperreports.engine.JRStyleContainer

getDefaultStyleProvider, getStyle, getStyleNameReference

Methods inherited from interface net.sf.jasperreports.engine.JRPropertiesHolder

getParentProperties, getPropertiesMap, hasProperties

Methods inherited from interface net.sf.jasperreports.engine.JRIdentifiable

getUUID

Constructor Detail

JRTemplateGenericPrintElement

public JRTemplateGenericPrintElement()

JRTemplateGenericPrintElement

public JRTemplateGenericPrintElement(JRTemplateGenericElement template)

Deprecated. provide a source Id via JRTemplateGenericPrintElement(JRTemplateGenericElement, int)

Creates a generic print element.

Parameters:

template - the template to use for the element

JRTemplateGenericPrintElement

public JRTemplateGenericPrintElement(JRTemplateGenericElement template,
                             int sourceElementId)

Deprecated. replaced by JRTemplateGenericPrintElement(JRTemplateGenericElement, PrintElementOriginator)

Creates a generic print element.

Parameters:

template - the template to use for the element

sourceElementId - the Id of the source element

JRTemplateGenericPrintElement

public JRTemplateGenericPrintElement(JRTemplateGenericElement template,
                             PrintElementOriginator originator)

Creates a generic print element.

Parameters:

template - the template to use for the element

originator -

JRTemplateGenericPrintElement

public JRTemplateGenericPrintElement(JRTemplateGenericElement template,
                             int sourceElementId,
                             int parameterCount)

Deprecated. replaced by JRTemplateGenericPrintElement(JRTemplateGenericElement, PrintElementOriginator, int)

Creates a generic print element.

Parameters:

template - the template to use for the element

sourceElementId - the Id of the source element

parameterCount - the number of parameters that the element will have

JRTemplateGenericPrintElement

public JRTemplateGenericPrintElement(JRTemplateGenericElement template,
                             PrintElementOriginator originator,
                             int parameterCount)

Creates a generic print element.

Parameters:

template - the template to use for the element

originator -

parameterCount - the number of parameters that the element will have

Method Detail

getGenericType

public JRGenericElementType getGenericType()

Returns the generic type specified by the element template.

Specified by:

getGenericType in interface JRGenericPrintElement

Returns:

the element type

See Also:

JRTemplateGenericElement.getGenericType()

getParameterNames

public Set<String> getParameterNames()

Description copied from interface: JRGenericPrintElement

Returns the set of parameter names for this element.

Specified by:

getParameterNames in interface JRGenericPrintElement

Returns:

the set of parameter names (as Strings).

getParameterValue

public Object getParameterValue(String name)

Description copied from interface: JRGenericPrintElement

Returns the value of a parameter.

Specified by:

getParameterValue in interface JRGenericPrintElement

Parameters:

name - the parameter name

Returns:

the parameter value, or null if a parameter by the specified name does not exist.

hasParameter

public boolean hasParameter(String name)

Description copied from interface: JRGenericPrintElement

Determines whether the element includes a parameter having a given name.

Specified by:

hasParameter in interface JRGenericPrintElement

Parameters:

name - the parameter name

Returns:

whether a parameter having the specified name exists in the element

setParameterValue

public void setParameterValue(String name,
                     Object value)

Description copied from interface: JRGenericPrintElement

Sets a parameter value.

Specified by:

setParameterValue in interface JRGenericPrintElement

Parameters:

name - the parameter name

value - the parameter value

accept

public <T> void accept(PrintElementVisitor<T> visitor,
              T arg)

Description copied from interface: JRPrintElement

Accepts a print element visitor.

The element calls the method that corresponds to the element type on the visitor.

Specified by:

accept in interface JRPrintElement

Overrides:

accept in class JRTemplatePrintElement

Type Parameters:

T - the type of the argument passed to the visit operation

Parameters:

visitor - the visitor objects

arg - the argument passed to the visit operation

writeVirtualized

public void writeVirtualized(VirtualizationOutput out)
                      throws IOException

Specified by:

writeVirtualized in interface VirtualizationSerializable

Overrides:

writeVirtualized in class JRTemplatePrintElement

Throws:

IOException

readVirtualized

public void readVirtualized(VirtualizationInput in)
                     throws IOException

Specified by:

readVirtualized in interface VirtualizationSerializable

Overrides:

readVirtualized in class JRTemplatePrintElement

Throws:

IOException