Package 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:

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

public class JRDesignTextField
extends JRDesignTextElement
implements JRTextField

Author:

Teodor Danciu (teodord@users.sourceforge.net)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected JRExpression	anchorNameExpression
protected int	bookmarkLevel	The bookmark level for the anchor associated with this field.
protected JRExpression	bookmarkLevelExpression
protected String	evaluationGroup
protected EvaluationTimeEnum	evaluationTime
protected JRExpression	expression
protected JRExpression	hyperlinkAnchorExpression
protected JRExpression	hyperlinkPageExpression
protected JRExpression	hyperlinkReferenceExpression
protected JRExpression	hyperlinkWhenExpression
protected Boolean	isBlankWhenNull
protected String	linkTarget
protected String	linkType
protected String	pattern
protected JRExpression	patternExpression
static String	PROPERTY_ANCHOR_NAME_EXPRESSION
static String	PROPERTY_BOOKMARK_LEVEL
static String	PROPERTY_BOOKMARK_LEVEL_EXPRESSION
static String	PROPERTY_EVALUATION_GROUP
static String	PROPERTY_EVALUATION_TIME
static String	PROPERTY_EXPRESSION
static String	PROPERTY_PATTERN_EXPRESSION
protected TextAdjustEnum	textAdjust

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

fontName, fontSize, horizontalTextAlign, isBold, isItalic, isPdfEmbedded, isStrikeThrough, isUnderline, lineBox, markup, paragraph, pdfEncoding, pdfFontName, rotation, verticalTextAlign

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

PROPERTY_ELEMENT_GROUP, PROPERTY_HEIGHT, PROPERTY_KEY, PROPERTY_PARENT_STYLE, PROPERTY_PARENT_STYLE_NAME_REFERENCE, PROPERTY_PRINT_WHEN_EXPRESSION, PROPERTY_PRINT_WHEN_GROUP_CHANGES, PROPERTY_PROPERTY_EXPRESSIONS, PROPERTY_STYLE_EXPRESSION, PROPERTY_Y

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

backcolor, defaultStyleProvider, elementGroup, forecolor, height, isPrintInFirstWholeBand, isPrintRepeatedValues, isPrintWhenDetailOverflows, isRemoveLineWhenBlank, key, mode, parentStyle, parentStyleNameReference, positionType, 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, stretchType, styleExpression, uuid, width, x, y

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

NO_BOOKMARK

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

PROPERTY_ELEMENT_TEMPLATE_POPULATE_STYLE

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

Constructor Summary

Constructors

Constructor	Description
JRDesignTextField()
JRDesignTextField(JRDefaultStyleProvider defaultStyleProvider)

Method Summary

Modifier and Type	Method	Description
void	addHyperlinkParameter(JRHyperlinkParameter parameter)	Adds a custom hyperlink parameter.
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.
JRExpression	getBookmarkLevelExpression()	Returns an expression whose value represents the bookmark level (starting from 1) corresponding to this anchor.
String	getEvaluationGroup()	Gets the evaluation group for this text field.
EvaluationTimeEnum	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.
JRHyperlinkParameter[]	getHyperlinkParameters()	Returns the list of hyperlink parameters.
List<JRHyperlinkParameter>	getHyperlinkParametersList()	Returns the list of custom hyperlink parameters.
JRExpression	getHyperlinkReferenceExpression()	Returns the expression whose value represents the hyperlink reference.
HyperlinkTargetEnum	getHyperlinkTarget()	Retrieves the hyperlink target for the element.
JRExpression	getHyperlinkTooltipExpression()	Returns the expression which will generate the hyperlink tooltip.
HyperlinkTypeEnum	getHyperlinkType()	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.
TextAdjustEnum	getTextAdjust()	Gets the text adjust type.
boolean	isBlankWhenNull()	Indicates whether an empty string will be displayed if the field's expression evaluates to null.
Boolean	isOwnBlankWhenNull()
void	removeHyperlinkParameter(String parameterName)	Removes a custom hyperlink parameter.
void	removeHyperlinkParameter(JRHyperlinkParameter parameter)	Removes a custom hyperlink parameter.
void	setAnchorNameExpression(JRExpression anchorNameExpression)
void	setBlankWhenNull(Boolean isBlank)	Specifies whether an empty string should 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	setBookmarkLevelExpression(JRExpression bookmarkLevelExpression)
void	setEvaluationGroup(String evaluationGroup)
void	setEvaluationTime(EvaluationTimeEnum evaluationTime)
void	setExpression(JRExpression expression)
void	setHyperlinkAnchorExpression(JRExpression hyperlinkAnchorExpression)
void	setHyperlinkPageExpression(JRExpression hyperlinkPageExpression)
void	setHyperlinkReferenceExpression(JRExpression hyperlinkReferenceExpression)
void	setHyperlinkTarget(HyperlinkTargetEnum hyperlinkTarget)
void	setHyperlinkTooltipExpression(JRExpression hyperlinkTooltipExpression)	Sets the expression which will be used to generate the hyperlink tooltip.
void	setHyperlinkType(HyperlinkTypeEnum hyperlinkType)	Sets the link type as a built-in hyperlink type.
void	setHyperlinkWhenExpression(JRExpression hyperlinkWhenExpression)
void	setLinkTarget(String target)	Sets the hyperlink target name.
void	setLinkType(String type)	Sets the hyperlink type.
void	setPattern(String pattern)	Sets the pattern used for this text field.
void	setPatternExpression(JRExpression patternExpression)
void	setTextAdjust(TextAdjustEnum textAdjust)	Sets the text adjust type.
void	visit(JRVisitor visitor)

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

