/*
* JasperReports - Free Java Reporting Library.
* Copyright (C) 2001 - 2009 Jaspersoft Corporation. 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 <http://www.gnu.org/licenses/>.
*/
package net.sf.jasperreports.engine.base;
import java.io.IOException;
import java.io.ObjectInputStream;
import java.io.Serializable;
import net.sf.jasperreports.engine.JRBand;
import net.sf.jasperreports.engine.JRConstants;
import net.sf.jasperreports.engine.JRExpression;
import net.sf.jasperreports.engine.JRGroup;
import net.sf.jasperreports.engine.JRRuntimeException;
import net.sf.jasperreports.engine.JRSection;
import net.sf.jasperreports.engine.JRVariable;
import net.sf.jasperreports.engine.design.events.JRChangeEventsSupport;
import net.sf.jasperreports.engine.design.events.JRPropertyChangeSupport;
import net.sf.jasperreports.engine.type.FooterPositionEnum;
/**
* @author Teodor Danciu (teodord@users.sourceforge.net)
* @version $Id: JRBaseGroup.java 3941 2010-08-20 10:55:10Z teodord $
*/
public class JRBaseGroup implements JRGroup, Serializable, JRChangeEventsSupport
{
/**
*
*/
private static final long serialVersionUID = JRConstants.SERIAL_VERSION_UID;
public static final String PROPERTY_MIN_HEIGHT_TO_START_NEW_PAGE = "minHeightToStartNewPage";
public static final String PROPERTY_FOOTER_POSITION = "footerPosition";
public static final String PROPERTY_KEEP_TOGETHER = "keepTogether";
public static final String PROPERTY_RESET_PAGE_NUMBER = "resetPageNumber";
public static final String PROPERTY_REPRINT_HEADER_ON_EACH_PAGE = "reprintHeaderOnEachPage";
public static final String PROPERTY_START_NEW_COLUMN = "startNewColumn";
public static final String PROPERTY_START_NEW_PAGE = "startNewPage";
/**
*
*/
protected String name;
protected boolean isStartNewColumn;
protected boolean isStartNewPage;
protected boolean isResetPageNumber;
protected boolean isReprintHeaderOnEachPage;
protected int minHeightToStartNewPage;
protected FooterPositionEnum footerPositionValue = FooterPositionEnum.NORMAL;
protected boolean keepTogether;
/**
*
*/
protected JRExpression expression;
protected JRSection groupHeaderSection;
protected JRSection groupFooterSection;
protected JRVariable countVariable;
/**
*
*/
protected JRBaseGroup()
{
}
/**
*
*/
protected JRBaseGroup(JRGroup group, JRBaseObjectFactory factory)
{
factory.put(group, this);
name = group.getName();
isStartNewColumn = group.isStartNewColumn();
isStartNewPage = group.isStartNewPage();
isResetPageNumber = group.isResetPageNumber();
isReprintHeaderOnEachPage = group.isReprintHeaderOnEachPage();
minHeightToStartNewPage = group.getMinHeightToStartNewPage();
footerPositionValue = group.getFooterPositionValue();
keepTogether = group.isKeepTogether();
expression = factory.getExpression(group.getExpression());
groupHeaderSection = factory.getSection(group.getGroupHeaderSection());
groupFooterSection = factory.getSection(group.getGroupFooterSection());
countVariable = factory.getVariable(group.getCountVariable());
}
/**
*
*/
public String getName()
{
return this.name;
}
/**
*
*/
public boolean isStartNewColumn()
{
return this.isStartNewColumn;
}
/**
*
*/
public void setStartNewColumn(boolean isStart)
{
boolean old = this.isStartNewColumn;
this.isStartNewColumn = isStart;
getEventSupport().firePropertyChange(PROPERTY_START_NEW_COLUMN, old, this.isStartNewColumn);
}
/**
*
*/
public boolean isStartNewPage()
{
return this.isStartNewPage;
}
/**
*
*/
public void setStartNewPage(boolean isStart)
{
boolean old = this.isStartNewPage;
this.isStartNewPage = isStart;
getEventSupport().firePropertyChange(PROPERTY_START_NEW_PAGE, old, this.isStartNewPage);
}
/**
*
*/
public boolean isResetPageNumber()
{
return this.isResetPageNumber;
}
/**
*
*/
public void setResetPageNumber(boolean isReset)
{
boolean old = this.isResetPageNumber;
this.isResetPageNumber = isReset;
getEventSupport().firePropertyChange(PROPERTY_RESET_PAGE_NUMBER, old, this.isResetPageNumber);
}
/**
*
*/
public boolean isReprintHeaderOnEachPage()
{
return this.isReprintHeaderOnEachPage;
}
/**
*
*/
public void setReprintHeaderOnEachPage(boolean isReprint)
{
boolean old = this.isReprintHeaderOnEachPage;
this.isReprintHeaderOnEachPage = isReprint;
getEventSupport().firePropertyChange(PROPERTY_REPRINT_HEADER_ON_EACH_PAGE, old, this.isReprintHeaderOnEachPage);
}
/**
*
*/
public int getMinHeightToStartNewPage()
{
return this.minHeightToStartNewPage;
}
/**
*
*/
public void setMinHeightToStartNewPage(int minHeight)
{
int old = this.minHeightToStartNewPage;
this.minHeightToStartNewPage = minHeight;
getEventSupport().firePropertyChange(PROPERTY_MIN_HEIGHT_TO_START_NEW_PAGE, old, this.minHeightToStartNewPage);
}
/**
* @deprecated Replaced by {@link #getFooterPositionValue()}.
*/
public byte getFooterPosition()
{
return getFooterPositionValue().getValue();
}
/**
*
*/
public FooterPositionEnum getFooterPositionValue()
{
return this.footerPositionValue;
}
/**
* @deprecated Replaced by {@link #setFooterPosition(FooterPositionEnum)}.
*/
public void setFooterPosition(byte footerPosition)
{
setFooterPosition(FooterPositionEnum.getByValue(footerPosition));
}
/**
*
*/
public void setFooterPosition(FooterPositionEnum footerPositionValue)
{
FooterPositionEnum old = this.footerPositionValue;
this.footerPositionValue = footerPositionValue;
getEventSupport().firePropertyChange(PROPERTY_FOOTER_POSITION, old, this.footerPositionValue);
}
/**
*
*/
public boolean isKeepTogether()
{
return this.keepTogether;
}
/**
*
*/
public void setKeepTogether(boolean keepTogether)
{
boolean old = this.keepTogether;
this.keepTogether = keepTogether;
getEventSupport().firePropertyChange(PROPERTY_KEEP_TOGETHER, old, this.keepTogether);
}
/**
*
*/
public JRExpression getExpression()
{
return this.expression;
}
/**
* @deprecated Replaced by {@link #getGroupHeaderSection()}.
*/
public JRBand getGroupHeader()
{
return
groupHeaderSection == null
|| groupHeaderSection.getBands() == null
|| groupHeaderSection.getBands().length == 0
? null
: (JRBand)groupHeaderSection.getBands()[0];
}
/**
*
*/
public JRSection getGroupHeaderSection()
{
return this.groupHeaderSection;
}
/**
* @deprecated Replaced by {@link #getGroupFooterSection()}.
*/
public JRBand getGroupFooter()
{
return
groupFooterSection == null
|| groupFooterSection.getBands() == null
|| groupFooterSection.getBands().length == 0
? null
: (JRBand)groupFooterSection.getBands()[0];
}
/**
*
*/
public JRSection getGroupFooterSection()
{
return this.groupFooterSection;
}
/**
*
*/
public JRVariable getCountVariable()
{
return this.countVariable;
}
/**
*
*/
public Object clone()
{
JRBaseGroup clone = null;
try
{
clone = (JRBaseGroup)super.clone();
}
catch (CloneNotSupportedException e)
{
throw new JRRuntimeException(e);
}
if (expression != null)
{
clone.expression = (JRExpression)expression.clone();
}
if (groupHeader != null)
{
clone.groupHeader = (JRBand)groupHeader.clone();
}
if (groupFooter != null)
{
clone.groupFooter = (JRBand)groupFooter.clone();
}
if (countVariable != null)
{
clone.countVariable = (JRVariable)countVariable.clone();
}
return clone;
}
private transient JRPropertyChangeSupport eventSupport;
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 byte footerPosition;
/**
* @deprecated
*/
private JRBand groupHeader;
/**
* @deprecated
*/
private JRBand groupFooter;
private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundException
{
in.defaultReadObject();
if (PSEUDO_SERIAL_VERSION_UID < JRConstants.PSEUDO_SERIAL_VERSION_UID_3_7_2)
{
if (footerPosition == 0)
{
// stream class didn't have footerPosition, use default.
// ideally we should have used PSEUDO_SERIAL_VERSION_UID to
// detect this case, but there was no PSEUDO_SERIAL_VERSION_UID
// when footerPosition was introduced
footerPositionValue = FooterPositionEnum.NORMAL;
}
else
{
// convert stream byte value to enum
footerPositionValue = FooterPositionEnum.getByValue(footerPosition);
}
}
if (groupHeader != null)
{
groupHeaderSection = new JRBaseSection(groupHeader);
groupHeader = null;
}
if (groupFooter != null)
{
groupFooterSection = new JRBaseSection(groupFooter);
groupFooter = null;
}
}
}