net.sf.dynamicreports.report.builder.component.PageXofYBuilder 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 .
*/
package net.sf.dynamicreports.report.builder.component;
import net.sf.dynamicreports.report.base.component.DRPageXofY;
import net.sf.dynamicreports.report.builder.expression.SystemMessageExpression;
import net.sf.dynamicreports.report.constant.ComponentDimensionType;
import net.sf.dynamicreports.report.constant.Constants;
/**
* @author Ricardo Mariaca ([email protected])
*/
public class PageXofYBuilder extends AbstractFormatFieldBuilder {
private static final long serialVersionUID = Constants.SERIAL_VERSION_UID;
protected PageXofYBuilder() {
super(new DRPageXofY());
}
/**
* Sets the pageX component preferred width.
* @see net.sf.dynamicreports.report.builder.Units
*
* @param width the pageX component preferred width >= 0
* @exception IllegalArgumentException if width
is < 0
*/
public PageXofYBuilder setPageXWidth(Integer width) {
getObject().setPageXWidth(width);
return this;
}
/**
* Sets the pageX component fixed width.
* @see net.sf.dynamicreports.report.builder.Units
*
* @param width the pageX component fixed width >= 0
* @exception IllegalArgumentException if width
is < 0
*/
public PageXofYBuilder setPageXFixedWidth(Integer width) {
getObject().setPageXWidth(width);
getObject().setPageXWidthType(ComponentDimensionType.FIXED);
return this;
}
/**
* Sets the pageX component minimum width.
* @see net.sf.dynamicreports.report.builder.Units
*
* @param width the pageX component minimum width >= 0
* @exception IllegalArgumentException if width
is < 0
*/
public PageXofYBuilder setPageXMinWidth(Integer width) {
getObject().setPageXWidth(width);
getObject().setPageXWidthType(ComponentDimensionType.EXPAND);
return this;
}
/**
* Sets the pageY component preferred width.
* @see net.sf.dynamicreports.report.builder.Units
*
* @param width the pageY component preferred width >= 0
* @exception IllegalArgumentException if width
is < 0
*/
public PageXofYBuilder setPageYWidth(Integer width) {
getObject().setPageYWidth(width);
return this;
}
/**
* Sets the pageY component fixed width.
* @see net.sf.dynamicreports.report.builder.Units
*
* @param width the pageY component fixed width >= 0
* @exception IllegalArgumentException if width
is < 0
*/
public PageXofYBuilder setPageYFixedWidth(Integer width) {
getObject().setPageYWidth(width);
getObject().setPageYWidthType(ComponentDimensionType.FIXED);
return this;
}
/**
* Sets the pageY component minimum width.
* @see net.sf.dynamicreports.report.builder.Units
*
* @param width the pageY component minimum width >= 0
* @exception IllegalArgumentException if width
is < 0
*/
public PageXofYBuilder setPageYMinWidth(Integer width) {
getObject().setPageYWidth(width);
getObject().setPageYWidthType(ComponentDimensionType.EXPAND);
return this;
}
@Override
protected void configure() {
if (getObject().getFormatExpression() == null) {
setFormatExpression(new SystemMessageExpression("page_x_of_y"));
}
super.configure();
}
}