getDefaultLineColor, getFontName, getFontSize, getHorizontalTextAlign, getLineBox, getMarkup, getMode, getOwnFontName, getOwnFontSize, getOwnHorizontalTextAlign, getOwnMarkup, getOwnPdfEncoding, getOwnPdfFontName, getOwnRotation, getOwnVerticalTextAlign, getParagraph, getPdfEncoding, getPdfFontName, getRotation, getVerticalTextAlign, isBold, isItalic, isOwnBold, isOwnItalic, isOwnPdfEmbedded, isOwnStrikeThrough, isOwnUnderline, isPdfEmbedded, isStrikeThrough, isUnderline, setBold, setFontName, setFontSize, setHorizontalTextAlign, setItalic, setMarkup, setPdfEmbedded, setPdfEncoding, setPdfFontName, setRotation, setStrikeThrough, setUnderline, setVerticalTextAlign

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

addPropertyExpression, getPropertyExpressions, getPropertyExpressionsList, removePropertyExpression, removePropertyExpression, setElementGroup, setHeight, setKey, setPrintWhenExpression, setPrintWhenGroupChanges, setStyle, setStyleExpression, setStyleNameReference, setY

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

clone, clone, getBackcolor, getBaseStyle, getDefaultStyleProvider, getElementGroup, getEventSupport, getForecolor, getHeight, getKey, getOwnBackcolor, getOwnForecolor, getOwnMode, getParentProperties, getPositionType, getPrintWhenExpression, getPrintWhenGroupChanges, getPropertiesMap, getStretchType, getStyle, getStyleExpression, getStyleNameReference, getStyleResolver, getUUID, getWidth, getX, getY, hasProperties, isPrintInFirstWholeBand, isPrintRepeatedValues, isPrintWhenDetailOverflows, isRemoveLineWhenBlank, setBackcolor, setForecolor, setMode, setPositionType, setPrintInFirstWholeBand, setPrintRepeatedValues, setPrintWhenDetailOverflows, setRemoveLineWhenBlank, setStretchType, setUUID, 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.JRBoxContainer

getDefaultLineColor, getLineBox

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

clone

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

getBackcolor, getForecolor, getHeight, getKey, getMode, getOwnBackcolor, getOwnForecolor, getOwnMode, getWidth, setBackcolor, setForecolor, setMode

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

getFontSize, getMarkup, getOwnMarkup, getOwnRotation, getRotation, setMarkup, setRotation

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

clone, getElementGroup, getPositionType, getPrintWhenExpression, getPrintWhenGroupChanges, getPropertyExpressions, getStretchType, getStyleExpression, getX, getY, isPrintInFirstWholeBand, isPrintRepeatedValues, isPrintWhenDetailOverflows, isRemoveLineWhenBlank, setPositionType, setPrintInFirstWholeBand, setPrintRepeatedValues, setPrintWhenDetailOverflows, setRemoveLineWhenBlank, setStretchType, setWidth, setX

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

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

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

getUUID

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

getParagraph

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

getParentProperties, getPropertiesMap, hasProperties

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

getDefaultStyleProvider, getStyle, getStyleName, getStyleNameReference

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

getHorizontalTextAlign, getOwnHorizontalTextAlign, getOwnVerticalTextAlign, getVerticalTextAlign, setHorizontalTextAlign, setVerticalTextAlign

Field Detail

PROPERTY_ANCHOR_NAME_EXPRESSION

public static final String PROPERTY_ANCHOR_NAME_EXPRESSION

See Also:

Constant Field Values

PROPERTY_BOOKMARK_LEVEL

public static final String PROPERTY_BOOKMARK_LEVEL

See Also:

Constant Field Values

PROPERTY_BOOKMARK_LEVEL_EXPRESSION

public static final String PROPERTY_BOOKMARK_LEVEL_EXPRESSION

See Also:

Constant Field Values

PROPERTY_EVALUATION_GROUP

public static final String PROPERTY_EVALUATION_GROUP

See Also:

Constant Field Values

PROPERTY_EVALUATION_TIME

public static final String PROPERTY_EVALUATION_TIME

See Also:

Constant Field Values

PROPERTY_EXPRESSION

public static final String PROPERTY_EXPRESSION

See Also:

Constant Field Values

PROPERTY_PATTERN_EXPRESSION

public static final String PROPERTY_PATTERN_EXPRESSION

See Also:

Constant Field Values

textAdjust

protected TextAdjustEnum textAdjust

evaluationTime

