public class JRBaseTextField extends JRBaseTextElement implements JRTextField
| 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 |
fontName, fontsize, horizontalTextAlign, isBold, isItalic, isPdfEmbedded, isStrikeThrough, isUnderline, lineBox, markup, paragraph, pdfEncoding, pdfFontName, rotationValue, verticalTextAlignbackcolor, 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, yFORMAT_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_TIMEZONEPROPERTY_PRINT_KEEP_FULL_TEXT, PROPERTY_SAVE_LINE_BREAKS, PROPERTY_TRUNCATE_AT_CHAR, PROPERTY_TRUNCATE_SUFFIXDEFAULT_FONT_NAME, DEFAULT_FONT_SIZE, DEFAULT_PDF_EMBEDDED, DEFAULT_PDF_ENCODING, DEFAULT_PDF_FONT_NAMEMARKUP_HTML, MARKUP_NONE, MARKUP_RTF, MARKUP_STYLED_TEXTNO_BOOKMARK| Modifier | Constructor and Description |
|---|---|
protected |
JRBaseTextField(JRTextField textField,
JRBaseObjectFactory factory)
Initializes the text field properties.
|
| 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) |
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, setVerticalTextAlignclone, clone, getBackcolor, getBaseStyle, getDefaultStyleProvider, getElementGroup, getEventSupport, getForecolor, getHeight, getKey, getOwnBackcolor, getOwnForecolor, getOwnModeValue, getParentProperties, getPositionTypeValue, getPrintWhenExpression, getPrintWhenGroupChanges, getPropertiesMap, getPropertyExpressions, getStretchTypeValue, getStyle, getStyleNameReference, getStyleResolver, getUUID, getWidth, getX, getY, hasProperties, isPrintInFirstWholeBand, isPrintRepeatedValues, isPrintWhenDetailOverflows, isRemoveLineWhenBlank, setBackcolor, setForecolor, setMode, setPositionType, setPrintInFirstWholeBand, setPrintRepeatedValues, setPrintWhenDetailOverflows, setRemoveLineWhenBlank, setStretchType, setWidth, setXequals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitclone, getElementGroup, getKey, getPositionTypeValue, getPrintWhenExpression, getPrintWhenGroupChanges, getPropertyExpressions, getStretchTypeValue, getX, getY, isPrintInFirstWholeBand, isPrintRepeatedValues, isPrintWhenDetailOverflows, isRemoveLineWhenBlank, setPositionType, setPrintInFirstWholeBand, setPrintRepeatedValues, setPrintWhenDetailOverflows, setRemoveLineWhenBlank, setStretchType, setWidth, setXgetParentProperties, getPropertiesMap, hasPropertiesgetUUIDgetHorizontalAlignmentValue, getOwnHorizontalAlignmentValue, getOwnVerticalAlignmentValue, getVerticalAlignmentValue, setHorizontalAlignment, setVerticalAlignmentgetHorizontalTextAlign, getOwnHorizontalTextAlign, getOwnVerticalTextAlign, getVerticalTextAlign, setHorizontalTextAlign, setVerticalTextAligngetFontName, 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, setUnderlinegetFontsize, getFontSize, getLineSpacingValue, getMarkup, getOwnLineSpacingValue, getOwnMarkup, getOwnRotationValue, getRotationValue, setLineSpacing, setMarkup, setRotationgetBackcolor, getForecolor, getHeight, getModeValue, getOwnBackcolor, getOwnForecolor, getOwnModeValue, getWidth, setBackcolor, setForecolor, setModegetDefaultLineColor, getLineBoxgetParagraphgetDefaultStyleProvider, getStyle, getStyleNameReferencepublic static final String PROPERTY_STRETCH_WITH_OVERFLOW
protected boolean isStretchWithOverflow
protected EvaluationTimeEnum evaluationTimeValue
protected String pattern
protected Boolean isBlankWhenNull
protected String linkType
protected String linkTarget
protected JRGroup evaluationGroup
protected JRExpression expression
protected JRExpression patternExpression
protected JRExpression anchorNameExpression
protected JRExpression hyperlinkReferenceExpression
protected JRExpression hyperlinkWhenExpression
protected JRExpression hyperlinkAnchorExpression
protected JRExpression hyperlinkPageExpression
protected int bookmarkLevel
JRAnchor.getBookmarkLevel()protected JRBaseTextField(JRTextField textField, JRBaseObjectFactory factory)
public boolean isStretchWithOverflow()
JRTextFieldisStretchWithOverflow in interface JRTextFieldpublic void setStretchWithOverflow(boolean isStretchWithOverflow)
JRTextFieldsetStretchWithOverflow in interface JRTextFieldpublic EvaluationTimeEnum getEvaluationTimeValue()
JREvaluationgetEvaluationTimeValue in interface JREvaluationJRExpressionpublic String getPattern()
JRTextFieldgetPattern in interface JRTextFieldpublic String getOwnPattern()
getOwnPattern in interface JRTextFieldpublic void setPattern(String pattern)
JRTextFieldsetPattern in interface JRTextFieldpublic boolean isBlankWhenNull()
JRTextFieldnull.isBlankWhenNull in interface JRTextFieldpublic Boolean isOwnBlankWhenNull()
isOwnBlankWhenNull in interface JRTextFieldpublic void setBlankWhenNull(Boolean isBlank)
setBlankWhenNull in interface JRTextFieldpublic void setBlankWhenNull(boolean isBlank)
JRTextFieldnull.setBlankWhenNull in interface JRTextFieldisBlank - true if an empty string will be displayed instead of null values, false otherwisepublic byte getHyperlinkType()
getHyperlinkTypeValue().public HyperlinkTypeEnum getHyperlinkTypeValue()
JRHyperlink
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.
getHyperlinkTypeValue in interface JRHyperlinkJRHyperlink.getLinkType()public byte getHyperlinkTarget()
JRHyperlink
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.
getHyperlinkTarget in interface JRHyperlinkJRHyperlink.getLinkTarget()public JRGroup getEvaluationGroup()
JREvaluationgetEvaluationGroup in interface JREvaluationEvaluationTimeEnum.GROUPpublic JRExpression getExpression()
JRTextFieldgetExpression in interface JRTextFieldpublic JRExpression getPatternExpression()
JRTextFieldgetPatternExpression in interface JRTextFieldJRTextField.getPattern()public JRExpression getAnchorNameExpression()
JRAnchorgetAnchorNameExpression in interface JRAnchorpublic JRExpression getHyperlinkReferenceExpression()
JRHyperlinkgetHyperlinkReferenceExpression in interface JRHyperlinkpublic JRExpression getHyperlinkWhenExpression()
JRHyperlinkgetHyperlinkWhenExpression in interface JRHyperlinkpublic JRExpression getHyperlinkAnchorExpression()
JRHyperlinkgetHyperlinkAnchorExpression in interface JRHyperlinkpublic JRExpression getHyperlinkPageExpression()
JRHyperlinkgetHyperlinkPageExpression in interface JRHyperlinkpublic void collectExpressions(JRExpressionCollector collector)
collectExpressions in interface JRElementpublic void visit(JRVisitor visitor)
visit in interface JRVisitablepublic int getBookmarkLevel()
JRAnchorgetBookmarkLevel in interface JRAnchorNO_BOOKMARK if no bookmark should be created for this anchorpublic String getLinkType()
JRHyperlinkThe type can be one of the built-in types (Reference, LocalAnchor, LocalPage, RemoteAnchor, RemotePage), or can be an arbitrary type.
getLinkType in interface JRHyperlinkpublic String getLinkTarget()
JRHyperlinkThe type can be one of the built-in names (Self, Blank, Top, Parent), or can be an arbitrary name.
getLinkTarget in interface JRHyperlinkpublic JRHyperlinkParameter[] getHyperlinkParameters()
JRHyperlinkThe parameters can be used by custom hyperlink types to generate dynamic links.
getHyperlinkParameters in interface JRHyperlinkpublic JRExpression getHyperlinkTooltipExpression()
JRHyperlinkgetHyperlinkTooltipExpression in interface JRHyperlinkpublic Object clone()
clone in interface JRCloneableclone in class JRBaseTextElementCopyright © 2017. All rights reserved.