net.sf.jasperreports.engine.base.JRBaseBand Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jasperreports Show documentation
Show all versions of jasperreports Show documentation
Free Java Reporting Library
/*
* JasperReports - Free Java Reporting Library.
* Copyright (C) 2001 - 2019 TIBCO Software 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 .
*/
package net.sf.jasperreports.engine.base;
import java.io.IOException;
import java.io.ObjectInputStream;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import net.sf.jasperreports.engine.ExpressionReturnValue;
import net.sf.jasperreports.engine.JRBand;
import net.sf.jasperreports.engine.JRConstants;
import net.sf.jasperreports.engine.JRExpression;
import net.sf.jasperreports.engine.JRPropertiesHolder;
import net.sf.jasperreports.engine.JRPropertiesMap;
import net.sf.jasperreports.engine.design.events.JRChangeEventsSupport;
import net.sf.jasperreports.engine.design.events.JRPropertyChangeSupport;
import net.sf.jasperreports.engine.type.SplitTypeEnum;
import net.sf.jasperreports.engine.util.JRCloneUtils;
/**
* Used for implementing band functionality. A report can contain the following bands: background, title,
* summary, page header, page footer, last page footer, column header and column footer.
* @see JRBaseSection
* @author Teodor Danciu ([email protected])
*/
public class JRBaseBand extends JRBaseElementGroup implements JRBand, JRChangeEventsSupport
{
/**
*
*/
private static final long serialVersionUID = JRConstants.SERIAL_VERSION_UID;
/**
*
*/
public static final String PROPERTY_splitType = "splitType";
/**
*
*/
protected int height;
protected SplitTypeEnum splitTypeValue;
/**
*
*/
protected JRExpression printWhenExpression;
private JRPropertiesMap propertiesMap;
protected List returnValues;
/**
*
*/
protected JRBaseBand(JRBand band, JRBaseObjectFactory factory)
{
super(band, factory);
height = band.getHeight();
splitTypeValue = band.getSplitTypeValue();
printWhenExpression = factory.getExpression(band.getPrintWhenExpression());
this.propertiesMap = JRPropertiesMap.getPropertiesClone(band);
List bandReturnValues = band.getReturnValues();
if (bandReturnValues != null && !bandReturnValues.isEmpty())
{
this.returnValues = new ArrayList(bandReturnValues.size());
for (ExpressionReturnValue bandReturnValue : bandReturnValues)
{
BaseExpressionReturnValue returnValue = factory.getReturnValue(bandReturnValue);
this.returnValues.add(returnValue);
}
}
}
@Override
public int getHeight()
{
return 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;
}
@Override
public List getReturnValues()
{
return returnValues == null ? null : Collections.unmodifiableList(returnValues);
}
@Override
public Object clone()
{
JRBaseBand clone = (JRBaseBand)super.clone();
clone.printWhenExpression = JRCloneUtils.nullSafeClone(printWhenExpression);
clone.propertiesMap = JRPropertiesMap.getPropertiesClone(this);
clone.returnValues = JRCloneUtils.cloneList(returnValues);
clone.eventSupport = null;
return clone;
}
private transient JRPropertyChangeSupport eventSupport;
@Override
public JRPropertyChangeSupport getEventSupport()
{
synchronized (this)
{
if (eventSupport == null)
{
eventSupport = new JRPropertyChangeSupport(this);
}
}
return eventSupport;
}
/*
* 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;
}
}