Package net.sf.jasperreports.engine.design

Class JRDesignGenericElement

java.lang.Object

net.sf.jasperreports.engine.base.JRBaseElement

net.sf.jasperreports.engine.design.JRDesignElement

net.sf.jasperreports.engine.design.JRDesignGenericElement

All Implemented Interfaces:

Serializable, Cloneable, JRChangeEventsSupport, JRChild, JRCloneable, JRCommonElement, JRElement, JREvaluation, JRGenericElement, JRIdentifiable, JRPropertiesHolder, JRStyleContainer, JRVisitable

public class JRDesignGenericElement
extends JRDesignElement
implements JRGenericElement

A implementation of JRGenericElement that is to be used at report design time.

Author:

Lucian Chirita (lucianc@users.sourceforge.net)

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROPERTY_EVALUATION_GROUP
static final String	PROPERTY_EVALUATION_TIME
static final String	PROPERTY_GENERIC_TYPE
static final String	PROPERTY_PARAMETERS

Fields inherited from class net.sf.jasperreports.engine.design.JRDesignElement

PROPERTY_ELEMENT_GROUP, PROPERTY_HEIGHT, PROPERTY_KEY, PROPERTY_PARENT_STYLE, PROPERTY_PARENT_STYLE_NAME_REFERENCE, PROPERTY_PRINT_WHEN_EXPRESSION, PROPERTY_PRINT_WHEN_GROUP_CHANGES, PROPERTY_PROPERTY_EXPRESSIONS, PROPERTY_STYLE_EXPRESSION, PROPERTY_Y

Fields inherited from class net.sf.jasperreports.engine.base.JRBaseElement

backcolor, defaultStyleProvider, elementGroup, forecolor, height, isPrintInFirstWholeBand, isPrintRepeatedValues, isPrintWhenDetailOverflows, isRemoveLineWhenBlank, key, mode, parentStyle, parentStyleNameReference, positionType, printWhenExpression, printWhenGroupChanges, PROPERTY_POSITION_TYPE, PROPERTY_PRINT_IN_FIRST_WHOLE_BAND, PROPERTY_PRINT_REPEATED_VALUES, PROPERTY_PRINT_WHEN_DETAIL_OVERFLOWS, PROPERTY_REMOVE_LINE_WHEN_BLANK, PROPERTY_STRETCH_TYPE, PROPERTY_WIDTH, PROPERTY_X, stretchType, styleExpression, uuid, width, x, y

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

PROPERTY_ELEMENT_TEMPLATE_POPULATE_STYLE

Constructor Summary

Constructors

Constructor	Description
JRDesignGenericElement(JRDefaultStyleProvider defaultStyleProvider)	Creates a generic report element.

Method Summary

Modifier and Type	Method	Description
void	addParameter(JRGenericElementParameter parameter)	Adds a parameter to the element.
Object	clone()
void	collectExpressions(JRExpressionCollector collector)
String	getEvaluationGroup()	Gets the evaluation group for this text field.
EvaluationTimeEnum	getEvaluationTime()	Gets the evaluation time for this text field.
JRGenericElementType	getGenericType()	Returns the generic type of this element.
JRGenericElementParameter[]	getParameters()	Returns the list of parameters of this element.
List<JRGenericElementParameter>	getParametersList()	Exposes the internal list of element parameters.
JRGenericElementParameter	removeParameter(String parameterName)	Removes a parameter by name from the element.
boolean	removeParameter(JRGenericElementParameter parameter)	Removes a parameter from the element.
void	setEvaluationGroup(String evaluationGroup)	Sets the name of the evaluation group.
void	setEvaluationTime(EvaluationTimeEnum evaluationTime)	Sets the evaluation time for the element.
void	setGenericType(JRGenericElementType genericType)	Sets the type of the generic element.
void	visit(JRVisitor visitor)

Methods inherited from class net.sf.jasperreports.engine.design.JRDesignElement

addPropertyExpression, getPropertyExpressions, getPropertyExpressionsList, removePropertyExpression, removePropertyExpression, setElementGroup, setHeight, setKey, setPrintWhenExpression, setPrintWhenGroupChanges, setStyle, setStyleExpression, setStyleNameReference, setY

Methods inherited from class net.sf.jasperreports.engine.base.JRBaseElement

clone, clone, getBackcolor, getBaseStyle, getDefaultStyleProvider, getElementGroup, getEventSupport, getForecolor, getHeight, getKey, getMode, getOwnBackcolor, getOwnForecolor, getOwnMode, getParentProperties, getPositionType, getPrintWhenExpression, getPrintWhenGroupChanges, getPropertiesMap, getStretchType, getStyle, getStyleExpression, getStyleNameReference, getStyleResolver, getUUID, getWidth, getX, getY, hasProperties, isPrintInFirstWholeBand, isPrintRepeatedValues, isPrintWhenDetailOverflows, isRemoveLineWhenBlank, setBackcolor, setForecolor, setMode, setPositionType, setPrintInFirstWholeBand, setPrintRepeatedValues, setPrintWhenDetailOverflows, setRemoveLineWhenBlank, setStretchType, setUUID, setWidth, setX

