net.sf.jasperreports.engine.design
Class JRDesignTextField

java.lang.Object
  net.sf.jasperreports.engine.base.JRBaseElement
      net.sf.jasperreports.engine.design.JRDesignElement
          net.sf.jasperreports.engine.design.JRDesignTextElement
              net.sf.jasperreports.engine.design.JRDesignTextField

All Implemented Interfaces:

java.io.Serializable, JRAlignment, JRAnchor, JRChild, JRElement, JRHyperlink, JRTextElement, JRTextField

public class JRDesignTextField
extends JRDesignTextElement
implements JRTextField

Version:

$Id: JRDesignTextField.java,v 1.27 2005/10/09 21:34:26 teodord Exp $

Author:

Teodor Danciu (teodord@users.sourceforge.net)

See Also:

Serialized Form

Field Summary

protected JRExpression	anchorNameExpression
protected int	bookmarkLevel The bookmark level for the anchor associated with this field.
protected JRGroup	evaluationGroup
protected byte	evaluationTime
protected JRExpression	expression
protected JRExpression	hyperlinkAnchorExpression
protected JRExpression	hyperlinkPageExpression
protected JRExpression	hyperlinkReferenceExpression
protected byte	hyperlinkTarget
protected byte	hyperlinkType
protected boolean	isBlankWhenNull
protected boolean	isStretchWithOverflow
protected java.lang.String	pattern

Fields inherited from class net.sf.jasperreports.engine.design.JRDesignTextElement

box, font, horizontalAlignment, isStyledText, lineSpacing, rotation, verticalAlignment

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

backcolor, elementGroup, forecolor, height, isPrintInFirstWholeBand, isPrintRepeatedValues, isPrintWhenDetailOverflows, isRemoveLineWhenBlank, key, mode, positionType, printWhenExpression, printWhenGroupChanges, stretchType, width, x, y

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

STANDARD_DATE_FORMAT_DEFAULT, STANDARD_DATE_FORMAT_FULL, STANDARD_DATE_FORMAT_HIDE, STANDARD_DATE_FORMAT_LONG, STANDARD_DATE_FORMAT_MEDIUM, STANDARD_DATE_FORMAT_SEPARATOR, STANDARD_DATE_FORMAT_SHORT

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

Constructor Summary

JRDesignTextField()

Method Summary

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.
JRChild	getCopy(JRAbstractObjectFactory factory)
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.
JRExpression	getHyperlinkAnchorExpression() Returns the expression whose value represents the anchor.
JRExpression	getHyperlinkPageExpression() Returns an integer representing the page index of the link.
JRExpression	getHyperlinkReferenceExpression() Returns the expression whose value represents the hyperlink reference.
byte	getHyperlinkTarget() Retrieves the hyperlink target for the element.
byte	getHyperlinkType() Retrieves the hyperlink type for the element.
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	setAnchorNameExpression(JRExpression anchorNameExpression)
void	setBlankWhenNull(boolean isBlank) Specifies whether an empty string sholuld be displayed if the field's expression evaluates to null.
void	setBookmarkLevel(int bookmarkLevel) Sets the boomark level for the anchor associated with this field.
void	setEvaluationGroup(JRGroup evaluationGroup)
void	setEvaluationTime(byte evaluationTime)
void	setExpression(JRExpression expression)
void	setHyperlinkAnchorExpression(JRExpression hyperlinkAnchorExpression)
void	setHyperlinkPageExpression(JRExpression hyperlinkPageExpression)
void	setHyperlinkReferenceExpression(JRExpression hyperlinkReferenceExpression)
void	setHyperlinkTarget(byte hyperlinkTarget)
void	setHyperlinkType(byte hyperlinkType)
void	setPattern(java.lang.String pattern) Sets the pattern used for this text field.
void	setStretchWithOverflow(boolean isStretch) Set to true if the text field should stretch vertically if its text does not fit in one line.
void	writeXml(JRXmlWriter xmlWriter)