protected EvaluationTimeEnum evaluationTime

pattern

protected String pattern

isBlankWhenNull

protected Boolean isBlankWhenNull

linkType

protected String linkType

linkTarget

protected String linkTarget

evaluationGroup

protected String evaluationGroup

expression

protected JRExpression expression

patternExpression

protected JRExpression patternExpression

anchorNameExpression

protected JRExpression anchorNameExpression

bookmarkLevelExpression

protected JRExpression bookmarkLevelExpression

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

JRDesignTextField

public JRDesignTextField()

JRDesignTextField

public JRDesignTextField(JRDefaultStyleProvider defaultStyleProvider)

Method Detail

getTextAdjust

public TextAdjustEnum getTextAdjust()

Description copied from interface: JRTextField

Gets the text adjust type.

Specified by:

getTextAdjust in interface JRTextField

Returns:

a value representing one of the text adjust constants in TextAdjustEnum

getEvaluationTime

public EvaluationTimeEnum getEvaluationTime()

Description copied from interface: JREvaluation

Gets the evaluation time for this text field.

Specified by:

getEvaluationTime 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

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

getHyperlinkType

public HyperlinkTypeEnum getHyperlinkType()

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:

getHyperlinkType in interface JRHyperlink

Returns:

one of the hyperlink type constants

See Also:

JRHyperlink.getLinkType()

getHyperlinkTarget

public HyperlinkTargetEnum 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 String 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

getBookmarkLevelExpression

public JRExpression getBookmarkLevelExpression()

Description copied from interface: JRAnchor

Returns an expression whose value represents the bookmark level (starting from 1) corresponding to this anchor. When the expression is set and its value is not null, it will override the value of the bookmarkLevel attribute.

Specified by:

getBookmarkLevelExpression 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

setTextAdjust

public void setTextAdjust(TextAdjustEnum textAdjust)

Description copied from interface: JRTextField

Sets the text adjust type.

Specified by:

setTextAdjust in interface JRTextField

Parameters:

textAdjust - a value representing one of the text adjust type constants in TextAdjustEnum

setEvaluationTime

public void setEvaluationTime(EvaluationTimeEnum evaluationTime)

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

setBlankWhenNull

public void setBlankWhenNull(Boolean isBlank)

Description copied from interface: JRTextField

Specifies whether an empty string should 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(HyperlinkTypeEnum hyperlinkType)

Sets the link type as a built-in hyperlink type.

Parameters:

hyperlinkType - the built-in hyperlink type

See Also:

getLinkType()

setHyperlinkTarget

public void setHyperlinkTarget(HyperlinkTargetEnum hyperlinkTarget)

setEvaluationGroup

public void setEvaluationGroup(String evaluationGroup)

setExpression

public void setExpression(JRExpression expression)

setPatternExpression

public void setPatternExpression(JRExpression patternExpression)

setAnchorNameExpression

public void setAnchorNameExpression(JRExpression anchorNameExpression)

setBookmarkLevelExpression

public void setBookmarkLevelExpression(JRExpression bookmarkLevelExpression)

setHyperlinkReferenceExpression

public void setHyperlinkReferenceExpression(JRExpression hyperlinkReferenceExpression)

setHyperlinkWhenExpression

public void setHyperlinkWhenExpression(JRExpression hyperlinkWhenExpression)

setHyperlinkAnchorExpression

public void setHyperlinkAnchorExpression(JRExpression hyperlinkAnchorExpression)

setHyperlinkPageExpression

public void setHyperlinkPageExpression(JRExpression hyperlinkPageExpression)

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

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

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

setLinkType

public void setLinkType(String type)

Sets the hyperlink type.

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

Parameters:

type - 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

setLinkTarget

public void setLinkTarget(String target)

Sets the hyperlink target name.

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

Parameters:

target - 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

getHyperlinkParametersList

public List<JRHyperlinkParameter> getHyperlinkParametersList()

Returns the list of custom hyperlink parameters.

Returns:

the list of custom hyperlink parameters

addHyperlinkParameter

public void addHyperlinkParameter(JRHyperlinkParameter parameter)

Adds a custom hyperlink parameter.

Parameters:

parameter - the parameter to add

removeHyperlinkParameter

public void removeHyperlinkParameter(JRHyperlinkParameter parameter)

Removes a custom hyperlink parameter.

Parameters:

parameter - the parameter to remove

removeHyperlinkParameter

public void removeHyperlinkParameter(String parameterName)

Removes a custom hyperlink parameter.

If multiple parameters having the specified name exist, all of them will be removed

Parameters:

parameterName - the parameter name

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

setHyperlinkTooltipExpression

public void setHyperlinkTooltipExpression(JRExpression hyperlinkTooltipExpression)

Sets the expression which will be used to generate the hyperlink tooltip.

Parameters:

hyperlinkTooltipExpression - the expression which will be used to generate the hyperlink tooltip

See Also:

getHyperlinkTooltipExpression()

clone

public Object clone()

Specified by:

clone in interface JRCloneable

Overrides:

clone in class JRDesignTextElement