net.sf.jasperreports.engine.JRFont Maven / Gradle / Ivy
Show all versions of jasperreports Show documentation
/*
* JasperReports - Free Java Reporting Library.
* Copyright (C) 2001 - 2023 Cloud Software Group, 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.annotations.properties.Property;
import net.sf.jasperreports.annotations.properties.PropertyScope;
import net.sf.jasperreports.properties.PropertyConstants;
/**
* An abstract representation of a font. Fonts in JasperReports are very complex because of the library portability
* across operating systems and export formats. This interface provides basic font functionality methods for
* managing font attributes and special PDF font attributes.
*
* Users can define report level fonts that can be referenced by name in text elements. Their default properties
* can be overridden in each element (for example, a text element can use a report level font and just change its
* "underline" attribute). All the "own" methods in this class actually return the override values of font properties.
* @author Teodor Danciu ([email protected])
*/
public interface JRFont extends JRStyleContainer
{
@Property(
category = PropertyConstants.CATEGORY_FILL,
defaultValue = "SansSerif",
scopes = {PropertyScope.CONTEXT},
sinceVersion = PropertyConstants.VERSION_1_3_0
)
public static final String DEFAULT_FONT_NAME = JRPropertiesUtil.PROPERTY_PREFIX + "default.font.name";
@Property(
category = PropertyConstants.CATEGORY_FILL,
valueType = Float.class,
defaultValue = "10",
scopes = {PropertyScope.CONTEXT},
sinceVersion = PropertyConstants.VERSION_1_3_0
)
public static final String DEFAULT_FONT_SIZE = JRPropertiesUtil.PROPERTY_PREFIX + "default.font.size";
@Property(
category = PropertyConstants.CATEGORY_EXPORT,
defaultValue = "Helvetica",
scopes = {PropertyScope.CONTEXT},
sinceVersion = PropertyConstants.VERSION_1_3_0
)
public static final String DEFAULT_PDF_FONT_NAME = JRPropertiesUtil.PROPERTY_PREFIX + "default.pdf.font.name";
@Property(
category = PropertyConstants.CATEGORY_EXPORT,
defaultValue = "Cp1252",
scopes = {PropertyScope.CONTEXT},
sinceVersion = PropertyConstants.VERSION_1_3_0
)
public static final String DEFAULT_PDF_ENCODING = JRPropertiesUtil.PROPERTY_PREFIX + "default.pdf.encoding";
@Property(
category = PropertyConstants.CATEGORY_EXPORT,
valueType = Boolean.class,
defaultValue = PropertyConstants.BOOLEAN_FALSE,
scopes = {PropertyScope.CONTEXT},
sinceVersion = PropertyConstants.VERSION_1_3_0
)
public static final String DEFAULT_PDF_EMBEDDED = JRPropertiesUtil.PROPERTY_PREFIX + "default.pdf.embedded";
/**
*
*/
public String getFontName();
/**
*
*/
public String getOwnFontName();
/**
*
*/
public void setFontName(String fontName);
/**
*
*/
public boolean isBold();
/**
*
*/
public Boolean isOwnBold();
/**
*
*/
public void setBold(Boolean isBold);
/**
*
*/
public boolean isItalic();
/**
*
*/
public Boolean isOwnItalic();
/**
*
*/
public void setItalic(Boolean isItalic);
/**
*
*/
public boolean isUnderline();
/**
*
*/
public Boolean isOwnUnderline();
/**
*
*/
public void setUnderline(Boolean isUnderline);
/**
*
*/
public boolean isStrikeThrough();
/**
*
*/
public Boolean isOwnStrikeThrough();
/**
*
*/
public void setStrikeThrough(Boolean isStrikeThrough);
/**
*
*/
public float getFontsize();
/**
*
*/
public Float getOwnFontsize();
/**
*
*/
public void setFontSize(Float size);
/**
*
*/
public String getPdfFontName();
/**
*
*/
public String getOwnPdfFontName();
/**
*
*/
public void setPdfFontName(String pdfFontName);
/**
*
*/
public String getPdfEncoding();
/**
*
*/
public String getOwnPdfEncoding();
/**
*
*/
public void setPdfEncoding(String pdfEncoding);
/**
*
*/
public boolean isPdfEmbedded();
/**
*
*/
public Boolean isOwnPdfEmbedded();
/**
*
*/
public void setPdfEmbedded(Boolean isPdfEmbedded);
}