Methods inherited from class net.sf.jasperreports.engine.design.JRDesignTextElement

getBox, getFont, getHorizontalAlignment, getLineSpacing, getRotation, getTextAlignment, getVerticalAlignment, isStyledText, setBox, setFont, setHorizontalAlignment, setLineSpacing, setRotation, setStyledText, setTextAlignment, setVerticalAlignment

Methods inherited from class net.sf.jasperreports.engine.design.JRDesignElement

setElementGroup, setHeight, setKey, setPrintWhenExpression, setPrintWhenGroupChanges, setY

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

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 class java.lang.Object

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

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

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.JRAlignment

getHorizontalAlignment, getVerticalAlignment, setHorizontalAlignment, setVerticalAlignment

Field Detail

isStretchWithOverflow

protected boolean isStretchWithOverflow

evaluationTime

protected byte evaluationTime

pattern

protected java.lang.String pattern

isBlankWhenNull

protected boolean isBlankWhenNull

hyperlinkType

protected byte hyperlinkType

hyperlinkTarget

protected byte hyperlinkTarget

evaluationGroup

protected JRGroup evaluationGroup

expression

protected JRExpression expression

anchorNameExpression

protected JRExpression anchorNameExpression

hyperlinkReferenceExpression

protected JRExpression hyperlinkReferenceExpression

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

JRDesignTextField

public JRDesignTextField()

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

getEvaluationTime

public byte getEvaluationTime()

Description copied from interface: JRTextField

Gets the evaluation time for this text field.

Specified by:

getEvaluationTime in interface JRTextField

Returns:

one of the evaluation time constants in JRExpression

getPattern

public java.lang.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.

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

getHyperlinkType

public byte getHyperlinkType()

Description copied from interface: JRHyperlink

Retrieves the hyperlink type for the element.

Specified by:

getHyperlinkType in interface JRHyperlink

Returns:

one of the hyperlink type constants

getHyperlinkTarget

public byte getHyperlinkTarget()

Description copied from interface: JRHyperlink

Retrieves the hyperlink target for the element.

Specified by:

getHyperlinkTarget in interface JRHyperlink

Returns:

one of the hyperlink target constants

getEvaluationGroup

public JRGroup getEvaluationGroup()

Description copied from interface: JRTextField

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

Specified by:

getEvaluationGroup in interface JRTextField

See Also:

JRExpression.EVALUATION_TIME_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

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

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

setStretchWithOverflow

public void setStretchWithOverflow(boolean isStretch)

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

setEvaluationTime

public void setEvaluationTime(byte evaluationTime)

setPattern

public void setPattern(java.lang.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

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

setHyperlinkType

public void setHyperlinkType(byte hyperlinkType)

setHyperlinkTarget

public void setHyperlinkTarget(byte hyperlinkTarget)

setEvaluationGroup

public void setEvaluationGroup(JRGroup evaluationGroup)

setExpression

public void setExpression(JRExpression expression)

setAnchorNameExpression

public void setAnchorNameExpression(JRExpression anchorNameExpression)

setHyperlinkReferenceExpression

public void setHyperlinkReferenceExpression(JRExpression hyperlinkReferenceExpression)

setHyperlinkAnchorExpression

public void setHyperlinkAnchorExpression(JRExpression hyperlinkAnchorExpression)

setHyperlinkPageExpression

public void setHyperlinkPageExpression(JRExpression hyperlinkPageExpression)

getCopy

public JRChild getCopy(JRAbstractObjectFactory factory)

Specified by:

getCopy in interface JRChild

collectExpressions

public void collectExpressions(JRExpressionCollector collector)

Specified by:

collectExpressions in interface JRElement

writeXml

public void writeXml(JRXmlWriter xmlWriter)

Specified by:

writeXml in interface JRChild

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

setBookmarkLevel

public void setBookmarkLevel(int bookmarkLevel)

Sets the boomark level for the anchor associated with this field.

Parameters:

bookmarkLevel - the bookmark level (starting from 1) or NO_BOOKMARK if no bookmark should be created