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
A implementation of
JRGenericElement that is to be used at report
design time.- Author:
- Lucian Chirita (lucianc@users.sourceforge.net)
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Stringstatic final Stringstatic final Stringstatic final StringFields 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_YFields 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, yFields inherited from interface net.sf.jasperreports.engine.JRElement
PROPERTY_ELEMENT_TEMPLATE_POPULATE_STYLE -
Constructor Summary
ConstructorsConstructorDescriptionJRDesignGenericElement(JRDefaultStyleProvider defaultStyleProvider) Creates a generic report element. -
Method Summary
Modifier and TypeMethodDescriptionvoidaddParameter(JRGenericElementParameter parameter) Adds a parameter to the element.clone()voidcollectExpressions(JRExpressionCollector collector) Gets the evaluation group for this text field.Gets the evaluation time for this text field.Returns the generic type of this element.Returns the list of parameters of this element.Exposes the internal list of element parameters.removeParameter(String parameterName) Removes a parameter by name from the element.booleanremoveParameter(JRGenericElementParameter parameter) Removes a parameter from the element.voidsetEvaluationGroup(String evaluationGroup) Sets the name of the evaluation group.voidsetEvaluationTime(EvaluationTimeEnum evaluationTime) Sets the evaluation time for the element.voidsetGenericType(JRGenericElementType genericType) Sets the type of the generic element.voidMethods inherited from class net.sf.jasperreports.engine.design.JRDesignElement
addPropertyExpression, getPropertyExpressions, getPropertyExpressionsList, removePropertyExpression, removePropertyExpression, setElementGroup, setHeight, setKey, setPrintWhenExpression, setPrintWhenGroupChanges, setStyle, setStyleExpression, setStyleNameReference, setYMethods 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, setXMethods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface net.sf.jasperreports.engine.JRCommonElement
getBackcolor, getForecolor, getHeight, getKey, getMode, getOwnBackcolor, getOwnForecolor, getOwnMode, getWidth, setBackcolor, setForecolor, setModeMethods 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, setXMethods inherited from interface net.sf.jasperreports.engine.JRIdentifiable
getUUIDMethods inherited from interface net.sf.jasperreports.engine.JRPropertiesHolder
getParentProperties, getPropertiesMap, hasPropertiesMethods inherited from interface net.sf.jasperreports.engine.JRStyleContainer
getDefaultStyleProvider, getStyle, getStyleName, getStyleNameReference
-
Field Details
-
PROPERTY_GENERIC_TYPE
- See Also:
-
PROPERTY_EVALUATION_TIME
- See Also:
-
PROPERTY_EVALUATION_GROUP
- See Also:
-
PROPERTY_PARAMETERS
- See Also:
-
-
Constructor Details
-
JRDesignGenericElement
Creates a generic report element.- Parameters:
defaultStyleProvider- the default style provider to use for the element
-
-
Method Details
-
getParameters
Description copied from interface:JRGenericElementReturns the list of parameters of this element.- Specified by:
getParametersin interfaceJRGenericElement- Returns:
- the list of parameters
-
getParametersList
Exposes the internal list of element parameters.- Returns:
- the list of element parameters
- See Also:
-
addParameter
Adds a parameter to the element.- Parameters:
parameter- the parameter to add.- See Also:
-
removeParameter
Removes a parameter from the element.- Parameters:
parameter- the parameter to remove- Returns:
- whether the parameter has been found and removed
-
removeParameter
Removes a parameter by name from the element.- Parameters:
parameterName- the name of the parameter to remove- Returns:
- the removed parameter, or
nullif not found
-
getGenericType
Description copied from interface:JRGenericElementReturns 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:
getGenericTypein interfaceJRGenericElement- Returns:
- the generic type of this element
-
setGenericType
Sets the type of the generic element.- Parameters:
genericType- the type of the element.- See Also:
-
collectExpressions
- Specified by:
collectExpressionsin interfaceJRElement
-
visit
- Specified by:
visitin interfaceJRVisitable
-
getEvaluationTime
Description copied from interface:JREvaluationGets the evaluation time for this text field.- Specified by:
getEvaluationTimein interfaceJREvaluation- Returns:
- one of the evaluation time constants in
JRExpression
-
setEvaluationTime
Sets the evaluation time for the element.The default evaluation time is
EvaluationTimeEnum.NOW.- Parameters:
evaluationTime- the element's evaluation time, one of
- See Also:
-
-
getEvaluationGroup
Description copied from interface:JREvaluationGets the evaluation group for this text field. Used only when evaluation time is group.- Specified by:
getEvaluationGroupin interfaceJREvaluation- See Also:
-
setEvaluationGroup
Sets the name of the evaluation group.- Parameters:
evaluationGroup- the evaluation group's name- See Also:
-
clone
- Specified by:
clonein interfaceJRCloneable- Overrides:
clonein classJRDesignElement