net.sf.jasperreports.crosstabs.JRCellContents Maven / Gradle / Ivy
Show all versions of jasperreports Show documentation
/*
* JasperReports - Free Java Reporting Library.
* Copyright (C) 2001 - 2019 TIBCO Software 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.crosstabs;
import java.awt.Color;
import net.sf.jasperreports.annotations.properties.Property;
import net.sf.jasperreports.annotations.properties.PropertyScope;
import net.sf.jasperreports.engine.JRBoxContainer;
import net.sf.jasperreports.engine.JRElementGroup;
import net.sf.jasperreports.engine.JRPropertiesHolder;
import net.sf.jasperreports.engine.JRPropertiesUtil;
import net.sf.jasperreports.engine.JRStyleContainer;
import net.sf.jasperreports.engine.type.ModeEnum;
import net.sf.jasperreports.properties.PropertyConstants;
/**
* Crosstab cell contents interface.
*
* This interface is used for both crosstab row/column headers and data cells.
*
* There are some restrictions/rules regarding crosstab cells:
*
* - subreports, crosstabs and charts are not allowed
* - delayed evaluation for text fields and images is not allowed
* - cells cannot split on multiple pages
*
*
* @author Lucian Chirita ([email protected])
*/
public interface JRCellContents extends JRElementGroup, JRStyleContainer, JRBoxContainer, JRPropertiesHolder
{
/**
* Width or height value indicating that the value has not been computed.
*/
public static final int NOT_CALCULATED = Integer.MIN_VALUE;
/**
* A prefix used for properties that are set on frames generated by crosstab cells.
*
* @see net.sf.jasperreports.engine.JRPrintFrame
*/
public static final String PROPERTIES_PREFIX = JRPropertiesUtil.PROPERTY_PREFIX + "crosstab.cell.";
/**
* A property that provides the type of the cell that generated a print frame.
*
*
* The property value is one of
*
* - {@link #TYPE_CROSSTAB_HEADER}
* - {@link #TYPE_COLUMN_HEADER}
* - {@link #TYPE_ROW_HEADER}
* - {@link #TYPE_DATA}
* - {@link #TYPE_NO_DATA_CELL}
*
*/
@Property(
category = PropertyConstants.CATEGORY_CROSSTAB,
scopes = {PropertyScope.INTERNAL},
sinceVersion = PropertyConstants.VERSION_3_1_2
)
public static final String PROPERTY_TYPE = PROPERTIES_PREFIX + "type";
/**
* A property that provides the crosstab row span of a print frame.
*/
@Property(
category = PropertyConstants.CATEGORY_CROSSTAB,
scopes = {PropertyScope.INTERNAL},
sinceVersion = PropertyConstants.VERSION_3_1_2,
valueType = Integer.class
)
public static final String PROPERTY_ROW_SPAN = PROPERTIES_PREFIX + "row.span";
/**
* A property that provides the crosstab column span of a print frame.
*/
@Property(
category = PropertyConstants.CATEGORY_CROSSTAB,
scopes = {PropertyScope.INTERNAL},
sinceVersion = PropertyConstants.VERSION_3_1_2,
valueType = Integer.class
)
public static final String PROPERTY_COLUMN_SPAN = PROPERTIES_PREFIX + "column.span";
/**
* Type used by the {@link JRCrosstab#getTitleCell() crosstab title cell}.
*
* @see #PROPERTY_TYPE
*/
public static final String TYPE_CROSSTAB_TITLE = "CrosstabTitle";
/**
* Type used by the {@link JRCrosstab#getHeaderCell() crosstab header cell}.
*
* @see #PROPERTY_TYPE
*/
public static final String TYPE_CROSSTAB_HEADER = "CrosstabHeader";
/**
* Type used by the row header cells.
*
* @see JRCrosstabRowGroup#getHeader()
* @see JRCrosstabRowGroup#getTotalHeader()
* @see #PROPERTY_TYPE
*/
public static final String TYPE_ROW_HEADER = "RowHeader";
/**
* Type used by the column header cells.
*
* @see JRCrosstabColumnGroup#getHeader()
* @see JRCrosstabColumnGroup#getTotalHeader()
* @see #PROPERTY_TYPE
*/
public static final String TYPE_COLUMN_HEADER = "ColumnHeader";
/**
* Type used by the {@link JRCrosstab#getCells() crosstab data cells}.
*
* @see #PROPERTY_TYPE
*/
public static final String TYPE_DATA = "Data";
/**
* Type used by the {@link JRCrosstab#getWhenNoDataCell() crosstab "no data" cell}.
*
* @see #PROPERTY_TYPE
*/
public static final String TYPE_NO_DATA_CELL = "NoDataCell";
/**
* Returns the cell background color.
*
* The cell is filled with the background color only if the cell has opaque mode.
*
* @return the cell backcolor
*/
public Color getBackcolor();
/**
* Returns the computed cell width.
*
* @return the computed cell width
* @see #NOT_CALCULATED
*/
public int getWidth();
/**
* Returns the computed cell height.
*
* @return the computed cell height
* @see #NOT_CALCULATED
*/
public int getHeight();
/**
* Returns the cell transparency mode.
*
* @return {@link ModeEnum#OPAQUE}
* or {@link ModeEnum#TRANSPARENT}
*/
public ModeEnum getModeValue();
}