net.sf.jasperreports.engine
Interface JRTextField

All Superinterfaces:

JRAlignment, JRAnchor, JRChild, JRElement, JRHyperlink, JRTextElement

All Known Implementing Classes:

JRBaseTextField, JRDesignTextField, JRFillTextField

public interface JRTextField
extends JRTextElement, JRAnchor, JRHyperlink

An abstract representation of a report static text. It provides functionality for static texts.

Version:

$Id: JRTextField.java,v 1.10 2005/08/12 10:53:20 lucianc Exp $

Author:

Teodor Danciu (teodord@users.sourceforge.net)

Field Summary

static java.lang.String	STANDARD_DATE_FORMAT_DEFAULT Used in the date pattern to specify the default style.
static java.lang.String	STANDARD_DATE_FORMAT_FULL Used in the date pattern to specify the full style.
static java.lang.String	STANDARD_DATE_FORMAT_HIDE Used in the date pattern to specify that the date or time should not be included.
static java.lang.String	STANDARD_DATE_FORMAT_LONG Used in the date pattern to specify the long style.
static java.lang.String	STANDARD_DATE_FORMAT_MEDIUM Used in the date pattern to specify the medium style.
static java.lang.String	STANDARD_DATE_FORMAT_SEPARATOR Used in the date format pattern to separate the date and time styles.
static java.lang.String	STANDARD_DATE_FORMAT_SHORT Used in the date pattern to specify the short style.

Fields inherited from interface net.sf.jasperreports.engine.JRTextElement

LINE_SPACING_1_1_2, LINE_SPACING_DOUBLE, LINE_SPACING_SINGLE, ROTATION_LEFT, ROTATION_NONE, ROTATION_RIGHT, TEXT_ALIGN_CENTER, TEXT_ALIGN_JUSTIFIED, TEXT_ALIGN_LEFT, TEXT_ALIGN_RIGHT

Fields inherited from interface net.sf.jasperreports.engine.JRElement

MODE_OPAQUE, MODE_TRANSPARENT, POSITION_TYPE_FIX_RELATIVE_TO_BOTTOM, POSITION_TYPE_FIX_RELATIVE_TO_TOP, POSITION_TYPE_FLOAT, STRETCH_TYPE_NO_STRETCH, STRETCH_TYPE_RELATIVE_TO_BAND_HEIGHT, STRETCH_TYPE_RELATIVE_TO_TALLEST_OBJECT

Fields inherited from interface net.sf.jasperreports.engine.JRAlignment

HORIZONTAL_ALIGN_CENTER, HORIZONTAL_ALIGN_JUSTIFIED, HORIZONTAL_ALIGN_LEFT, HORIZONTAL_ALIGN_RIGHT, VERTICAL_ALIGN_BOTTOM, VERTICAL_ALIGN_JUSTIFIED, VERTICAL_ALIGN_MIDDLE, VERTICAL_ALIGN_TOP

Fields inherited from interface net.sf.jasperreports.engine.JRAnchor

NO_BOOKMARK

Fields inherited from interface net.sf.jasperreports.engine.JRHyperlink

HYPERLINK_TARGET_BLANK, HYPERLINK_TARGET_SELF, HYPERLINK_TYPE_LOCAL_ANCHOR, HYPERLINK_TYPE_LOCAL_PAGE, HYPERLINK_TYPE_NONE, HYPERLINK_TYPE_REFERENCE, HYPERLINK_TYPE_REMOTE_ANCHOR, HYPERLINK_TYPE_REMOTE_PAGE

Method Summary

JRGroup	getEvaluationGroup() Gets the evaluation group for this text field.
byte	getEvaluationTime() Gets the evaluation time for this text field.
JRExpression	getExpression() Gets the expression for this field.
java.lang.String	getPattern() Gets the pattern used for this text field.
boolean	isBlankWhenNull() Indicates whether an empty string will be displayed if the field's expression evaluates to null.
boolean	isStretchWithOverflow() Specifies whether the text field will stretch vertically if its text does not fit in one line.
void	setBlankWhenNull(boolean isBlank) Specifies whether an empty string sholuld be displayed if the field's expression evaluates to null.
void	setPattern(java.lang.String pattern) Sets the pattern used for this text field.
void	setStretchWithOverflow(boolean isStretchWithOverflow) Set to true if the text field should stretch vertically if its text does not fit in one line.

Methods inherited from interface net.sf.jasperreports.engine.JRTextElement

getBox, getFont, getLineSpacing, getRotation, getTextAlignment, isStyledText, setLineSpacing, setRotation, setStyledText, setTextAlignment

Methods inherited from interface net.sf.jasperreports.engine.JRElement

