xdev.tableexport.config.PageProperties Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of biapi Show documentation

XDEV BI Suite

There is a newer version: 6.0.1

package xdev.tableexport.config;

/*-
 * #%L
 * XDEV BI Suite
 * %%
 * Copyright (C) 2011 - 2020 XDEV Software
 * %%
 * This program 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.
 * 
 * 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 General Lesser Public License for more details.
 * 
 * You should have received a copy of the GNU General Lesser Public
 * License along with this program.  If not, see
 * .
 * #L%
 */


/**
 * 
 * @author XDEV Software(FHAE)
 */
public interface PageProperties
{
	
	
	/**
	 * Return page height (including margins etc.).
	 * 
	 * @return the page height value as int
	 */
	public int getPageHeight();
	

	/**
	 * Return the spacing between columns.
	 * 
	 * @return the spacing value between columns as int
	 */
	public int getColumnSpacing();
	

	/**
	 * Return the left margin. The working space is calculated by subtracting the margins from the page width.
	 * 
	 * @return the left margin value as int
	 */
	public int getLeftMargin();
	

	/**
	 * Return the right margin. The working space is calculated by subtracting the margins from the page width.
	 * 
	 * @return the right margin value as int
	 */
	public int getRightMargin();
	

	/**
	 * Return the top margin. The working space is calculated by subtracting the margins from the page height.
	 * 
	 * @return the top margin value as int
	 */
	public int getTopMargin();
	

	/**
	 * Return the bottom margin. The working space is calculated by subtracting the margins from the page height.
	 * 
	 * @return the bottom margin value as int
	 */
	public int getBottomMargin();
	
}