JRTextElement.java
| Index Score | ||
|---|---|---|
![]() |
![]() |
net.sf.jasperreports.engine |
![]() |
![]() |
JasperReports |
View: Reasons, Metrics, Source Code
These are the metrics that contribute to the Enerjy Score for this file, ranked by impact. So the metrics listed at the top influence the score to a greater extent that the metrics listed at the bottom.
/*
* ============================================================================
* GNU Lesser General Public License
* ============================================================================
*
* JasperReports - Free Java report-generating library.
* Copyright (C) 2001-2006 JasperSoft Corporation http://www.jaspersoft.com
*
* This library 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 2.1 of the License, or (at your option) any later version.
*
* This library 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 this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
*
* JasperSoft Corporation
* 303 Second Street, Suite 450 North
* San Francisco, CA 94107
* http://www.jaspersoft.com
*/
package net.sf.jasperreports.engine;
import net.sf.jasperreports.engine.util.JRProperties;
/**
* An abstract representation of a report text element. It provides basic functionality for static texts and text fields.
*
* @author Teodor Danciu (teodord@users.sourceforge.net)
* @version $Id: JRTextElement.java 2006 2007-12-05 14:28:33Z teodord $
*/
public interface JRTextElement extends JRElement, JRAlignment, JRBox, JRFont, JRCommonText
{
/**
* Property used to determine whether the fill process must preserve the original text
* for text elements that are not able to fit their entire contents.
*
* <p>
* When this property is set, the engine saves the original text in the
* {@link JRPrintText print text object} along with the index at which the
* text is to be truncated by the print object.
* </p>
*
* <p>
* This property can be set at the following levels (listed in the order of precedence):
* <ul>
* <li>at {@link JRTextElement text element} level</li>
* <li>at {@link JRReport report} level</li>
* <li>globally in jasperreports.properties or via {@link JRProperties}</li>
* </ul>
* </p>
*
* @see JRPrintText#getFullText()
* @see JRPrintText#getText()
* @see JRPrintText#getTextTruncateIndex()
*/
public static final String PROPERTY_PRINT_KEEP_FULL_TEXT = JRProperties.PROPERTY_PREFIX + "print.keep.full.text";
/**
* Boolean property that determines whether text elements are to be truncated
* at the last character that fits.
*
* <p>
* By default, when the entire text of a text element does not fit the element's area,
* the text is truncated at the last word that fits the area.
* This property can instruct the engine to truncate the text at the last character
* that fits.
* </p>
*
* <p>
* The property can be set at the same levels as {@link #PROPERTY_PRINT_KEEP_FULL_TEXT}.
* </p>
*/
public static final String PROPERTY_TRUNCATE_AT_CHAR = JRProperties.PROPERTY_PREFIX + "text.truncate.at.char";
/**
* Property whose value is used as a suffix for the truncated text.
*
* <p>
* The suffix is appended to the text when truncation occurs.
* If the property is not defined or empty (which is the case by default),
* no suffix will be used when the text is truncated.
* </p>
*
* <p>
* The property can be set at the same levels as {@link #PROPERTY_PRINT_KEEP_FULL_TEXT}.
* </p>
*/
public static final String PROPERTY_TRUNCATE_SUFFIX = JRProperties.PROPERTY_PREFIX + "text.truncate.suffix";
/**
* @deprecated Replaced by {@link JRAlignment#HORIZONTAL_ALIGN_LEFT}.
*/
public static final byte TEXT_ALIGN_LEFT = HORIZONTAL_ALIGN_LEFT;
/**
* @deprecated Replaced by {@link JRAlignment#HORIZONTAL_ALIGN_CENTER}.
*/
public static final byte TEXT_ALIGN_CENTER = HORIZONTAL_ALIGN_CENTER;
/**
* @deprecated Replaced by {@link JRAlignment#HORIZONTAL_ALIGN_RIGHT}.
*/
public static final byte TEXT_ALIGN_RIGHT = HORIZONTAL_ALIGN_RIGHT;
/**
* @deprecated Replaced by {@link JRAlignment#HORIZONTAL_ALIGN_JUSTIFIED}.
*/
public static final byte TEXT_ALIGN_JUSTIFIED = HORIZONTAL_ALIGN_JUSTIFIED;
/**
* Constant useful for displaying the text without rotating it
*/
public static final byte ROTATION_NONE = 0;
/**
* Constant useful for rotating the text 90 degrees counter clockwise.
*/
public static final byte ROTATION_LEFT = 1;
/**
* Constant useful for rotating the text 90 degrees clockwise.
*/
public static final byte ROTATION_RIGHT = 2;
/**
* Constant useful for rotating the text 180 degrees.
*/
public static final byte ROTATION_UPSIDE_DOWN = 3;
/**
* Constant for setting normal spacing between lines.
*/
public static final byte LINE_SPACING_SINGLE = 0;
/**
* Constant for setting spacing between lines to 50% more than normal.
*/
public static final byte LINE_SPACING_1_1_2 = 1;
/**
* Constant for setting spacing between lines to double size.
*/
public static final byte LINE_SPACING_DOUBLE = 2;
/**
* Gets the text horizontal alignment.
* @return a value representing one of the horizontal alignment constants in {@link JRAlignment}
* @deprecated Replaced by {@link #getHorizontalAlignment()}.
*/
public byte getTextAlignment();
/**
* Sets the text horizontal alignment.
* @param horizontalAlignment a value representing one of the horizontal alignment constants in {@link JRAlignment}
* @deprecated Replaced by {@link #setHorizontalAlignment(byte)}.
*/
public void setTextAlignment(byte horizontalAlignment);
/**
* Sets the text rotation.
* @param rotation a value representing one of the rotation constants in this class
*/
public void setRotation(byte rotation);
public void setRotation(Byte rotation);
/**
* Sets the line spacing.
* @param lineSpacing a value representing one of the line spacing constants in this class
*/
public void setLineSpacing(byte lineSpacing);
public void setLineSpacing(Byte lineSpacing);
/**
* Specifies whether the text can contain style tags.
*/
public void setStyledText(boolean isStyledText);
public void setStyledText(Boolean isStyledText);
/**
* Returns an object containing all border and padding properties for this text element
* @deprecated Replaced by {@link JRBoxContainer#getLineBox()}
*/
public JRBox getBox();
/**
* Returns an object containing all font properties for this text element
* @deprecated
*/
public JRFont getFont();
}
The table below shows all metrics for JRTextElement.java.




