/*
* 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.design;
import java.io.IOException;
import java.io.ObjectInputStream;
import net.sf.jasperreports.engine.JRBand;
import net.sf.jasperreports.engine.JRConstants;
import net.sf.jasperreports.engine.JRExpression;
import net.sf.jasperreports.engine.JROrigin;
import net.sf.jasperreports.engine.base.JRBaseBand;
import net.sf.jasperreports.engine.type.SplitTypeEnum;
/**
* @author Teodor Danciu (teodord@users.sourceforge.net)
* @version $Id: JRDesignBand.java 3940 2010-08-20 10:35:15Z teodord $
*/
public class JRDesignBand extends JRDesignElementGroup implements JRBand
{
/**
*
*/
private static final long serialVersionUID = JRConstants.SERIAL_VERSION_UID;
public static final String PROPERTY_HEIGHT = "height";
public static final String PROPERTY_PRINT_WHEN_EXPRESSION = "printWhenExpression";
/**
*
*/
protected int height;
protected SplitTypeEnum splitTypeValue;
/**
*
*/
protected JRExpression printWhenExpression;
private JROrigin origin;
/**
*
*/
public int getHeight()
{
return height;
}
/**
*
*/
public void setHeight(int height)
{
int old = this.height;
this.height = height;
getEventSupport().firePropertyChange(PROPERTY_HEIGHT, old, this.height);
}
/**
* @deprecated Replaced by {@link #getSplitType()}.
*/
public boolean isSplitAllowed()
{
return !JRBand.SPLIT_TYPE_PREVENT.equals(getSplitType());
}
/**
* @deprecated Replaced by {@link #setSplitType(Byte)}.
*/
public void setSplitAllowed(boolean isSplitAllowed)
{
setSplitType(isSplitAllowed ? JRBand.SPLIT_TYPE_STRETCH : JRBand.SPLIT_TYPE_PREVENT);
}
/**
* @deprecated Replaced by {@link #getSplitTypeValue()}.
*/
public Byte getSplitType()
{
return getSplitTypeValue() == null ? null : getSplitTypeValue().getValueByte();
}
/**
*
*/
public SplitTypeEnum getSplitTypeValue()
{
return splitTypeValue;
}
/**
* @deprecated Replaced by {@link #setSplitType(SplitTypeEnum)}.
*/
public void setSplitType(Byte splitType)
{
setSplitType(SplitTypeEnum.getByValue(splitType));
}
/**
*
*/
public void setSplitType(SplitTypeEnum splitTypeValue)
{
SplitTypeEnum old = this.splitTypeValue;
this.splitTypeValue = splitTypeValue;
getEventSupport().firePropertyChange(JRBaseBand.PROPERTY_SPLIT_TYPE, old, this.splitTypeValue);
}
/**
*
*/
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 JRDesignGroup#setGroupHeader(JRBand) setGroupHeader}
* methods).
*
* @return the band origin
*/
public JROrigin getOrigin()
{
return origin;
}
void setOrigin(JROrigin origin)
{
this.origin = origin;
}
/**
*
*/
public Object clone()
{
JRDesignBand clone = (JRDesignBand)super.clone();
if (printWhenExpression != null)
{
clone.printWhenExpression = (JRExpression)printWhenExpression.clone();
}
if (origin != null)
{
clone.origin = (JROrigin)origin.clone();
}
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 ? JRBand.SPLIT_TYPE_STRETCH : JRBand.SPLIT_TYPE_PREVENT;
}
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;
}
}
}