net.sf.jasperreports.engine.design.JRDesignGenericElement Maven / Gradle / Ivy
/*
* JasperReports - Free Java Reporting Library.
* Copyright (C) 2001 - 2023 Cloud Software Group, Inc. All rights reserved.
* http://www.jaspersoft.com
*
* Unless you have purchased a commercial license agreement from Jaspersoft,
* the following license terms apply:
*
* This program is part of JasperReports.
*
* JasperReports is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* JasperReports is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with JasperReports. If not, see parameters = new ArrayList<>();
private EvaluationTimeEnum evaluationTimeValue = EvaluationTimeEnum.NOW;
private String evaluationGroupName;
/**
* Creates a generic report element.
*
* @param defaultStyleProvider the default style provider to use for the element
*/
public JRDesignGenericElement(JRDefaultStyleProvider defaultStyleProvider)
{
super(defaultStyleProvider);
}
@Override
public JRGenericElementParameter[] getParameters()
{
return parameters.toArray(new JRGenericElementParameter[parameters.size()]);
}
/**
* @deprecated Replaced by {@link #getParametersList()}.
*/
public List getParamtersList()
{
return getParametersList();
}
/**
* Exposes the internal list of element parameters.
*
* @return the list of element parameters
* @see #getParameters()
*/
public List getParametersList()
{
return parameters;
}
/**
* Adds a parameter to the element.
*
* @param parameter the parameter to add.
* @see #getParameters()
*/
public void addParameter(JRGenericElementParameter parameter)
{
this.parameters.add(parameter);
getEventSupport().fireCollectionElementAddedEvent(PROPERTY_PARAMETERS,
parameter, parameters.size() - 1);
}
/**
* Removes a parameter from the element.
*
* @param parameter the parameter to remove
* @return whether the parameter has been found and removed
*/
public boolean removeParameter(JRGenericElementParameter parameter)
{
int idx = parameters.indexOf(parameter);
if (idx >= 0)
{
parameters.remove(idx);
getEventSupport().fireCollectionElementRemovedEvent(PROPERTY_PARAMETERS,
parameter, idx);
return true;
}
return false;
}
/**
* Removes a parameter by name from the element.
*
* @param parameterName the name of the parameter to remove
* @return the removed parameter, or null if not found
*/
public JRGenericElementParameter removeParameter(String parameterName)
{
JRGenericElementParameter removed = null;
for (ListIterator it = parameters.listIterator(); it.hasNext();)
{
JRGenericElementParameter parameter = it.next();
if (parameter.getName() != null && parameter.getName().equals(parameterName))
{
removed = parameter;
it.remove();
getEventSupport().fireCollectionElementRemovedEvent(PROPERTY_PARAMETERS,
parameter, it.nextIndex());
break;
}
}
return removed;
}
@Override
public JRGenericElementType getGenericType()
{
return genericType;
}
/**
* Sets the type of the generic element.
*
* @param genericType the type of the element.
* @see #getGenericType()
*/
public void setGenericType(JRGenericElementType genericType)
{
Object old = this.genericType;
this.genericType = genericType;
getEventSupport().firePropertyChange(PROPERTY_GENERIC_TYPE, old, this.genericType);
}
@Override
public void collectExpressions(JRExpressionCollector collector)
{
collector.collect(this);
}
@Override
public void visit(JRVisitor visitor)
{
visitor.visitGenericElement(this);
}
@Override
public EvaluationTimeEnum getEvaluationTimeValue()
{
return evaluationTimeValue;
}
/**
* Sets the evaluation time for the element.
*
*
* The default evaluation time is {@link EvaluationTimeEnum#NOW}.
*
* @param evaluationTimeValue the element's evaluation time, one of
*
* - {@link EvaluationTimeEnum#NOW}
*
- {@link EvaluationTimeEnum#BAND}
*
- {@link EvaluationTimeEnum#COLUMN}
*
- {@link EvaluationTimeEnum#PAGE}
*
- {@link EvaluationTimeEnum#GROUP}
*
- {@link EvaluationTimeEnum#REPORT}
*
- {@link EvaluationTimeEnum#AUTO}
*
* @see #getEvaluationTimeValue()
*/
public void setEvaluationTime(EvaluationTimeEnum evaluationTimeValue)
{
Object old = this.evaluationTimeValue;
this.evaluationTimeValue = evaluationTimeValue;
getEventSupport().firePropertyChange(PROPERTY_EVALUATION_TIME,
old, this.evaluationTimeValue);
}
@Override
public String getEvaluationGroupName()
{
return evaluationGroupName;
}
/**
* Sets the name of the evaluation group.
*
* @param evaluationGroupName the evaluation group's name
* @see #getEvaluationGroupName()
*/
public void setEvaluationGroupName(String evaluationGroupName)
{
Object old = this.evaluationGroupName;
this.evaluationGroupName = evaluationGroupName;
getEventSupport().firePropertyChange(PROPERTY_EVALUATION_GROUP_NAME,
old, this.evaluationGroupName);
}
@Override
public Object clone()
{
JRDesignGenericElement clone = (JRDesignGenericElement)super.clone();
clone.parameters = JRCloneUtils.cloneList(parameters);
return clone;
}
/*
* These fields are only for serialization backward compatibility.
*/
private int PSEUDO_SERIAL_VERSION_UID = JRConstants.PSEUDO_SERIAL_VERSION_UID; //NOPMD
/**
* @deprecated
*/
private byte evaluationTime;
@SuppressWarnings("deprecation")
private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundException
{
in.defaultReadObject();
if (PSEUDO_SERIAL_VERSION_UID < JRConstants.PSEUDO_SERIAL_VERSION_UID_3_7_2)
{
evaluationTimeValue = EvaluationTimeEnum.getByValue(evaluationTime);
}
}
}