net.sf.jasperreports.components.table.StandardBaseColumn 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 groupHeaders;
private List groupFooters;
private Cell columnHeader;
private Cell columnFooter;
private Integer width;
private JRPropertiesMap propertiesMap;
private List propertyExpressions = new ArrayList<>();
public StandardBaseColumn()
{
groupHeaders = new ArrayList<>();
groupFooters = new ArrayList<>();
}
public StandardBaseColumn(BaseColumn column, ColumnFactory factory)
{
this.uuid = column.getUUID();
this.printWhenExpression = factory.getBaseObjectFactory().getExpression(
column.getPrintWhenExpression());
this.tableHeader = factory.createCell(column.getTableHeader());
this.tableFooter = factory.createCell(column.getTableFooter());
this.groupHeaders = factory.createGroupCells(column.getGroupHeaders());
this.groupFooters = factory.createGroupCells(column.getGroupFooters());
this.columnHeader = factory.createCell(column.getColumnHeader());
this.columnFooter = factory.createCell(column.getColumnFooter());
this.width = column.getWidth();
propertiesMap = JRPropertiesMap.getPropertiesClone(column);
copyPropertyExpressions(column, factory);
}
private void copyPropertyExpressions(BaseColumn column, ColumnFactory factory)
{
JRPropertyExpression[] props = column.getPropertyExpressions();
if (props != null && props.length > 0)
{
propertyExpressions = new ArrayList<>(props.length);
for (int i = 0; i < props.length; i++)
{
propertyExpressions.add(factory.getBaseObjectFactory().getPropertyExpression(props[i]));
}
}
}
@Override
public UUID getUUID()
{
if (uuid == null)
{
uuid = UUID.randomUUID();
}
return uuid;
}
/**
*
*/
public void setUUID(UUID uuid)
{
this.uuid = uuid;
}
@Override
public Cell getColumnHeader()
{
return columnHeader;
}
@Override
public Cell getColumnFooter()
{
return columnFooter;
}
@Override
public JRExpression getPrintWhenExpression()
{
return printWhenExpression;
}
public void setPrintWhenExpression(JRExpression printWhenExpression)
{
Object old = this.printWhenExpression;
this.printWhenExpression = printWhenExpression;
getEventSupport().firePropertyChange(PROPERTY_PRINT_WHEN_EXPRESSION,
old, this.printWhenExpression);
}
public void setColumnHeader(Cell header)
{
Object old = this.columnHeader;
this.columnHeader = header;
getEventSupport().firePropertyChange(PROPERTY_COLUMN_HEADER,
old, this.columnHeader);
}
public void setColumnFooter(Cell header)
{
Object old = this.columnFooter;
this.columnFooter = header;
getEventSupport().firePropertyChange(PROPERTY_COLUMN_FOOTER,
old, this.columnFooter);
}
@Override
public Object clone()
{
StandardBaseColumn clone = null;
try
{
clone = (StandardBaseColumn) super.clone();
}
catch (CloneNotSupportedException e)
{
// never
throw new JRRuntimeException(e);
}
clone.tableHeader = JRCloneUtils.nullSafeClone(tableHeader);
clone.tableFooter = JRCloneUtils.nullSafeClone(tableFooter);
clone.groupHeaders = JRCloneUtils.cloneList(groupHeaders);
clone.groupFooters = JRCloneUtils.cloneList(groupFooters);
clone.columnHeader = JRCloneUtils.nullSafeClone(columnHeader);
clone.columnFooter = JRCloneUtils.nullSafeClone(columnFooter);
clone.printWhenExpression = JRCloneUtils.nullSafeClone(printWhenExpression);
clone.propertyExpressions = JRCloneUtils.cloneList(propertyExpressions);
clone.eventSupport = null;
clone.uuid = null;
return clone;
}
@Override
public Cell getTableHeader()
{
return tableHeader;
}
public void setTableHeader(Cell tableHeader)
{
Object old = this.tableHeader;
this.tableHeader = tableHeader;
getEventSupport().firePropertyChange(PROPERTY_TABLE_HEADER,
old, this.tableHeader);
}
@Override
public Cell getTableFooter()
{
return tableFooter;
}
public void setTableFooter(Cell tableFooter)
{
Object old = this.tableFooter;
this.tableFooter = tableFooter;
getEventSupport().firePropertyChange(PROPERTY_TABLE_FOOTER,
old, this.tableFooter);
}
@Override
public Integer getWidth()
{
return width;
}
public void setWidth(Integer width)
{
Object old = this.width;
this.width = width;
getEventSupport().firePropertyChange(PROPERTY_WIDTH,
old, this.width);
}
private transient JRPropertyChangeSupport eventSupport;
@Override
public JRPropertyChangeSupport getEventSupport()
{
synchronized (this)
{
if (eventSupport == null)
{
eventSupport = new JRPropertyChangeSupport(this);
}
}
return eventSupport;
}
@Override
public List getGroupHeaders()
{
return groupHeaders;
}
@Override
public List getGroupFooters()
{
return groupFooters;
}
protected int findGroupCellIndex(List groupCells, String groupName)
{
int idx = -1;
for (ListIterator it = groupCells.listIterator(); it.hasNext();)
{
GroupCell groupCell = it.next();
if (groupName.equals(groupCell.getGroupName()))
{
idx = it.previousIndex();
}
}
return idx;
}
@Override
public Cell getGroupFooter(String groupName)
{
int idx = findGroupCellIndex(groupFooters, groupName);
return idx < 0 ? null : groupFooters.get(idx).getCell();
}
@Override
public Cell getGroupHeader(String groupName)
{
int idx = findGroupCellIndex(groupHeaders, groupName);
return idx < 0 ? null : groupHeaders.get(idx).getCell();
}
public void setGroupHeaders(List groupHeaders)
{
Object old = this.groupHeaders;
this.groupHeaders = groupHeaders;
getEventSupport().firePropertyChange(PROPERTY_GROUP_HEADERS,
old, this.groupHeaders);
}
public void setGroupFooters(List groupFooters)
{
Object old = this.groupFooters;
this.groupFooters = groupFooters;
getEventSupport().firePropertyChange(PROPERTY_GROUP_FOOTERS,
old, this.groupFooters);
}
public void addGroupHeader(GroupCell groupCell)
{
groupHeaders.add(groupCell);
getEventSupport().fireCollectionElementAddedEvent(PROPERTY_GROUP_HEADERS,
groupCell, groupHeaders.size() - 1);
}
public void addGroupFooter(GroupCell groupCell)
{
groupFooters.add(groupCell);
getEventSupport().fireCollectionElementAddedEvent(PROPERTY_GROUP_FOOTERS,
groupCell, groupFooters.size() - 1);
}
public boolean removeGroupFooter(GroupCell groupCell)
{
int idx = groupFooters.indexOf(groupCell);
if (idx >= 0)
{
groupFooters.remove(idx);
getEventSupport().fireCollectionElementRemovedEvent(PROPERTY_GROUP_FOOTERS,
groupCell, idx);
}
return idx >= 0;
}
public boolean removeGroupHeader(GroupCell groupCell)
{
int idx = groupHeaders.indexOf(groupCell);
if (idx >= 0)
{
groupHeaders.remove(idx);
getEventSupport().fireCollectionElementRemovedEvent(PROPERTY_GROUP_HEADERS,
groupCell, idx);
}
return idx >= 0;
}
public void setGroupFooter(String groupName, Cell cell)
{
int idx = findGroupCellIndex(groupFooters, groupName);
if (idx >= 0)
{
GroupCell old = groupFooters.get(idx);
if (cell == null)
{
// removing group footer
groupFooters.remove(idx);
getEventSupport().fireCollectionElementRemovedEvent(PROPERTY_GROUP_FOOTERS,
old, idx);
}
else
{
// replacing group footer
StandardGroupCell groupCell = new StandardGroupCell(groupName, cell);
groupFooters.set(idx, groupCell);
getEventSupport().fireIndexedPropertyChange(PROPERTY_GROUP_FOOTERS, idx,
old, groupCell);
}
}
else if (cell != null)
{
// adding group footer
StandardGroupCell groupCell = new StandardGroupCell(groupName, cell);
addGroupFooter(groupCell);
}
}
public void setGroupHeader(String groupName, Cell cell)
{
int idx = findGroupCellIndex(groupHeaders, groupName);
if (idx >= 0)
{
GroupCell old = groupHeaders.get(idx);
if (cell == null)
{
// removing group header
groupHeaders.remove(idx);
getEventSupport().fireCollectionElementRemovedEvent(PROPERTY_GROUP_HEADERS,
old, idx);
}
else
{
// replacing group header
StandardGroupCell groupCell = new StandardGroupCell(groupName, cell);
groupHeaders.set(idx, groupCell);
getEventSupport().fireIndexedPropertyChange(PROPERTY_GROUP_HEADERS, idx,
old, groupCell);
}
}
else if (cell != null)
{
// adding group header
StandardGroupCell groupCell = new StandardGroupCell(groupName, cell);
addGroupHeader(groupCell);
}
}
@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;
}
@Override
public JRPropertyExpression[] getPropertyExpressions()
{
JRPropertyExpression[] props;
if (propertyExpressions.isEmpty())
{
props = null;
}
else
{
props = propertyExpressions.toArray(new JRPropertyExpression[propertyExpressions.size()]);
}
return props;
}
/**
* Add a dynamic/expression-based property.
*
* @param propertyExpression the property to add
* @see #getPropertyExpressions()
*/
public void addPropertyExpression(JRPropertyExpression propertyExpression)
{
propertyExpressions.add(propertyExpression);
getEventSupport().fireCollectionElementAddedEvent(JRDesignElement.PROPERTY_PROPERTY_EXPRESSIONS,
propertyExpression, propertyExpressions.size() - 1);
}
/**
* Remove a property expression.
*
* @param propertyExpression the property expression to remove
* @see #addPropertyExpression(JRPropertyExpression)
*/
public void removePropertyExpression(JRPropertyExpression propertyExpression)
{
int idx = propertyExpressions.indexOf(propertyExpression);
if (idx >= 0)
{
propertyExpressions.remove(idx);
getEventSupport().fireCollectionElementRemovedEvent(JRDesignElement.PROPERTY_PROPERTY_EXPRESSIONS,
propertyExpression, idx);
}
}
/**
* Remove a property expression.
*
* @param name the name of the property to remove
* @return the removed property expression (if found)
*/
public JRPropertyExpression removePropertyExpression(String name)
{
JRPropertyExpression removed = null;
for (ListIterator it = propertyExpressions.listIterator(); it.hasNext();)
{
JRPropertyExpression prop = it.next();
if (name.equals(prop.getName()))
{
removed = prop;
int idx = it.previousIndex();
it.remove();
getEventSupport().fireCollectionElementRemovedEvent(JRDesignElement.PROPERTY_PROPERTY_EXPRESSIONS,
removed, idx);
break;
}
}
return removed;
}
/**
* Returns the list of property expressions.
*
* @return the list of property expressions ({@link JRPropertyExpression} instances)
* @see #addPropertyExpression(JRPropertyExpression)
*/
public List getPropertyExpressionsList()
{
return propertyExpressions;
}
private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundException
{
in.defaultReadObject();
if (propertyExpressions == null)
{
propertyExpressions = new ArrayList<>();
}
}
}