public class JRDesignGenericElement extends JRDesignElement implements JRGenericElement
JRGenericElement that is to be used at report
design time.| Modifier and Type | Field and Description |
|---|---|
static String |
PROPERTY_EVALUATION_GROUP_NAME |
static String |
PROPERTY_EVALUATION_TIME |
static String |
PROPERTY_GENERIC_TYPE |
static String |
PROPERTY_PARAMETERS |
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_Ybackcolor, defaultStyleProvider, elementGroup, forecolor, height, isPrintInFirstWholeBand, isPrintRepeatedValues, isPrintWhenDetailOverflows, isRemoveLineWhenBlank, key, modeValue, parentStyle, parentStyleNameReference, positionTypeValue, 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, stretchTypeValue, uuid, width, x, y| Constructor and Description |
|---|
JRDesignGenericElement(JRDefaultStyleProvider defaultStyleProvider)
Creates a generic report element.
|
| Modifier and Type | Method and Description |
|---|---|
void |
addParameter(JRGenericElementParameter parameter)
Adds a parameter to the element.
|
Object |
clone() |
void |
collectExpressions(JRExpressionCollector collector) |
String |
getEvaluationGroupName()
Returns the name of the evaluation group for this element.
|
EvaluationTimeEnum |
getEvaluationTimeValue()
Returns the evaluation time of this element.
|
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.
|
List<JRGenericElementParameter> |
getParamtersList()
Deprecated.
Replaced by
getParametersList(). |
boolean |
removeParameter(JRGenericElementParameter parameter)
Removes a parameter from the element.
|
JRGenericElementParameter |
removeParameter(String parameterName)
Removes a parameter by name from the element.
|
void |
setEvaluationGroupName(String evaluationGroupName)
Sets the name of the evaluation group.
|
void |
setEvaluationTime(EvaluationTimeEnum evaluationTimeValue)
Sets the evaluation time for the element.
|
void |
setGenericType(JRGenericElementType genericType)
Sets the type of the generic element.
|
void |
visit(JRVisitor visitor) |
addPropertyExpression, getPropertyExpressions, getPropertyExpressionsList, removePropertyExpression, removePropertyExpression, setElementGroup, setHeight, setKey, setPrintWhenExpression, setPrintWhenGroupChanges, setStyle, setStyleNameReference, setUUID, setYclone, clone, getBackcolor, getBaseStyle, getDefaultStyleProvider, getElementGroup, getEventSupport, getForecolor, getHeight, getKey, getModeValue, getOwnBackcolor, getOwnForecolor, getOwnModeValue, getParentProperties, getPositionTypeValue, getPrintWhenExpression, getPrintWhenGroupChanges, getPropertiesMap, getStretchTypeValue, getStyle, getStyleNameReference, getStyleResolver, getUUID, getWidth, getX, getY, hasProperties, isPrintInFirstWholeBand, isPrintRepeatedValues, isPrintWhenDetailOverflows, isRemoveLineWhenBlank, setBackcolor, setForecolor, setMode, setPositionType, setPrintInFirstWholeBand, setPrintRepeatedValues, setPrintWhenDetailOverflows, setRemoveLineWhenBlank, setStretchType, setWidth, setXequals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitclone, getElementGroup, getKey, getPositionTypeValue, getPrintWhenExpression, getPrintWhenGroupChanges, getPropertyExpressions, getStretchTypeValue, getX, getY, isPrintInFirstWholeBand, isPrintRepeatedValues, isPrintWhenDetailOverflows, isRemoveLineWhenBlank, setPositionType, setPrintInFirstWholeBand, setPrintRepeatedValues, setPrintWhenDetailOverflows, setRemoveLineWhenBlank, setStretchType, setWidth, setXgetBackcolor, getForecolor, getHeight, getModeValue, getOwnBackcolor, getOwnForecolor, getOwnModeValue, getWidth, setBackcolor, setForecolor, setModegetDefaultStyleProvider, getStyle, getStyleNameReferencegetParentProperties, getPropertiesMap, hasPropertiesgetUUIDpublic static final String PROPERTY_GENERIC_TYPE
public static final String PROPERTY_EVALUATION_TIME
public static final String PROPERTY_EVALUATION_GROUP_NAME
public static final String PROPERTY_PARAMETERS
public JRDesignGenericElement(JRDefaultStyleProvider defaultStyleProvider)
defaultStyleProvider - the default style provider to use for the elementpublic JRGenericElementParameter[] getParameters()
JRGenericElementgetParameters in interface JRGenericElementpublic List<JRGenericElementParameter> getParamtersList()
getParametersList().public List<JRGenericElementParameter> getParametersList()
getParameters()public void addParameter(JRGenericElementParameter parameter)
parameter - the parameter to add.getParameters()public boolean removeParameter(JRGenericElementParameter parameter)
parameter - the parameter to removepublic JRGenericElementParameter removeParameter(String parameterName)
parameterName - the name of the parameter to removenull if not foundpublic JRGenericElementType getGenericType()
JRGenericElementgetGenericType in interface JRGenericElementpublic void setGenericType(JRGenericElementType genericType)
genericType - the type of the element.getGenericType()public void collectExpressions(JRExpressionCollector collector)
collectExpressions in interface JRElementpublic void visit(JRVisitor visitor)
visit in interface JRVisitablepublic EvaluationTimeEnum getEvaluationTimeValue()
JRGenericElementThe evaluation time determines the moment at which parameter expressions are evaluated for this element. All parameters will be evaluated at the same moment.
getEvaluationTimeValue in interface JRGenericElementpublic void setEvaluationTime(EvaluationTimeEnum evaluationTimeValue)
The default evaluation time is EvaluationTimeEnum.NOW.
evaluationTimeValue - the element's evaluation time, one of
getEvaluationTimeValue()public String getEvaluationGroupName()
JRGenericElementthe evaluation time is
EvaluationTimeEnum.GROUP.getEvaluationGroupName in interface JRGenericElementpublic void setEvaluationGroupName(String evaluationGroupName)
evaluationGroupName - the evaluation group's namegetEvaluationGroupName()public Object clone()
clone in interface JRCloneableclone in class JRDesignElementCopyright © 2017. All rights reserved.