org.pentaho.reporting.engine.classic.core.layout.model.table.columns

Class TableColumn

java.lang.Object

org.pentaho.reporting.engine.classic.core.layout.model.table.columns.TableColumn

public class TableColumn
extends Object

A column definition. A column has an effective definedWidth, which corresponds with the computed definedWidth of the content. If that definedWidth gets greater than the initial definedWidth (the definedWidth that has been computed by the table at the beginning of the rendering), we entered the auto-mode.

Once a column has been explicitly marked as validated, any attempt to redefine the computed sizes must fail. (This makes sure that the table stays in sync and does not get disordered if its rendered incrementally.)

A column is constrained by three metrics:

The Minimum ChunkSize defines the smallest non-breakable content item in the column. A column will always consume at least this space. (This is zero, if the column has overflow enabled.)

The Maximum Box-Width is the size the content would consume, if there is infinite space available. Manual linebreaks are taken into account, but not automatic ones.

If the column explicitly defines a width, the preferred size indicates that. If no preferred width is defined, the preferred size will be zero.

Author:

Thomas Morgner

Constructor Summary

Constructors

Constructor and Description
TableColumn(Border border, RenderLength definedWidth, boolean autoGenerated)

Method Summary

Modifier and Type	Method and Description
Border	getBorder()
long	getCachedSize(int colspan)
RenderLength	getDefinedWidth()
long	getEffectiveSize()
int	getMaxColspan()
boolean	isAutoGenerated()
boolean	isValidated()
void	setCachedSize(int colSpan, long size)
void	setEffectiveSize(long effectiveSize)
void	setValidated(boolean validated)
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

TableColumn

public TableColumn(Border border,
                   RenderLength definedWidth,
                   boolean autoGenerated)

Method Detail

getDefinedWidth

public RenderLength getDefinedWidth()

getBorder

public Border getBorder()

getEffectiveSize

public long getEffectiveSize()

setEffectiveSize

public void setEffectiveSize(long effectiveSize)

isValidated

public boolean isValidated()

setValidated

public void setValidated(boolean validated)

isAutoGenerated

public boolean isAutoGenerated()

setCachedSize

public void setCachedSize(int colSpan,
                          long size)

getCachedSize

public long getCachedSize(int colspan)

getMaxColspan

public int getMaxColspan()

toString

public String toString()

Overrides:

toString in class Object