net.sf.jasperreports.engine.design.JRDesignBand 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 returnValues;
/**
*
*/
public JRDesignBand()
{
returnValues = new ArrayList<>(2);
}
@Override
public int getHeight()
{
return height;
}
/**
*
*/
public void setHeight(int height)
{
int old = this.height;
this.height = height;
getEventSupport().firePropertyChange(PROPERTY_HEIGHT, old, this.height);
}
@Override
public SplitTypeEnum getSplitTypeValue()
{
return splitTypeValue;
}
@Override
public void setSplitType(SplitTypeEnum splitTypeValue)
{
SplitTypeEnum old = this.splitTypeValue;
this.splitTypeValue = splitTypeValue;
getEventSupport().firePropertyChange(JRBaseBand.PROPERTY_splitType, old, this.splitTypeValue);
}
@Override
public JRExpression getPrintWhenExpression()
{
return this.printWhenExpression;
}
/**
*
*/
public void setPrintWhenExpression(JRExpression expression)
{
Object old = this.printWhenExpression;
this.printWhenExpression = expression;
getEventSupport().firePropertyChange(PROPERTY_PRINT_WHEN_EXPRESSION, old, this.printWhenExpression);
}
/**
* Returns the band origin, i.e. its location/role within the report
* (e.g. detail/title/group header/etc).
* The location is automatically set when the band is inserted
* into the report (via one of the
* {@link JasperDesign#setTitle(JRBand) setTitle} /
* {@link JasperDesign#setPageHeader(JRBand) setPageHeader}
* methods).
*
* @return the band origin
*/
public JROrigin getOrigin()
{
return origin;
}
void setOrigin(JROrigin origin)
{
this.origin = origin;
}
@Override
public List getReturnValues()
{
return returnValues == null ? null : Collections.unmodifiableList(returnValues);
}
/**
* Adds a return value to the band.
*
* @param returnValue the return value to be added.
*/
public void addReturnValue(ExpressionReturnValue returnValue)
{
this.returnValues.add(returnValue);
getEventSupport().fireCollectionElementAddedEvent(PROPERTY_RETURN_VALUES,
returnValue, returnValues.size() - 1);
}
/**
* Returns the list of values to increment report variables with.
*
* @return list of {@link ReturnValue ReturnValue} objects
*/
public List getReturnValuesList()
{
return returnValues;
}
/**
* Removes a return value from the band.
*
* @param returnValue the return value to be removed
* @return true if the return value was found and removed
*/
public boolean removeReturnValue(ExpressionReturnValue returnValue)
{
int idx = this.returnValues.indexOf(returnValue);
if (idx >= 0)
{
this.returnValues.remove(idx);
getEventSupport().fireCollectionElementRemovedEvent(PROPERTY_RETURN_VALUES, returnValue, idx);
return true;
}
return false;
}
@Override
public Object clone()
{
JRDesignBand clone = (JRDesignBand)super.clone();
if (printWhenExpression != null)
{
clone.printWhenExpression = (JRExpression)printWhenExpression.clone();
}
if (origin != null)
{
clone.origin = (JROrigin)origin.clone();
}
clone.propertiesMap = JRPropertiesMap.getPropertiesClone(this);
clone.returnValues = JRCloneUtils.cloneList(returnValues);
return clone;
}
/*
* These fields are only for serialization backward compatibility.
*/
private int PSEUDO_SERIAL_VERSION_UID = JRConstants.PSEUDO_SERIAL_VERSION_UID; //NOPMD
/**
* @deprecated
*/
private boolean isSplitAllowed = true;
/**
* @deprecated
*/
private Byte splitType;
@SuppressWarnings("deprecation")
private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundException
{
in.defaultReadObject();
if (PSEUDO_SERIAL_VERSION_UID < JRConstants.PSEUDO_SERIAL_VERSION_UID_3_5_2)
{
splitType = isSplitAllowed ? SplitTypeEnum.STRETCH.getValueByte() : SplitTypeEnum.PREVENT.getValueByte();
}
if (PSEUDO_SERIAL_VERSION_UID < JRConstants.PSEUDO_SERIAL_VERSION_UID_3_7_2)//FIXMEENUM check order of ifs for all
{
splitTypeValue = SplitTypeEnum.getByValue(splitType);
splitType = null;
}
}
@Override
public boolean hasProperties()
{
return propertiesMap != null && propertiesMap.hasProperties();
}
@Override
public JRPropertiesMap getPropertiesMap()
{
if (propertiesMap == null)
{
propertiesMap = new JRPropertiesMap();
}
return propertiesMap;
}
@Override
public JRPropertiesHolder getParentProperties()
{
return null;
}
}