net.sf.jasperreports.engine.JRLine Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jasperreports Show documentation
Show all versions of jasperreports Show documentation
Free Java Reporting Library
/*
* JasperReports - Free Java Reporting Library.
* Copyright (C) 2001 - 2019 TIBCO Software Inc. All rights reserved.
* http://www.jaspersoft.com
*
* Unless you have purchased a commercial license agreement from Jaspersoft,
* the following license terms apply:
*
* This program is part of JasperReports.
*
* JasperReports 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.
*
* JasperReports 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 JasperReports. If not, see .
*/
package net.sf.jasperreports.engine;
import net.sf.jasperreports.engine.type.LineDirectionEnum;
/**
* An abstract representation of a graphic element representing a straight line.
*
* When displaying a line element, JasperReports draws one of the two diagonals of the
* rectangle represented by the x
, y
, width
, and
* height
attributes specified for this element.
*
* The direction
attribute (see {@link #getDirectionValue()}) determines which
* one of the two diagonals of the rectangle should be drawn:
*
* TopDown
- draws a diagonal line from the top-left corner of the
* rectangle to the bottom-right corner.
* BottomUp
- draws a diagonal line from the bottom-left corner to the
* upper-right corner.
*
*
* The default direction for a line is top-down.
*
* One can draw vertical lines by specifying width="1"
and horizontal lines by setting
* height="1"
. For vertical lines, the direction is not important.
*
* @author Teodor Danciu ([email protected])
*/
public interface JRLine extends JRGraphicElement
{
/**
* Gets the line direction.
* @return a value representing one of the line direction constants in {@link LineDirectionEnum}
*/
public LineDirectionEnum getDirectionValue();
/**
* Sets the line direction.
* @param lineDirectionEnum a value representing one of the line direction constants in {@link LineDirectionEnum}
*/
public void setDirection(LineDirectionEnum lineDirectionEnum);
}