net.sf.dynamicreports.report.builder.column.ColumnBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of dynamicreports-core Show documentation
Show all versions of dynamicreports-core Show documentation
DynamicReports is an open source Java reporting library based on JasperReports. It allows to create dynamic report designs and it doesn't need a visual report designer.
You can very quickly create reports and produce documents that can be displayed, printed or exported into many popular formats such as PDF, Excel, Word and others.
/**
* DynamicReports - Free Java reporting library for creating reports dynamically
*
* Copyright (C) 2010 - 2016 Ricardo Mariaca
* http://www.dynamicreports.org
*
* This file is part of DynamicReports.
*
* DynamicReports 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.
*
* DynamicReports 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 DynamicReports. If not, see , U extends DRColumn> extends AbstractBuilder implements ColumnGridComponentBuilder {
private static final long serialVersionUID = Constants.SERIAL_VERSION_UID;
protected ColumnBuilder(U column) {
super(column);
}
/**
* Sets the column title.
*
* @param titleExpression the title expression
* @return a column builder
*/
public T setTitle(DRIExpression titleExpression) {
getObject().setTitleExpression(titleExpression);
return (T) this;
}
/**
* Sets the column title.
*
* @param title the title
* @return a column builder
*/
public T setTitle(String title) {
getObject().setTitleExpression(Expressions.text(title));
return (T) this;
}
/**
* Sets the column title style.
*
* @param titleStyle the title style
* @return a column builder
*/
public T setTitleStyle(ReportStyleBuilder titleStyle) {
if (titleStyle != null) {
getObject().setTitleStyle(titleStyle.getStyle());
}
else {
getObject().setTitleStyle(null);
}
return (T) this;
}
/**
* Sets the column value style.
*
* @param style the value style
* @return a column builder
*/
public T setStyle(ReportStyleBuilder style) {
if (style != null) {
getComponent().setStyle(style.getStyle());
}
else {
getComponent().setStyle(null);
}
return (T) this;
}
/**
* Sets the print when expression. The expression must be a type of Boolean and it decides whether or not a column value will be printed.
*
* @param printWhenExpression the print expression
* @return a column builder
*/
public T setPrintWhenExpression(DRIExpression printWhenExpression) {
getComponent().setPrintWhenExpression(printWhenExpression);
return (T) this;
}
/**
* This method is used to define the preferred height of a column title.
* The height is set to the rows multiplied by height of the font
*
* @param rows the number of preferred rows >= 0
* @exception IllegalArgumentException if rows is < 0
* @return a column builder
*/
public T setTitleRows(Integer rows) {
getObject().setTitleRows(rows);
return (T) this;
}
/**
* This method is used to define the fixed height of a column title.
* The height is set to the rows multiplied by height of the font
*
* @param rows the number of fixed rows >= 0
* @exception IllegalArgumentException if rows is < 0
* @return a column builder
*/
public T setTitleFixedRows(Integer rows) {
getObject().setTitleRows(rows);
getObject().setTitleHeightType(ComponentDimensionType.FIXED);
return (T) this;
}
/**
* This method is used to define the minimum height of a column title.
* The height is set to the rows multiplied by height of the font
*
* @param rows the number of minimum rows >= 0
* @exception IllegalArgumentException if rows is < 0
* @return a column builder
*/
public T setTitleMinRows(Integer rows) {
getObject().setTitleRows(rows);
getObject().setTitleHeightType(ComponentDimensionType.EXPAND);
return (T) this;
}
/**
* Sets the preferred height of a column title.
* @see net.sf.dynamicreports.report.builder.Units
*
* @param height the column title preferred height >= 0
* @exception IllegalArgumentException if height is < 0
* @return a column builder
*/
public T setTitleHeight(Integer height) {
getObject().setTitleHeight(height);
return (T) this;
}
/**
* Sets the fixed height of a column title.
* @see net.sf.dynamicreports.report.builder.Units
*
* @param height the column title fixed height >= 0
* @exception IllegalArgumentException if height is < 0
* @return a column builder
*/
public T setTitleFixedHeight(Integer height) {
getObject().setTitleHeight(height);
getObject().setTitleHeightType(ComponentDimensionType.FIXED);
return (T) this;
}
/**
* Sets the minimum height of a column title.
* @see net.sf.dynamicreports.report.builder.Units
*
* @param height the column title minimum height >= 0
* @exception IllegalArgumentException if height is < 0
* @return a column builder
*/
public T setTitleMinHeight(Integer height) {
getObject().setTitleHeight(height);
getObject().setTitleHeightType(ComponentDimensionType.EXPAND);
return (T) this;
}
public T setTitleStretchWithOverflow(Boolean stretchWithOverflow) {
getObject().setTitleStretchWithOverflow(stretchWithOverflow);
return (T) this;
}
/**
* Adds a jasper property to the column title.
*
* @param propertyExpression the property expression
* @return a column builder
*/
public T addTitleProperty(DRIPropertyExpression propertyExpression) {
getObject().addTitlePropertyExpression(propertyExpression);
return (T) this;
}
/**
* Adds a jasper property to the column title.
*
* @param name the property name
* @param valueExpression the property value expression
* @return a column builder
*/
public T addTitleProperty(String name, DRIExpression valueExpression) {
getObject().addTitlePropertyExpression(Expressions.property(name, valueExpression));
return (T) this;
}
/**
* Adds a jasper property to the column title.
*
* @param name the property name
* @param value the property value
* @return a column builder
*/
public T addTitleProperty(String name, String value) {
getObject().addTitlePropertyExpression(Expressions.property(name, value));
return (T) this;
}
protected DRComponent getComponent() {
return (DRComponent) getObject().getComponent();
}
public U getColumn() {
return build();
}
}