net.sf.jasperreports.engine.base

Class JRBaseTextField

java.lang.Object

net.sf.jasperreports.engine.base.JRBaseElement

net.sf.jasperreports.engine.base.JRBaseTextElement

net.sf.jasperreports.engine.base.JRBaseTextField

All Implemented Interfaces:

Serializable, Cloneable, JRChangeEventsSupport, JRAlignment, JRAnchor, JRBoxContainer, JRChild, JRCloneable, JRCommonElement, JRCommonText, JRElement, JREvaluation, JRFont, JRHyperlink, JRIdentifiable, JRParagraphContainer, JRPropertiesHolder, JRStyleContainer, JRTextAlignment, JRTextElement, JRTextField, JRVisitable

public class JRBaseTextField
extends JRBaseTextElement
implements JRTextField

This class is used for representing a text field.

Author:

Teodor Danciu (teodord@users.sourceforge.net)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected JRExpression	anchorNameExpression
protected int	bookmarkLevel The bookmark level for the anchor associated with this field.
protected JRGroup	evaluationGroup
protected EvaluationTimeEnum	evaluationTimeValue
protected JRExpression	expression
protected JRExpression	hyperlinkAnchorExpression
protected JRExpression	hyperlinkPageExpression
protected JRExpression	hyperlinkReferenceExpression
protected JRExpression	hyperlinkWhenExpression
protected Boolean	isBlankWhenNull
protected boolean	isStretchWithOverflow
protected String	linkTarget
protected String	linkType
protected String	pattern
protected JRExpression	patternExpression
static String	PROPERTY_STRETCH_WITH_OVERFLOW

Fields inherited from class net.sf.jasperreports.engine.base.JRBaseTextElement

fontName, fontsize, horizontalTextAlign, isBold, isItalic, isPdfEmbedded, isStrikeThrough, isUnderline, lineBox, markup, paragraph, pdfEncoding, pdfFontName, rotationValue, verticalTextAlign

Fields inherited from class net.sf.jasperreports.engine.base.JRBaseElement

backcolor, defaultStyleProvider, elementGroup, forecolor, height, isPrintInFirstWholeBand, isPrintRepeatedValues, isPrintWhenDetailOverflows, isRemoveLineWhenBlank, key, modeValue, parentStyle, parentStyleNameReference, positionTypeValue, printWhenExpression, printWhenGroupChanges, PROPERTY_POSITION_TYPE, PROPERTY_PRINT_IN_FIRST_WHOLE_BAND, PROPERTY_PRINT_REPEATED_VALUES, PROPERTY_PRINT_WHEN_DETAIL_OVERFLOWS, PROPERTY_REMOVE_LINE_WHEN_BLANK, PROPERTY_STRETCH_TYPE, PROPERTY_WIDTH, PROPERTY_X, stretchTypeValue, uuid, width, x, y

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

FORMAT_TIMEZONE_SYSTEM, PROPERTY_FORMAT_TIMEZONE, PROPERTY_PATTERN_DATE, PROPERTY_PATTERN_DATETIME, PROPERTY_PATTERN_INTEGER, PROPERTY_PATTERN_NUMBER, PROPERTY_PATTERN_TIME, PROPERTY_SQL_DATE_FORMAT_TIMEZONE, PROPERTY_SQL_TIME_FORMAT_TIMEZONE, PROPERTY_SQL_TIMESTAMP_FORMAT_TIMEZONE

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

PROPERTY_PRINT_KEEP_FULL_TEXT, PROPERTY_SAVE_LINE_BREAKS, PROPERTY_TRUNCATE_AT_CHAR, PROPERTY_TRUNCATE_SUFFIX

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

DEFAULT_FONT_NAME, DEFAULT_FONT_SIZE, DEFAULT_PDF_EMBEDDED, DEFAULT_PDF_ENCODING, DEFAULT_PDF_FONT_NAME

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

MARKUP_HTML, MARKUP_NONE, MARKUP_RTF, MARKUP_STYLED_TEXT

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

NO_BOOKMARK

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JRBaseTextField(JRTextField textField, JRBaseObjectFactory factory) Initializes the text field properties.

Method Summary

Methods

