net.sf.jasperreports.engine.JRPen 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 java.awt.Color;
import net.sf.jasperreports.engine.type.LineStyleEnum;
/**
* This interface is used to customize line settings such as width, style and color.
* This is useful for drawing graphic elements as well as drawing borders around text elements and images.
* Line Width
* The lineWidth
attribute represents the width of the line measured in points.
* Can be accessed using the {@link #getLineWidth()} method.
* Line Style
* The lineStyle
attribute represents the line style and has one of the following predefined values
* (see {@link #getLineStyleValue()}):
*
* Solid
* Dashed
* Dotted
* Double
*
* Line Color
* The lineColor
attribute represents the color of the line.
* Can be accessed using the {@link #getLineColor()} method.
*
* @author Teodor Danciu ([email protected])
*/
public interface JRPen
{
public static final Float LINE_WIDTH_0 = 0f;
public static final Float LINE_WIDTH_1 = 1f;
/**
* @deprecated Replaced by {@link #getPenContainer()}.
*/
public JRStyleContainer getStyleContainer();
/**
*
*/
public JRPenContainer getPenContainer();
/**
*
*/
public JRPen clone(JRPenContainer penContainer);
/**
* Gets the line width used for this pen.
* @return line width
*/
public Float getLineWidth();
public Float getOwnLineWidth();
/**
* @deprecated Replaced by {@link #setLineWidth(Float)}.
*/
public void setLineWidth(float lineWidth);
/**
* Sets the line width.
* @param lineWidth the line width
*/
public void setLineWidth(Float lineWidth);
/**
* Indicates the line style used for this pen.
* @return a value representing one of the line style constants in {@link LineStyleEnum}
*/
public LineStyleEnum getLineStyleValue();
/**
* Indicates the line style used for this pen.
* @return a value representing one of the line style constants in {@link LineStyleEnum}
*/
public LineStyleEnum getOwnLineStyleValue();
/**
* Specifies the line style.
* @param lineStyleEnum a value representing one of the line style constants in {@link LineStyleEnum}
*/
public void setLineStyle(LineStyleEnum lineStyleEnum);
/**
* Gets the line color.
*/
public Color getLineColor();
public Color getOwnLineColor();
/**
* Sets the line color.
*/
public void setLineColor(Color color);
}