net.sf.jasperreports.crosstabs.JRCrosstabColumnGroup 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 - 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 net.sf.jasperreports.crosstabs.type.CrosstabColumnPositionEnum;
/**
* Crosstab column group interface.
*
* @author Lucian Chirita ([email protected])
*/
public interface JRCrosstabColumnGroup extends JRCrosstabGroup
{
/**
* Returns the height of the group headers.
*
* @return the height of the group headers
* @see JRCrosstabGroup#getHeader()
* @see JRCrosstabGroup#getTotalHeader()
*/
public int getHeight();
/**
* Returns the position of the header contents for header stretching.
*
* The column group headers stretch horizontally when there are multiple sub group entries.
* The header contents will be adjusted to the new width depending on this attribute:
*
* - {@link CrosstabColumnPositionEnum#LEFT CrosstabColumnPositionEnum.LEFT} - the contents will be rendered on the left side of the header
* - {@link CrosstabColumnPositionEnum#CENTER CrosstabColumnPositionEnum.CENTER} - the contents will be rendered on the center of the header
* - {@link CrosstabColumnPositionEnum#RIGHT CrosstabColumnPositionEnum.RIGHT} - the contents will be rendered on the right side of the header
* - {@link CrosstabColumnPositionEnum#STRETCH CrosstabColumnPositionEnum.STRETCH} - the contents will be proportionally stretched to the new header size
*
*
* @return the position of the header contents for header stretching
*/
public CrosstabColumnPositionEnum getPositionValue();
/**
* Returns the crosstab header cell of the column group.
*
*
* The cell will be rendered at the left of the corresponding row of column headers,
* potentially overlapping {@link JRCrosstab#getHeaderCell() the crosstab header cell}.
*
*
*
* The width of the cell is the total width of row group headers,
* and the height is the height of the corresponding column header.
*
*
* @return the crosstab header cell of the column group, or null
if no header cell is present
*
* @see JRCrosstab#getHeaderCell()
* @see #getHeight()
*/
public JRCellContents getCrosstabHeader();
}