Modifier and Type	Method and Description
Object	clone()
void	collectExpressions(JRExpressionCollector collector)
JRExpression	getAnchorNameExpression() Returns an expression whose value represents the anchor name.
int	getBookmarkLevel() Returns the level of the bookmark corresponding to the anchor.
JRGroup	getEvaluationGroup() Gets the evaluation group for this text field.
EvaluationTimeEnum	getEvaluationTimeValue() Gets the evaluation time for this text field.
JRExpression	getExpression() Gets the expression for this field.
JRExpression	getHyperlinkAnchorExpression() Returns the expression whose value represents the anchor.
JRExpression	getHyperlinkPageExpression() Returns an integer representing the page index of the link.
JRHyperlinkParameter[]	getHyperlinkParameters() Returns the list of hyperlink parameters.
JRExpression	getHyperlinkReferenceExpression() Returns the expression whose value represents the hyperlink reference.
byte	getHyperlinkTarget() Retrieves the hyperlink target for the element.
JRExpression	getHyperlinkTooltipExpression() Returns the expression which will generate the hyperlink tooltip.
byte	getHyperlinkType() Deprecated. Replaced by getHyperlinkTypeValue().
HyperlinkTypeEnum	getHyperlinkTypeValue() Retrieves the hyperlink type for the element.
JRExpression	getHyperlinkWhenExpression() Returns the expression that is evaluated in order to decide if the hyperlink should be displayed.
String	getLinkTarget() Returns the hyperlink target name.
String	getLinkType() Returns the hyperlink type.
String	getOwnPattern()
String	getPattern() Gets the pattern used for this text field.
JRExpression	getPatternExpression() Gets the pattern expression, in case the patter needs to be dynamic.
boolean	isBlankWhenNull() Indicates whether an empty string will be displayed if the field's expression evaluates to null.
Boolean	isOwnBlankWhenNull()
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	setBlankWhenNull(Boolean isBlank)
void	setPattern(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.
void	visit(JRVisitor visitor)

Methods inherited from class net.sf.jasperreports.engine.base.JRBaseTextElement

getDefaultLineColor, getFont, getFontName, getFontsize, getFontSize, getHorizontalAlignmentValue, getHorizontalTextAlign, getLineBox, getLineSpacingValue, getMarkup, getModeValue, getOwnFontName, getOwnFontsize, getOwnFontSize, getOwnHorizontalAlignmentValue, getOwnHorizontalTextAlign, getOwnLineSpacingValue, getOwnMarkup, getOwnPdfEncoding, getOwnPdfFontName, getOwnRotationValue, getOwnVerticalAlignmentValue, getOwnVerticalTextAlign, getParagraph, getPdfEncoding, getPdfFontName, getRotationValue, getVerticalAlignmentValue, getVerticalTextAlign, isBold, isItalic, isOwnBold, isOwnItalic, isOwnPdfEmbedded, isOwnStrikeThrough, isOwnUnderline, isPdfEmbedded, isStrikeThrough, isUnderline, setBold, setBold, setFontName, setFontSize, setFontSize, setFontSize, setHorizontalAlignment, setHorizontalTextAlign, setItalic, setItalic, setLineSpacing, setMarkup, setPdfEmbedded, setPdfEmbedded, setPdfEncoding, setPdfFontName, setRotation, setStrikeThrough, setStrikeThrough, setUnderline, setUnderline, setVerticalAlignment, setVerticalTextAlign

Methods inherited from class net.sf.jasperreports.engine.base.JRBaseElement

clone, clone, getBackcolor, getBaseStyle, getDefaultStyleProvider, getElementGroup, getEventSupport, getForecolor, getHeight, getKey, getOwnBackcolor, getOwnForecolor, getOwnModeValue, getParentProperties, getPositionTypeValue, getPrintWhenExpression, getPrintWhenGroupChanges, getPropertiesMap, getPropertyExpressions, getStretchTypeValue, getStyle, getStyleNameReference, getUUID, getWidth, getX, getY, hasProperties, isPrintInFirstWholeBand, isPrintRepeatedValues, isPrintWhenDetailOverflows, isRemoveLineWhenBlank, setBackcolor, setForecolor, setMode, setPositionType, setPrintInFirstWholeBand, setPrintRepeatedValues, setPrintWhenDetailOverflows, setRemoveLineWhenBlank, setStretchType, setWidth, setX

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

clone, getElementGroup, getKey, getPositionTypeValue, getPrintWhenExpression, getPrintWhenGroupChanges, getPropertyExpressions, getStretchTypeValue, getX, getY, isPrintInFirstWholeBand, isPrintRepeatedValues, isPrintWhenDetailOverflows, isRemoveLineWhenBlank, setPositionType, setPrintInFirstWholeBand, setPrintRepeatedValues, setPrintWhenDetailOverflows, setRemoveLineWhenBlank, setStretchType, setWidth, setX

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

clone

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

getParentProperties, getPropertiesMap, hasProperties

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

getUUID

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

getHorizontalAlignmentValue, getOwnHorizontalAlignmentValue, getOwnVerticalAlignmentValue, getVerticalAlignmentValue, setHorizontalAlignment, setVerticalAlignment

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

getHorizontalTextAlign, getOwnHorizontalTextAlign, getOwnVerticalTextAlign, getVerticalTextAlign, setHorizontalTextAlign, setVerticalTextAlign

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

getFontName, getFontsize, getFontSize, getOwnFontName, getOwnFontsize, getOwnFontSize, getOwnPdfEncoding, getOwnPdfFontName, getPdfEncoding, getPdfFontName, isBold, isItalic, isOwnBold, isOwnItalic, isOwnPdfEmbedded, isOwnStrikeThrough, isOwnUnderline, isPdfEmbedded, isStrikeThrough, isUnderline, setBold, setBold, setFontName, setFontSize, setFontSize, setFontSize, setItalic, setItalic, setPdfEmbedded, setPdfEmbedded, setPdfEncoding, setPdfFontName, setStrikeThrough, setStrikeThrough, setUnderline, setUnderline

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

getFontsize, getFontSize, getLineSpacingValue, getMarkup, getOwnLineSpacingValue, getOwnMarkup, getOwnRotationValue, getRotationValue, setLineSpacing, setMarkup, setRotation

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

getBackcolor, getForecolor, getHeight, getModeValue, getOwnBackcolor, getOwnForecolor, getOwnModeValue, getWidth, setBackcolor, setForecolor, setMode

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

getDefaultLineColor, getLineBox

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

getParagraph

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

getDefaultStyleProvider, getStyle, getStyleNameReference

Field Detail

PROPERTY_STRETCH_WITH_OVERFLOW

public static final String PROPERTY_STRETCH_WITH_OVERFLOW

See Also:

Constant Field Values

isStretchWithOverflow

protected boolean isStretchWithOverflow

evaluationTimeValue

protected EvaluationTimeEnum evaluationTimeValue

pattern

protected String pattern

isBlankWhenNull

protected Boolean isBlankWhenNull

linkType

protected String linkType

linkTarget

protected String linkTarget

evaluationGroup

protected JRGroup evaluationGroup

expression

protected JRExpression expression

patternExpression

protected JRExpression patternExpression

anchorNameExpression

protected JRExpression anchorNameExpression

hyperlinkReferenceExpression

protected JRExpression hyperlinkReferenceExpression

hyperlinkWhenExpression

protected JRExpression hyperlinkWhenExpression

hyperlinkAnchorExpression

protected JRExpression hyperlinkAnchorExpression

hyperlinkPageExpression

protected JRExpression hyperlinkPageExpression

bookmarkLevel

protected int bookmarkLevel

The bookmark level for the anchor associated with this field.

See Also:

JRAnchor.getBookmarkLevel()

Constructor Detail

JRBaseTextField

protected JRBaseTextField(JRTextField textField,
               JRBaseObjectFactory factory)

Initializes the text field properties.

Method Detail

isStretchWithOverflow

public boolean isStretchWithOverflow()

Description copied from interface: JRTextField

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

Specified by:

isStretchWithOverflow in interface JRTextField

Returns:

true if the text field will stretch vertically, false otherwise

setStretchWithOverflow

public void setStretchWithOverflow(boolean isStretchWithOverflow)

Description copied from interface: JRTextField

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

Specified by:

setStretchWithOverflow in interface JRTextField

getEvaluationTimeValue

public EvaluationTimeEnum getEvaluationTimeValue()

Description copied from interface: JREvaluation

Gets the evaluation time for this text field.

Specified by:

getEvaluationTimeValue in interface JREvaluation

Returns:

one of the evaluation time constants in JRExpression

getPattern

public String getPattern()

Description copied from interface: JRTextField

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.

Specified by:

getPattern in interface JRTextField

Returns:

a string containing the pattern.

getOwnPattern

public String getOwnPattern()

Specified by:

getOwnPattern in interface JRTextField

setPattern

public void setPattern(String pattern)

Description copied from interface: JRTextField

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.

Specified by:

setPattern in interface JRTextField

isBlankWhenNull

public boolean isBlankWhenNull()

Description copied from interface: JRTextField

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

Specified by:

isBlankWhenNull in interface JRTextField

Returns:

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

isOwnBlankWhenNull

public Boolean isOwnBlankWhenNull()

Specified by:

isOwnBlankWhenNull in interface JRTextField

setBlankWhenNull

public void setBlankWhenNull(Boolean isBlank)

Specified by:

setBlankWhenNull in interface JRTextField

setBlankWhenNull

public void setBlankWhenNull(boolean isBlank)

Description copied from interface: JRTextField

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

Specified by:

setBlankWhenNull in interface JRTextField

Parameters:

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

getHyperlinkType

public byte getHyperlinkType()

Deprecated. Replaced by getHyperlinkTypeValue().

Specified by:

getHyperlinkType in interface JRHyperlink

getHyperlinkTypeValue

public HyperlinkTypeEnum getHyperlinkTypeValue()

Description copied from interface: JRHyperlink

Retrieves the hyperlink type for the element.

The actual hyperlink type is determined by getLinkType(). This method can is used to determine whether the hyperlink type is one of the built-in types or a custom type. When hyperlink is of custom type, CUSTOM is returned.

Specified by:

getHyperlinkTypeValue in interface JRHyperlink

Returns:

one of the hyperlink type constants

See Also:

JRHyperlink.getLinkType()

getHyperlinkTarget

public byte getHyperlinkTarget()

Description copied from interface: JRHyperlink

Retrieves the hyperlink target for the element.

The actual hyperlink target is determined by getLinkTarget(). This method can is used to determine whether the hyperlink target is one of the built-in target names or a custom one. When hyperlink has a custom target name, HyperlinkTargetEnum.CUSTOM is returned.

Specified by:

getHyperlinkTarget in interface JRHyperlink

Returns:

one of the hyperlink target constants

See Also:

JRHyperlink.getLinkTarget()

getEvaluationGroup

public JRGroup getEvaluationGroup()

Description copied from interface: JREvaluation

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

Specified by:

getEvaluationGroup in interface JREvaluation

See Also:

EvaluationTimeEnum.GROUP

getExpression

public JRExpression getExpression()

Description copied from interface: JRTextField

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

Specified by:

getExpression in interface JRTextField

getPatternExpression

public JRExpression getPatternExpression()

Description copied from interface: JRTextField

Gets the pattern expression, in case the patter needs to be dynamic.

Specified by:

getPatternExpression in interface JRTextField

See Also:

JRTextField.getPattern()

getAnchorNameExpression

public JRExpression getAnchorNameExpression()

Description copied from interface: JRAnchor

Returns an expression whose value represents the anchor name.

Specified by:

getAnchorNameExpression in interface JRAnchor

getHyperlinkReferenceExpression

public JRExpression getHyperlinkReferenceExpression()

Description copied from interface: JRHyperlink

Returns the expression whose value represents the hyperlink reference. It is only used when the hyperlink type is reference or anchor

Specified by:

getHyperlinkReferenceExpression in interface JRHyperlink

getHyperlinkWhenExpression

public JRExpression getHyperlinkWhenExpression()

Description copied from interface: JRHyperlink

Returns the expression that is evaluated in order to decide if the hyperlink should be displayed. This expression always returns a boolean value.

Specified by:

getHyperlinkWhenExpression in interface JRHyperlink

getHyperlinkAnchorExpression

public JRExpression getHyperlinkAnchorExpression()

Description copied from interface: JRHyperlink

Returns the expression whose value represents the anchor. It is only used when the hyperlink type is anchor.

Specified by:

getHyperlinkAnchorExpression in interface JRHyperlink

getHyperlinkPageExpression

public JRExpression getHyperlinkPageExpression()

Description copied from interface: JRHyperlink

Returns an integer representing the page index of the link. It is only used when the hyperlink type is page. If the expression does not evaluate to an integer, an exception will be thrown.

Specified by:

getHyperlinkPageExpression in interface JRHyperlink

collectExpressions

public void collectExpressions(JRExpressionCollector collector)

Specified by:

collectExpressions in interface JRElement

visit

public void visit(JRVisitor visitor)

Specified by:

visit in interface JRVisitable

getBookmarkLevel

public int getBookmarkLevel()

Description copied from interface: JRAnchor

Returns the level of the bookmark corresponding to the anchor.

Specified by:

getBookmarkLevel in interface JRAnchor

Returns:

the level of the bookmark corresponding to the anchor (starting from 1) or NO_BOOKMARK if no bookmark should be created for this anchor

getLinkType

public String getLinkType()

Description copied from interface: JRHyperlink

Returns the hyperlink type.

The type can be one of the built-in types (Reference, LocalAnchor, LocalPage, RemoteAnchor, RemotePage), or can be an arbitrary type.

Specified by:

getLinkType in interface JRHyperlink

Returns:

the hyperlink type

getLinkTarget

public String getLinkTarget()

Description copied from interface: JRHyperlink

Returns the hyperlink target name.

The type can be one of the built-in names (Self, Blank, Top, Parent), or can be an arbitrary name.

Specified by:

getLinkTarget in interface JRHyperlink

Returns:

the hyperlink target name

getHyperlinkParameters

public JRHyperlinkParameter[] getHyperlinkParameters()

Description copied from interface: JRHyperlink

Returns the list of hyperlink parameters.

The parameters can be used by custom hyperlink types to generate dynamic links.

Specified by:

getHyperlinkParameters in interface JRHyperlink

Returns:

the list of hyperlink parameters

getHyperlinkTooltipExpression

public JRExpression getHyperlinkTooltipExpression()

Description copied from interface: JRHyperlink

Returns the expression which will generate the hyperlink tooltip.

Specified by:

getHyperlinkTooltipExpression in interface JRHyperlink

Returns:

the expression which will generate the hyperlink tooltip

clone

public Object clone()

Specified by:

clone in interface JRCloneable

Overrides:

clone in class JRBaseTextElement