collectExpressions, getBackcolor, getElementGroup, getForecolor, getHeight, getKey, getMode, getPositionType, getPrintWhenExpression, getPrintWhenGroupChanges, getStretchType, getWidth, getX, getY, isPrintInFirstWholeBand, isPrintRepeatedValues, isPrintWhenDetailOverflows, isRemoveLineWhenBlank, setBackcolor, setForecolor, setMode, setPositionType, setPrintInFirstWholeBand, setPrintRepeatedValues, setPrintWhenDetailOverflows, setRemoveLineWhenBlank, setStretchType, setWidth, setX

Methods inherited from interface net.sf.jasperreports.engine.JRChild

getCopy, writeXml

Methods inherited from interface net.sf.jasperreports.engine.JRAlignment

getHorizontalAlignment, getVerticalAlignment, setHorizontalAlignment, setVerticalAlignment

Methods inherited from interface net.sf.jasperreports.engine.JRAnchor

getAnchorNameExpression, getBookmarkLevel

Methods inherited from interface net.sf.jasperreports.engine.JRHyperlink

getHyperlinkAnchorExpression, getHyperlinkPageExpression, getHyperlinkReferenceExpression, getHyperlinkTarget, getHyperlinkType

Field Detail

STANDARD_DATE_FORMAT_DEFAULT

static final java.lang.String STANDARD_DATE_FORMAT_DEFAULT

Used in the date pattern to specify the default style.

See Also:

DateFormat.DEFAULT, Constant Field Values

STANDARD_DATE_FORMAT_SHORT

static final java.lang.String STANDARD_DATE_FORMAT_SHORT

Used in the date pattern to specify the short style.

See Also:

DateFormat.SHORT, Constant Field Values

STANDARD_DATE_FORMAT_MEDIUM

static final java.lang.String STANDARD_DATE_FORMAT_MEDIUM

Used in the date pattern to specify the medium style.

See Also:

DateFormat.MEDIUM, Constant Field Values

STANDARD_DATE_FORMAT_LONG

static final java.lang.String STANDARD_DATE_FORMAT_LONG

Used in the date pattern to specify the long style.

See Also:

DateFormat.LONG, Constant Field Values

STANDARD_DATE_FORMAT_FULL

static final java.lang.String STANDARD_DATE_FORMAT_FULL

Used in the date pattern to specify the full style.

See Also:

DateFormat.FULL, Constant Field Values

STANDARD_DATE_FORMAT_HIDE

static final java.lang.String STANDARD_DATE_FORMAT_HIDE

Used in the date pattern to specify that the date or time should not be included.

See Also:

Constant Field Values

STANDARD_DATE_FORMAT_SEPARATOR

static final java.lang.String STANDARD_DATE_FORMAT_SEPARATOR

Used in the date format pattern to separate the date and time styles.

See Also:

Constant Field Values

Method Detail

isStretchWithOverflow

boolean isStretchWithOverflow()

Specifies whether the text field will stretch vertically if its text does not fit in one line.

Returns:

true if the text field will stretch vertically, false otherwise

setStretchWithOverflow

void setStretchWithOverflow(boolean isStretchWithOverflow)

Set to true if the text field should stretch vertically if its text does not fit in one line.

getEvaluationTime

byte getEvaluationTime()

Gets the evaluation time for this text field.

Returns:

one of the evaluation time constants in JRExpression

getPattern

java.lang.String getPattern()

Gets the pattern used for this text field. The pattern will be used in a SimpleDateFormat for dates and a DecimalFormat for numeric text fields. The pattern format must follow one of these two classes formatting rules, as specified in the JDK API docs.

Returns:

a string containing the pattern.

setPattern

void setPattern(java.lang.String pattern)

Sets the pattern used for this text field. The pattern will be used in a SimpleDateFormat for dates and a DecimalFormat for numeric text fields. The pattern format must follow one of these two classes formatting rules, as specified in the JDK API docs. If the pattern is incorrect, the exception thrown by formatter classes will be rethrown by the JasperReports fill engine.

isBlankWhenNull

boolean isBlankWhenNull()

Indicates whether an empty string will be displayed if the field's expression evaluates to null.

Returns:

true if an empty string will be displayed instead of null values, false otherwise

setBlankWhenNull

void setBlankWhenNull(boolean isBlank)

Specifies whether an empty string sholuld be displayed if the field's expression evaluates to null.

Parameters:

isBlank - true if an empty string will be displayed instead of null values, false otherwise

getEvaluationGroup

JRGroup getEvaluationGroup()

Gets the evaluation group for this text field. Used only when evaluation time is group.

See Also:

JRExpression.EVALUATION_TIME_GROUP

getExpression

JRExpression getExpression()

Gets the expression for this field. The result obtained after evaluating this expression will be dispayed as the field text.