net.sf.jasperreports.engine.fill.JRTemplatePrintFrame 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 - 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 .
*/
package net.sf.jasperreports.engine.fill;
import java.awt.Color;
import java.io.IOException;
import java.io.ObjectInputStream;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import net.sf.jasperreports.engine.JRConstants;
import net.sf.jasperreports.engine.JRLineBox;
import net.sf.jasperreports.engine.JRPrintElement;
import net.sf.jasperreports.engine.JRPrintElementContainer;
import net.sf.jasperreports.engine.JRPrintFrame;
import net.sf.jasperreports.engine.PrintElementId;
import net.sf.jasperreports.engine.PrintElementVisitor;
import net.sf.jasperreports.engine.base.VirtualizableElementList;
import net.sf.jasperreports.engine.virtualization.VirtualizationInput;
import net.sf.jasperreports.engine.virtualization.VirtualizationOutput;
/**
* Implementation of {@link net.sf.jasperreports.engine.JRPrintFrame JRPrintFrame} that uses
* {@link net.sf.jasperreports.engine.fill.JRTemplateFrame template frames} to store common
* attributes.
*
* @author Lucian Chirita ([email protected])
*/
public class JRTemplatePrintFrame extends JRTemplatePrintElement implements JRPrintFrame, JRPrintElementContainer
{
private static final long serialVersionUID = JRConstants.SERIAL_VERSION_UID;
private List elements;
public JRTemplatePrintFrame()
{
}
/**
* Creates a print frame element.
*
* @param templateFrame the template frame that the element will use
* @param originator
*/
public JRTemplatePrintFrame(JRTemplateFrame templateFrame, PrintElementOriginator originator)
{
super(templateFrame, originator);
elements = new ArrayList<>();
}
protected void setElementsList(List elements)
{
this.elements = elements;
}
@Override
public List getElements()
{
return elements;
}
@Override
public void addElement(JRPrintElement element)
{
elements.add(element);
}
public void addElements(Collection elements)
{
this.elements.addAll(elements);
}
@Override
public JRLineBox getLineBox()
{
return ((JRTemplateFrame)template).getLineBox();
}
@Override
public Color getDefaultLineColor()
{
return getForecolor();
}
@Override
public void accept(PrintElementVisitor visitor, T arg)
{
visitor.visit(this, arg);
}
@Override
public void writeVirtualized(VirtualizationOutput out) throws IOException
{
super.writeVirtualized(out);
if (elements instanceof VirtualizableElementList)
{
VirtualizableElementList virtualizableList = ((VirtualizableElementList) elements);
JRVirtualizationContext virtualizationContext = virtualizableList.getVirtualizationContext();
//should be already cached by VirtualizableFrame, but it doesn't hurt setting it again
virtualizationContext.cacheVirtualizableList(PrintElementId.forElement(this), virtualizableList);
out.writeIntCompressed(-1);
}
else
{
out.writeIntCompressed(elements.size());
for (JRPrintElement element : elements)
{
// TODO lucianc we only need this when VirtualElementsData has evaluations
out.writeJRObject(element, true, false);
}
}
}
@Override
public void readVirtualized(VirtualizationInput in) throws IOException
{
super.readVirtualized(in);
int size = in.readIntCompressed();
if (size < 0)
{
elements = in.getVirtualizationContext().getVirtualizableList(PrintElementId.forElement(this));
}
else
{
elements = new ArrayList<>(size);
for (int i = 0; i < size; i++)
{
JRPrintElement element = (JRPrintElement) in.readJRObject();
elements.add(element);
}
}
}
private void readObject(ObjectInputStream in) throws ClassNotFoundException, IOException
{
in.defaultReadObject();
if (elements instanceof VirtualizableElementList)
{
VirtualizableElementList virtualizableList = ((VirtualizableElementList) elements);
JRVirtualizationContext virtualizationContext = virtualizableList.getVirtualizationContext();
virtualizationContext.cacheVirtualizableList(PrintElementId.forElement(this), virtualizableList);
}
}
}