|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectnet.sf.jasperreports.engine.base.JRBaseElement
net.sf.jasperreports.engine.design.JRDesignElement
net.sf.jasperreports.engine.design.JRDesignGenericElement
public class JRDesignGenericElement
A implementation of JRGenericElement that is to be used at report
design time.
| Field Summary | |
|---|---|
static java.lang.String |
PROPERTY_EVALUATION_GROUP_NAME
|
static java.lang.String |
PROPERTY_EVALUATION_TIME
|
static java.lang.String |
PROPERTY_GENERIC_TYPE
|
static java.lang.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_Y |
| Fields inherited from interface net.sf.jasperreports.engine.JRElement |
|---|
MODE_OPAQUE, MODE_TRANSPARENT, POSITION_TYPE_FIX_RELATIVE_TO_BOTTOM, POSITION_TYPE_FIX_RELATIVE_TO_TOP, POSITION_TYPE_FLOAT, STRETCH_TYPE_NO_STRETCH, STRETCH_TYPE_RELATIVE_TO_BAND_HEIGHT, STRETCH_TYPE_RELATIVE_TO_TALLEST_OBJECT |
| Constructor Summary | |
|---|---|
JRDesignGenericElement(JRDefaultStyleProvider defaultStyleProvider)
Creates a generic report element. |
|
| Method Summary | |
|---|---|
void |
addParameter(JRGenericElementParameter parameter)
Adds a parameter to the element. |
void |
collectExpressions(JRExpressionCollector collector)
|
java.lang.String |
getEvaluationGroupName()
Returns the name of the evaluation group for this element. |
byte |
getEvaluationTime()
Deprecated. Replaced by getEvaluationTimeValue(). |
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. |
java.util.List |
getParamtersList()
Exposes the internal list of element parameters. |
boolean |
removeParameter(JRGenericElementParameter parameter)
Removes a parameter from the element. |
JRGenericElementParameter |
removeParameter(java.lang.String parameterName)
Removes a parameter by name from the element. |
void |
setEvaluationGroupName(java.lang.String evaluationGroupName)
Sets the name of the evaluation group. |
void |
setEvaluationTime(byte evaluationTime)
Deprecated. Replaced by setEvaluationTime(EvaluationTimeEnum). |
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)
|
| Methods inherited from class net.sf.jasperreports.engine.design.JRDesignElement |
|---|
addPropertyExpression, getPropertyExpressions, getPropertyExpressionsList, removePropertyExpression, removePropertyExpression, setElementGroup, setHeight, setKey, setPrintWhenExpression, setPrintWhenGroupChanges, setStyle, setStyleNameReference, setY |
| 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.JRElement |
|---|
getElementGroup, getKey, getPositionType, getPositionTypeValue, getPrintWhenExpression, getPrintWhenGroupChanges, getPropertyExpressions, getStretchType, getStretchTypeValue, getX, getY, isPrintInFirstWholeBand, isPrintRepeatedValues, isPrintWhenDetailOverflows, isRemoveLineWhenBlank, setPositionType, setPositionType, setPrintInFirstWholeBand, setPrintRepeatedValues, setPrintWhenDetailOverflows, setRemoveLineWhenBlank, setStretchType, setStretchType, setWidth, setX |
| Methods inherited from interface net.sf.jasperreports.engine.JRChild |
|---|
clone |
| Methods inherited from interface net.sf.jasperreports.engine.JRCloneable |
|---|
clone |
| Methods inherited from interface net.sf.jasperreports.engine.JRCommonElement |
|---|
getBackcolor, getForecolor, getHeight, getMode, getModeValue, getOwnBackcolor, getOwnForecolor, getOwnMode, getOwnModeValue, getWidth, setBackcolor, setForecolor, setMode, setMode, 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 |
| Field Detail |
|---|
public static final java.lang.String PROPERTY_GENERIC_TYPE
public static final java.lang.String PROPERTY_EVALUATION_TIME
public static final java.lang.String PROPERTY_EVALUATION_GROUP_NAME
public static final java.lang.String PROPERTY_PARAMETERS
| Constructor Detail |
|---|
public JRDesignGenericElement(JRDefaultStyleProvider defaultStyleProvider)
defaultStyleProvider - the default style provider to use for the element| Method Detail |
|---|
public JRGenericElementParameter[] getParameters()
JRGenericElement
getParameters in interface JRGenericElementpublic java.util.List getParamtersList()
getParameters()public void addParameter(JRGenericElementParameter parameter)
parameter - the parameter to add.getParameters()public boolean removeParameter(JRGenericElementParameter parameter)
parameter - the parameter to remove
public JRGenericElementParameter removeParameter(java.lang.String parameterName)
parameterName - the name of the parameter to remove
null if not foundpublic JRGenericElementType getGenericType()
JRGenericElement
getGenericType 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 byte getEvaluationTime()
getEvaluationTimeValue().
getEvaluationTime in interface JRGenericElementpublic 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(byte evaluationTime)
setEvaluationTime(EvaluationTimeEnum).
public void setEvaluationTime(EvaluationTimeEnum evaluationTimeValue)
The default evaluation time is EvaluationTimeEnum.NOW.
evaluationTimeValue - the element's evaluation time, one of
public java.lang.String getEvaluationGroupName()
JRGenericElementthe evaluation time is
JRExpression.EVALUATION_TIME_GROUP.
getEvaluationGroupName in interface JRGenericElementpublic void setEvaluationGroupName(java.lang.String evaluationGroupName)
evaluationGroupName - the evaluation group's namegetEvaluationGroupName()
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||