Package net.sf.jasperreports.engine
Interface JRGenericPrintElement
- All Superinterfaces:
JRCommonElement
,JRIdentifiable
,JRPrintElement
,JRPropertiesHolder
,JRStyleContainer
- All Known Implementing Classes:
JRBaseGenericPrintElement
,JRRecordedValuesGenericPrintElement
,JRTemplateGenericPrintElement
A generic print element.
Such an element has a type
and includes
a set of parameters.
Export handlers need to registered for the element's type and they are
responsible for producing export output for the element.
- Author:
- Lucian Chirita (lucianc@users.sourceforge.net)
- See Also:
-
Field Summary
Fields inherited from interface net.sf.jasperreports.engine.JRPrintElement
UNSET_PRINT_ELEMENT_ID, UNSET_SOURCE_ELEMENT_ID
-
Method Summary
Modifier and TypeMethodDescriptionReturns the type of this element.Returns the set of parameter names for this element.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
setParameterValue
(String name, Object value) Sets a parameter value.Methods inherited from interface net.sf.jasperreports.engine.JRCommonElement
getBackcolor, getForecolor, getMode, getOwnBackcolor, getOwnForecolor, getOwnMode, setBackcolor, setForecolor, setMode
Methods inherited from interface net.sf.jasperreports.engine.JRIdentifiable
getUUID
Methods inherited from interface net.sf.jasperreports.engine.JRPrintElement
accept, getHeight, getKey, getOrigin, getPrintElementId, getSourceElementId, getWidth, getX, getY, setHeight, setStyle, setUUID, setWidth, setX, setY
Methods inherited from interface net.sf.jasperreports.engine.JRPropertiesHolder
getParentProperties, getPropertiesMap, hasProperties
Methods inherited from interface net.sf.jasperreports.engine.JRStyleContainer
getDefaultStyleProvider, getStyle, getStyleName, getStyleNameReference
-
Method Details
-
getGenericType
JRGenericElementType getGenericType()Returns the type of this element.- Returns:
- the element type
-
getParameterNames
Returns the set of parameter names for this element.- Returns:
- the set of parameter names (as
String
s).
-
hasParameter
Determines whether the element includes a parameter having a given name.- Parameters:
name
- the parameter name- Returns:
- whether a parameter having the specified name exists in the element
-
getParameterValue
Returns the value of a parameter.- Parameters:
name
- the parameter name- Returns:
- the parameter value, or
null
if a parameter by the specified name does not exist.
-
setParameterValue
Sets a parameter value.- Parameters:
name
- the parameter namevalue
- the parameter value
-