com.itextpdf.layout.element.Cell Maven / Gradle / Ivy
/*
This file is part of the iText (R) project.
Copyright (c) 1998-2024 Apryse Group NV
Authors: Apryse Software.
This program is offered under a commercial and under the AGPL license.
For commercial licensing, contact us at https://itextpdf.com/sales. For AGPL licensing, see below.
AGPL licensing:
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program 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 Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see {
private static final Border DEFAULT_BORDER = new SolidBorder(0.5f);
private int row;
private int col;
private int rowspan;
private int colspan;
protected DefaultAccessibilityProperties tagProperties;
/**
* Creates a cell which takes a custom amount of cell spaces in the table.
*
* @param rowspan the number of rows this cell must occupy. Negative numbers will make the argument default to 1.
* @param colspan the number of columns this cell must occupy. Negative numbers will make the argument default to 1.
*/
public Cell(int rowspan, int colspan) {
this.rowspan = Math.max(rowspan, 1);
this.colspan = Math.max(colspan, 1);
}
/**
* Creates a cell.
*/
public Cell () {
this(1, 1);
}
/**
* Gets a cell renderer for this element. Note that this method can be called more than once.
* By default each element should define its own renderer, but the renderer can be overridden by
* {@link #setNextRenderer(IRenderer)} method call.
* @return a cell renderer for this element
*/
@Override
public IRenderer getRenderer() {
CellRenderer cellRenderer = null;
if (nextRenderer != null) {
if (nextRenderer instanceof CellRenderer) {
IRenderer renderer = nextRenderer;
nextRenderer = nextRenderer.getNextRenderer();
cellRenderer = (CellRenderer) renderer;
} else {
Logger logger = LoggerFactory.getLogger(Table.class);
logger.error("Invalid renderer for Table: must be inherited from TableRenderer");
}
}
//cellRenderer could be null in case invalid type (see logger message above)
return cellRenderer == null ? makeNewRenderer() : cellRenderer;
}
/**
* Gets {@link #row the number of the row} in which the cell is located.
* @return the row number
*/
public int getRow() {
return row;
}
/**
* Gets {@link #row the number of the column} in which the cell is located.
* @return the column number
*/
public int getCol() {
return col;
}
/**
* Gets the {@link #rowspan rowspan} of the cell.
* @return the rowspan
*/
public int getRowspan() {
return rowspan;
}
/**
* Gets the {@link #colspan colspan} of the cell.
* @return the colspan
*/
public int getColspan() {
return colspan;
}
/**
* Adds any block element to the cell's contents.
*
* @param element a {@link BlockElement}
* @return this Element
*/
public Cell add(IBlockElement element) {
childElements.add(element);
return this;
}
/**
* Adds an image to the cell's contents.
*
* @param element an {@link Image}
* @return this Element
*/
public Cell add(Image element) {
childElements.add(element);
return this;
}
/**
* Clones a cell with its position, properties, and optionally its contents.
*
* @param includeContent whether or not to also include the contents of the cell.
* @return a clone of this Element
*/
public Cell clone(boolean includeContent) {
Cell newCell = new Cell(rowspan, colspan);
newCell.row = row;
newCell.col = col;
newCell.properties = new HashMap<>(properties);
if (null != styles) {
newCell.styles = new LinkedHashSet<>(styles);
}
if (includeContent) {
newCell.childElements = new ArrayList<>(childElements);
}
return newCell;
}
@Override
public T1 getDefaultProperty(int property) {
switch (property) {
case Property.BORDER:
return (T1) (Object) DEFAULT_BORDER;
case Property.PADDING_BOTTOM:
case Property.PADDING_LEFT:
case Property.PADDING_RIGHT:
case Property.PADDING_TOP:
return (T1) (Object) UnitValue.createPointValue(2f);
default:
return super.getDefaultProperty(property);
}
}
@Override
public String toString() {
return MessageFormatUtil.format("Cell[row={0}, col={1}, rowspan={2}, colspan={3}]", row, col, rowspan, colspan);
}
@Override
public AccessibilityProperties getAccessibilityProperties() {
if (tagProperties == null) {
tagProperties = new DefaultAccessibilityProperties(StandardRoles.TD);
}
return tagProperties;
}
@Override
protected IRenderer makeNewRenderer() {
return new CellRenderer(this);
}
/**
* Updates cell indexes.
*
* @param row the number of the row to update
* @param col the number of the col to update
* @param numberOfColumns to evaluate new colspan
*
* @return this {@link Cell} with updated fields
*/
protected Cell updateCellIndexes(int row, int col, int numberOfColumns) {
this.row = row;
this.col = col;
colspan = Math.min(colspan, numberOfColumns - this.col);
return this;
}
}
|