/*
* 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;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import java.util.ListIterator;
import net.sf.jasperreports.engine.design.events.JRChangeEventsSupport;
import net.sf.jasperreports.engine.design.events.JRPropertyChangeSupport;
/**
* Default {@link JRTemplate} implementation.
*
* @author Lucian Chirita (lucianc@users.sourceforge.net)
* @version $Id: JRSimpleTemplate.java 4256 2011-03-15 13:50:21Z teodord $
*/
public class JRSimpleTemplate implements JRTemplate, Serializable, JRChangeEventsSupport {
public static final String PROPERTY_STYLE = "style";
public static final String PROPERTY_INCLUDED_TEMPLATES = "incluldedTemplates";
private static final long serialVersionUID = JRConstants.SERIAL_VERSION_UID;
private final List<JRTemplateReference> includedTemplates = new ArrayList();
private final List<JRStyle> styles = new ArrayList();
private JRStyle defaultStyle;
private transient JRPropertyChangeSupport eventSupport;
public JRPropertyChangeSupport getEventSupport() {
synchronized (this) {
if (eventSupport == null) {
eventSupport = new JRPropertyChangeSupport(this);
}
}
return eventSupport;
}
/**
* Adds a style to the template.
*
* @param style
* the style to add
* @throws JRException
* when a style with the same name already exists
*/
public void addStyle(JRStyle style) throws JRException {
addStyle(-1, style);
}
/**
* Adds a style to the template.
*
* @param style
* the style to add
* @throws JRException
* when a style with the same name already exists
*/
public void addStyle(int index, JRStyle style) throws JRException {
checkExistingName(style.getName());
if (style.isDefault()) {
defaultStyle = style;
}
if (index >= 0 && index < styles.size())
styles.add(index, style);
else {
styles.add(style);
index = styles.size() - 1;
}
getEventSupport().fireCollectionElementAddedEvent(PROPERTY_STYLE, style, index);
}
protected void checkExistingName(String name) throws JRException {
if (getStyle(name) != null) {
throw new JRException("Duplicate declaration of template style : " + name);
}
}
protected boolean nameMatches(JRStyle style, String name) {
String styleName = style.getName();
return name == null ? styleName == null : name.equals(styleName);
}
/**
* Returns an included style by name.
*
* @param name
* the name of the style to be returned
* @return the style having the specified name, or <code>null</code> if not found
*/
public JRStyle getStyle(String name) {
JRStyle style = null;
for (Iterator it = styles.iterator(); it.hasNext();) {
JRStyle itStyle = (JRStyle) it.next();
if (nameMatches(itStyle, name)) {
style = itStyle;
break;
}
}
return style;
}
/**
* Removes an included style.
*
* @param style
* the style to remove
* @return <code>true</code> if and only if the style has been found and removed
*/
public boolean removeStyle(JRStyle style) {
int idx = styles.indexOf(style);
if (idx >= 0) {
styles.remove(idx);
if (style.isDefault()) {
defaultStyle = null;
}
getEventSupport().fireCollectionElementRemovedEvent(PROPERTY_STYLE, style, idx);
return true;
}
return false;
}
/**
* Removes an included style.
*
* @param name
* the name of the style to be removed
* @return the removed style, or <code>null</code> if not found
*/
public JRStyle removeStyle(String name) {
JRStyle removed = null;
for (ListIterator it = styles.listIterator(); it.hasNext();) {
JRStyle style = (JRStyle) it.next();
if (nameMatches(style, name)) {
if (style.isDefault()) {
defaultStyle = null;
}
removed = style;
break;
}
}
removeStyle(removed);
return removed;
}
public List<JRStyle> getStylesList() {
return styles;
}
public JRStyle[] getStyles() {
return styles.toArray(new JRStyle[styles.size()]);
}
public JRStyle getDefaultStyle() {
return defaultStyle;
}
public JRReportFont getDefaultFont() {
return null;
}
/**
* Adds an included template.
*
* @param reference
* the template reference
* @see #getIncludedTemplates()
*/
public void addIncludedTemplate(int index, JRTemplateReference reference) {
if (index >= 0 && index < includedTemplates.size())
includedTemplates.add(index, reference);
else {
includedTemplates.add(reference);
index = includedTemplates.size() - 1;
}
getEventSupport().fireCollectionElementAddedEvent(PROPERTY_INCLUDED_TEMPLATES, reference, index);
}
/**
* Adds an included template.
*
* @param reference
* the template reference
* @see #getIncludedTemplates()
*/
public void addIncludedTemplate(JRTemplateReference reference) {
addIncludedTemplate(-1, reference);
}
/**
* Adds an included template.
*
* @param templateLocation
* the template location
* @see #getIncludedTemplates()
*/
public void addIncludedTemplate(String templateLocation) {
addIncludedTemplate(new JRTemplateReference(templateLocation));
}
/**
* Removes an included template.
*
* @param reference
* the template reference to remove
* @return <code>true</code> if and only if the included template has been found and removed
*/
public boolean removeIncludedTemplate(JRTemplateReference reference) {
int idx = includedTemplates.indexOf(reference);
if (idx >= 0) {
includedTemplates.remove(idx);
getEventSupport().fireCollectionElementRemovedEvent(PROPERTY_INCLUDED_TEMPLATES, reference, idx);
return true;
}
return false;
}
/**
* Removes an included template.
* <p/>
* The first template reference that matches the location is removed.
*
* @param location
* the location of the template to remove
* @return the removed template reference, or <code>null</code> if not found
*/
public JRTemplateReference removeIncludedTemplate(String location) {
JRTemplateReference removed = null;
for (ListIterator it = includedTemplates.listIterator(); it.hasNext();) {
JRTemplateReference ref = (JRTemplateReference) it.next();
if (ref.getLocation().equals(location)) {
removed = ref;
}
}
removeIncludedTemplate(removed);
return removed;
}
public JRTemplateReference[] getIncludedTemplates() {
return includedTemplates.toArray(new JRTemplateReference[includedTemplates.size()]);
}
public List<JRTemplateReference> getIncludedTemplatesList() {
return includedTemplates;
}
}