Methods inherited from class java.lang.Object

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

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

clone

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

getBackcolor, getForecolor, getHeight, getKey, getMode, getOwnBackcolor, getOwnForecolor, getOwnMode, getWidth, setBackcolor, setForecolor, setMode

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

clone, getElementGroup, getPositionType, getPrintWhenExpression, getPrintWhenGroupChanges, getPropertyExpressions, getStretchType, getStyleExpression, getX, getY, isPrintInFirstWholeBand, isPrintRepeatedValues, isPrintWhenDetailOverflows, isRemoveLineWhenBlank, setPositionType, setPrintInFirstWholeBand, setPrintRepeatedValues, setPrintWhenDetailOverflows, setRemoveLineWhenBlank, setStretchType, setWidth, setX

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

getUUID

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

Field Details

PROPERTY_GENERIC_TYPE

public static final String PROPERTY_GENERIC_TYPE

See Also:

• Constant Field Values

PROPERTY_EVALUATION_TIME

public static final String PROPERTY_EVALUATION_TIME

See Also:

• Constant Field Values

PROPERTY_EVALUATION_GROUP

public static final String PROPERTY_EVALUATION_GROUP

See Also:

• Constant Field Values

PROPERTY_PARAMETERS

public static final String PROPERTY_PARAMETERS

See Also:

• Constant Field Values

Constructor Details

JRDesignGenericElement

public JRDesignGenericElement(JRDefaultStyleProvider defaultStyleProvider)

Creates a generic report element.

Parameters:

defaultStyleProvider - the default style provider to use for the element

Method Details

getParameters

public JRGenericElementParameter[] getParameters()

Description copied from interface: JRGenericElement

Returns the list of parameters of this element.

Specified by:

getParameters in interface JRGenericElement

Returns:

the list of parameters

getParametersList

public List<JRGenericElementParameter> getParametersList()

Exposes the internal list of element parameters.

Returns:

the list of element parameters

See Also:

• getParameters()

addParameter

public void addParameter(JRGenericElementParameter parameter)

Adds a parameter to the element.

Parameters:

parameter - the parameter to add.

See Also:

• getParameters()

removeParameter

public boolean removeParameter(JRGenericElementParameter parameter)

Removes a parameter from the element.

Parameters:

parameter - the parameter to remove

Returns:

whether the parameter has been found and removed

removeParameter

public JRGenericElementParameter removeParameter(String parameterName)

Removes a parameter by name from the element.

Parameters:

parameterName - the name of the parameter to remove

Returns:

the removed parameter, or null if not found

getGenericType

public JRGenericElementType getGenericType()

Description copied from interface: JRGenericElement

Returns the generic type of this element. This type will be propagated to the generated print element, and used to resolve export handler for the print element.

Specified by:

getGenericType in interface JRGenericElement

Returns:

the generic type of this element

setGenericType

public void setGenericType(JRGenericElementType genericType)

Sets the type of the generic element.

Parameters:

genericType - the type of the element.

See Also:

• getGenericType()

collectExpressions

public void collectExpressions(JRExpressionCollector collector)

Specified by:

collectExpressions in interface JRElement

visit

public void visit(JRVisitor visitor)

Specified by:

visit in interface JRVisitable

getEvaluationTime

public EvaluationTimeEnum getEvaluationTime()

Description copied from interface: JREvaluation

Gets the evaluation time for this text field.

Specified by:

getEvaluationTime in interface JREvaluation

Returns:

one of the evaluation time constants in JRExpression

setEvaluationTime

public void setEvaluationTime(EvaluationTimeEnum evaluationTime)

Sets the evaluation time for the element.

The default evaluation time is EvaluationTimeEnum.NOW.

Parameters:

evaluationTime - the element's evaluation time, one of

1. EvaluationTimeEnum.NOW
2. EvaluationTimeEnum.BAND
3. EvaluationTimeEnum.COLUMN
4. EvaluationTimeEnum.PAGE
5. EvaluationTimeEnum.GROUP
6. EvaluationTimeEnum.REPORT
7. EvaluationTimeEnum.AUTO

See Also:

• getEvaluationTime()

getEvaluationGroup

public String getEvaluationGroup()

Description copied from interface: JREvaluation

Gets the evaluation group for this text field. Used only when evaluation time is group.

Specified by:

getEvaluationGroup in interface JREvaluation

See Also:

• EvaluationTimeEnum.GROUP

setEvaluationGroup

public void setEvaluationGroup(String evaluationGroup)

Sets the name of the evaluation group.

Parameters:

evaluationGroup - the evaluation group's name

See Also:

• getEvaluationGroup()

clone

public Object clone()

Specified by:

clone in interface JRCloneable

Overrides:

clone in class JRDesignElement