net.sf.dynamicreports.report.builder.column.ValueColumnBuilder Maven / Gradle / Ivy
/*
* DynamicReports - Free Java reporting library for creating reports dynamically
*
* Copyright (C) 2010 - 2018 Ricardo Mariaca and the Dynamic Reports Contributors
*
* 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 Abstract ValueColumnBuilder class.
*
* @author Ricardo Mariaca, Jan Moxter
*
*/
@SuppressWarnings( {"unchecked", "deprecation"})
public abstract class ValueColumnBuilder, U> extends ColumnBuilder> {
private static final long serialVersionUID = Constants.SERIAL_VERSION_UID;
/**
* Constructor for ValueColumnBuilder.
*/
protected ValueColumnBuilder() {
super(new DRValueColumn<>(new DRTextField()));
}
/**
* setValueExpression.
*
* @param valueExpression a {@link net.sf.dynamicreports.report.definition.expression.DRIExpression} object.
*/
protected void setValueExpression(final DRIExpression valueExpression) {
getComponent().setValueExpression(valueExpression);
}
/**
* Specifies whether or not print a value if the value is the same as the previous value.
*
* @param printRepeatedDetailValues print repeated detail values
* @return a column builder
*/
public T setPrintRepeatedDetailValues(final Boolean printRepeatedDetailValues) {
getObject().setPrintRepeatedDetailValues(printRepeatedDetailValues);
return (T) this;
}
/**
* Sets the column value horizontal alignment.
*
* @param horizontalAlignment a {@link net.sf.dynamicreports.report.constant.HorizontalAlignment} object.
* @return a column builder
* @deprecated use setHorizontalTextAlignment instead
*/
@Deprecated
public T setHorizontalAlignment(final HorizontalAlignment horizontalAlignment) {
if (horizontalAlignment != null) {
getComponent().setHorizontalTextAlignment(HorizontalTextAlignment.valueOf(horizontalAlignment.name()));
} else {
getComponent().setHorizontalTextAlignment(null);
}
return (T) this;
}
/**
* Sets the column value horizontal text alignment.
*
* @param horizontalTextAlignment a {@link net.sf.dynamicreports.report.constant.HorizontalTextAlignment} object.
* @return a column builder
*/
public T setHorizontalTextAlignment(final HorizontalTextAlignment horizontalTextAlignment) {
getComponent().setHorizontalTextAlignment(horizontalTextAlignment);
return (T) this;
}
/**
* Sets the column value format pattern.
*
* @param pattern the format pattern
* @return a column builder
*/
public T setPattern(final String pattern) {
getComponent().setPattern(pattern);
return (T) this;
}
/**
* Sets the column value format pattern. The expression must be a type of String.
*
* @param patternExpression the format pattern expression
* @return a column builder
*/
public T setPattern(final DRIExpression patternExpression) {
getComponent().setPatternExpression(patternExpression);
return (T) this;
}
/**
* Sets the column value formatter expression.
*
* @param valueFormatter the value formatter expression
* @return a column builder
*/
public T setValueFormatter(final DRIValueFormatter valueFormatter) {
getComponent().setValueFormatter(valueFormatter);
return (T) this;
}
/**
* Sets the column data type.
*
* @param dataType the data type
* @return a column builder
*/
public T setDataType(final DRIDataType dataType) {
getComponent().setDataType(dataType);
return (T) this;
}
/**
* This method is used to define the preferred width of a column. The width is set to the columns multiplied by width of the character m for the font used
*
* @param columns the number of preferred columns >= 0
* @return a column builder
* @throws java.lang.IllegalArgumentException if columns is < 0
*/
public T setColumns(final Integer columns) {
getComponent().setColumns(columns);
return (T) this;
}
/**
* This method is used to define the fixed width of a column. The width is set to the columns multiplied by width of the character m for the font used
*
* @param columns the number of fixed columns >= 0
* @return a column builder
* @throws java.lang.IllegalArgumentException if columns is < 0
*/
public T setFixedColumns(final Integer columns) {
getComponent().setColumns(columns);
getComponent().setWidthType(ComponentDimensionType.FIXED);
return (T) this;
}
/**
* This method is used to define the minimum width of a column. The width is set to the columns multiplied by width of the character m for the font used
*
* @param columns the number of minimum columns >= 0
* @return a column builder
* @throws java.lang.IllegalArgumentException if columns is < 0
*/
public T setMinColumns(final Integer columns) {
getComponent().setColumns(columns);
getComponent().setWidthType(ComponentDimensionType.EXPAND);
return (T) this;
}
/**
* This method is used to define the preferred height of a column. The height is set to the rows multiplied by height of the font
*
* @param rows the number of preferred rows >= 0
* @return a column builder
* @throws java.lang.IllegalArgumentException if rows is < 0
*/
public T setRows(final Integer rows) {
getComponent().setRows(rows);
return (T) this;
}
/**
* This method is used to define the fixed height of a column. The height is set to the rows multiplied by height of the font
*
* @param rows the number of fixed rows >= 0
* @return a column builder
* @throws java.lang.IllegalArgumentException if rows is < 0
*/
public T setFixedRows(final Integer rows) {
getComponent().setRows(rows);
getComponent().setHeightType(ComponentDimensionType.FIXED);
return (T) this;
}
/**
* This method is used to define the minimum height of a column. The height is set to the rows multiplied by height of the font
*
* @param rows the number of minimum rows >= 0
* @return a column builder
* @throws java.lang.IllegalArgumentException if rows is < 0
*/
public T setMinRows(final Integer rows) {
getComponent().setRows(rows);
getComponent().setHeightType(ComponentDimensionType.EXPAND);
return (T) this;
}
/**
* setAnchorName.
*
* @param anchorName a {@link java.lang.String} object.
* @return a T object.
*/
public T setAnchorName(final String anchorName) {
getComponent().setAnchorNameExpression(Expressions.text(anchorName));
return (T) this;
}
/**
* setAnchorName.
*
* @param anchorNameExpression a {@link net.sf.dynamicreports.report.definition.expression.DRIExpression} object.
* @return a T object.
*/
public T setAnchorName(final DRIExpression anchorNameExpression) {
getComponent().setAnchorNameExpression(anchorNameExpression);
return (T) this;
}
/**
* setBookmarkLevel.
*
* @param bookmarkLevel a {@link java.lang.Integer} object.
* @return a T object.
*/
public T setBookmarkLevel(final Integer bookmarkLevel) {
getComponent().setBookmarkLevel(bookmarkLevel);
return (T) this;
}
/**
* Sets the column value hyperlink.
*
* @param hyperLink the value hyperlink
* @return a column builder
*/
public T setHyperLink(final HyperLinkBuilder hyperLink) {
if (hyperLink != null) {
getComponent().setHyperLink(hyperLink.getHyperLink());
} else {
getComponent().setHyperLink(null);
}
return (T) this;
}
/**
* Sets the preferred width of a column.
*
* @param width the column preferred width >= 0
* @return a column builder
* @throws java.lang.IllegalArgumentException if width is < 0
* @see net.sf.dynamicreports.report.builder.Units
*/
public T setWidth(final Integer width) {
getComponent().setWidth(width);
return (T) this;
}
/**
* Sets the fixed width of a column.
*
* @param width the column fixed width >= 0
* @return a column builder
* @throws java.lang.IllegalArgumentException if width is < 0
* @see net.sf.dynamicreports.report.builder.Units
*/
public T setFixedWidth(final Integer width) {
getComponent().setWidth(width);
getComponent().setWidthType(ComponentDimensionType.FIXED);
return (T) this;
}
/**
* Sets the minimum width of a column.
*
* @param width the column minimum width >= 0
* @return a column builder
* @throws java.lang.IllegalArgumentException if width is < 0
* @see net.sf.dynamicreports.report.builder.Units
*/
public T setMinWidth(final Integer width) {
getComponent().setWidth(width);
getComponent().setWidthType(ComponentDimensionType.EXPAND);
return (T) this;
}
/**
* Sets the preferred height of a column.
*
* @param height the column preferred height >= 0
* @return a column builder
* @throws java.lang.IllegalArgumentException if height is < 0
* @see net.sf.dynamicreports.report.builder.Units
*/
public T setHeight(final Integer height) {
getComponent().setHeight(height);
return (T) this;
}
/**
* Sets the fixed height of a column.
*
* @param height the column fixed height >= 0
* @return a column builder
* @throws java.lang.IllegalArgumentException if height is < 0
* @see net.sf.dynamicreports.report.builder.Units
*/
public T setFixedHeight(final Integer height) {
getComponent().setHeight(height);
getComponent().setHeightType(ComponentDimensionType.FIXED);
return (T) this;
}
/**
* Sets the minimum height of a column.
*
* @param height the column minimum height >= 0
* @return a column builder
* @throws java.lang.IllegalArgumentException if height is < 0
* @see net.sf.dynamicreports.report.builder.Units
*/
public T setMinHeight(final Integer height) {
getComponent().setHeight(height);
getComponent().setHeightType(ComponentDimensionType.EXPAND);
return (T) this;
}
/**
* setStretchWithOverflow.
*
* @param stretchWithOverflow a {@link java.lang.Boolean} object.
* @return a T object.
* @deprecated replaced by {@link #setTextAdjust(TextAdjust)}
*/
@Deprecated
public T setStretchWithOverflow(final Boolean stretchWithOverflow) {
getComponent().setStretchWithOverflow(stretchWithOverflow);
return (T) this;
}
/**
* setTextAdjust.
*
* @param textAdjust a {@link net.sf.dynamicreports.report.constant.TextAdjust} object.
* @return a T object.
*/
public T setTextAdjust(final TextAdjust textAdjust) {
getComponent().setTextAdjust(textAdjust);
return (T) this;
}
/**
* printInFirstWholeBand.
*
* @return a T object.
*/
public T printInFirstWholeBand() {
return setPrintInFirstWholeBand(true);
}
/**
* setPrintInFirstWholeBand.
*
* @param printInFirstWholeBand a {@link java.lang.Boolean} object.
* @return a T object.
*/
public T setPrintInFirstWholeBand(final Boolean printInFirstWholeBand) {
getComponent().setPrintInFirstWholeBand(printInFirstWholeBand);
return (T) this;
}
/**
* printWhenDetailOverflows.
*
* @return a T object.
*/
public T printWhenDetailOverflows() {
return setPrintWhenDetailOverflows(true);
}
/**
* setPrintWhenDetailOverflows.
*
* @param printWhenDetailOverflows a {@link java.lang.Boolean} object.
* @return a T object.
*/
public T setPrintWhenDetailOverflows(final Boolean printWhenDetailOverflows) {
getComponent().setPrintWhenDetailOverflows(printWhenDetailOverflows);
return (T) this;
}
/**
* Adds a jasper property to the column value.
*
* @param propertyExpression the property expression
* @return a column builder
*/
public T addProperty(final DRIPropertyExpression propertyExpression) {
getComponent().addPropertyExpression(propertyExpression);
return (T) this;
}
/**
* Adds a jasper property to the column value.
*
* @param name the property name
* @param valueExpression the property value expression
* @return a column builder
*/
public T addProperty(final String name, final DRIExpression valueExpression) {
getComponent().addPropertyExpression(Expressions.property(name, valueExpression));
return (T) this;
}
/**
* Adds a jasper property to the column value.
*
* @param name the property name
* @param value the property value
* @return a column builder
*/
public T addProperty(final String name, final String value) {
getComponent().addPropertyExpression(Expressions.property(name, value));
return (T) this;
}
/** {@inheritDoc} */
@Override
protected DRTextField getComponent() {
return (DRTextField) getObject().getComponent();
}
}