Class JRFillTextField
- All Implemented Interfaces:
Cloneable,DynamicPropertiesHolder,JRFillCloneable,JRAnchor,JRBoxContainer,JRChild,JRCloneable,JRCommonElement,JRCommonText,JRElement,JREvaluation,JRFont,JRHyperlink,JRIdentifiable,JRParagraphContainer,JRPropertiesHolder,JRStyleContainer,JRStyleSetter,JRTextAlignment,JRTextElement,JRTextField,JRVisitable
- Author:
- Teodor Danciu (teodord@users.sourceforge.net)
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected static final org.apache.commons.logging.Logprotected final Map<Pair<JRStyle, TextFormat>, JRTemplateElement> Fields inherited from class net.sf.jasperreports.engine.fill.JRFillTextElement
EXCEPTION_MESSAGE_KEY_INVALID_START_INDEX, initLineBox, initParagraph, keepAverageCharWidth, lineBox, paragraph, PROPERTY_CONSUME_SPACE_ON_OVERFLOW, PROPERTY_CUT_TEXT_MAX_HEIGHT, PROPERTY_LEGACY_TEXT_MEASURING, PROPERTY_SCALE_FONT_STEP_LIMITFields inherited from class net.sf.jasperreports.engine.fill.JRFillElement
band, conditionalStylesContainer, currentEvaluation, currentStyle, defaultPopulateTemplateStyle, defaultStyleProvider, delayedEvaluationsMap, dynamicProperties, dynamicTransferProperties, elementGroup, EXCEPTION_MESSAGE_KEY_INVALID_BOOKMARK_LEVEL, expressionEvaluator, exprStyle, fillContainerContext, filler, hasDynamicPopulateTemplateStyle, initStyle, mergedProperties, originProvider, parent, printElementOriginator, printWhenGroupChanges, propertyExpressions, providerStyle, staticProperties, staticTransferProperties, styleProviders, templatesFields inherited from interface net.sf.jasperreports.engine.JRAnchor
NO_BOOKMARKFields inherited from interface net.sf.jasperreports.engine.JRCommonText
MARKUP_HTML, MARKUP_NONE, MARKUP_RTF, MARKUP_STYLED_TEXTFields inherited from interface net.sf.jasperreports.engine.JRElement
PROPERTY_ELEMENT_TEMPLATE_POPULATE_STYLEFields inherited from interface net.sf.jasperreports.engine.JRFont
DEFAULT_FONT_NAME, DEFAULT_FONT_SIZE, DEFAULT_PDF_EMBEDDED, DEFAULT_PDF_ENCODING, DEFAULT_PDF_FONT_NAMEFields inherited from interface net.sf.jasperreports.engine.JRTextElement
PROPERTY_PRINT_KEEP_FULL_TEXT, PROPERTY_SAVE_LINE_BREAKS, PROPERTY_TRUNCATE_AT_CHAR, PROPERTY_TRUNCATE_SUFFIXFields 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
ConstructorsModifierConstructorDescriptionprotectedJRFillTextField(JRBaseFiller filler, JRTextField textField, JRFillObjectFactory factory) protectedJRFillTextField(JRFillTextField textField, JRFillCloneFactory factory) -
Method Summary
Modifier and TypeMethodDescriptionprotected booleanprotected voidvoidcollectExpressions(JRExpressionCollector collector) protected voidcopy(JRPrintText text) createClone(JRFillCloneFactory factory) Creates a working clone of itself.protected JRTemplateElementprotected booleanprotected voidvoidevaluate(byte evaluation) protected voidevaluateText(byte evaluation) protected voidevaluateTextFormat(Format format, Object value, TimeZone ownTimeZone) fill()protected StringReturns an expression whose value represents the anchor name.intReturns the level of the bookmark corresponding to the anchor.Returns an expression whose value represents the bookmark level (starting from 1) corresponding to this anchor.protected StringgetDatePattern(Object value) Gets the evaluation group for this text field.Gets the evaluation time for this text field.Gets the expression for this field.protected Formatprotected StringReturns the expression whose value represents the anchor.protected IntegerReturns an integer representing the page index of the link.Returns the list of hyperlink parameters.protected StringReturns the expression whose value represents the hyperlink reference.Retrieves the hyperlink target for the element.protected StringReturns the expression which will generate the hyperlink tooltip.Retrieves the hyperlink type for the element.Returns the expression that is evaluated in order to decide if the hyperlink should be displayed.protected JRTemplateTextReturns the hyperlink target name.Returns the hyperlink type.protected StringgetLocalizedProperty(String property) protected StringgetNumberPattern(Object value) Gets the pattern used for this text field.Gets the pattern expression, in case the patter needs to be dynamic.protected TimeZonegetPatternTimeZone(String property) protected JRTemplateElementgetTemplate(JRStyle style) protected StringgetTemplatePattern(Format format, Object value) Gets the text adjust type.protected TextFormatprotected TimeZoneprotected ObjectgetValue()booleanIndicates whether an empty string will be displayed if the field's expression evaluates tonull.booleanprepare(int availableHeight, boolean isOverflow, boolean isOverflowAllowed) protected voidregisterTemplate(JRStyle style, JRTemplateElement template) protected voidresolveElement(JRPrintElement element, byte evaluation) Resolves an element.protected booleanvoidsetBlankWhenNull(Boolean isBlank) Specifies whether an empty string should be displayed if the field's expression evaluates tonull.voidsetPattern(String pattern) Sets the pattern used for this text field.protected voidsetPrintText(JRPrintText printText, String text) voidsetTextAdjust(TextAdjustEnum textAdjust) Sets the text adjust type.protected TextFieldEvaluatedEventprotected TimeZonetoFormatTimeZone(String timezoneId) voidMethods inherited from class net.sf.jasperreports.engine.fill.JRFillTextElement
chopTextElement, cutTextMaxHeight, ensureTextMeasurer, evaluateStyle, getAverageCharWidth, getDefaultLineColor, getFontName, getFontSize, getHorizontalTextAlign, getLeadingOffset, getLineBox, getLineBreakOffsets, getLineSpacingFactor, getMarkup, getMode, getOwnFontName, getOwnFontSize, getOwnHorizontalTextAlign, getOwnMarkup, getOwnPdfEncoding, getOwnPdfFontName, getOwnRotation, getOwnVerticalTextAlign, getParagraph, getPdfEncoding, getPdfFontName, getPrintLineBox, getPrintParagraph, getProcessedStyledText, getRawText, getRotation, getRunDirection, getStyledText, getStyledTextAttributes, getTextEnd, getTextHeight, getTextStart, getTextString, getTextTruncateSuffix, getTextWidth, getVerticalTextAlign, isBold, isConsumeSpaceOnOverflow, isCutParagraph, isItalic, isOwnBold, isOwnItalic, isOwnPdfEmbedded, isOwnStrikeThrough, isOwnUnderline, isPdfEmbedded, isStrikeThrough, isUnderline, keepFullText, processMarkupText, reset, resetTextChunk, rewind, scaleFontStepLimit, setAverageCharWidth, setBold, setCutParagraph, setFontName, setFontSize, setHeight, setHorizontalTextAlign, setItalic, setLeadingOffset, setLineBreakOffsets, setLineSpacingFactor, setMarkup, setPdfEmbedded, setPdfEncoding, setPdfFontName, setPrintText, setRawText, setRotation, setStrikeThrough, setTextEnd, setTextHeight, setTextStart, setTextTruncateSuffix, setTextWidth, setUnderline, setVerticalTextAlign, setWidthMethods inherited from class net.sf.jasperreports.engine.fill.JRFillElement
addDependantElement, addDynamicProperty, clone, clone, clone, collectDelayedEvaluations, collectDelayedEvaluations, collectStyleDelayedEvaluations, collectStyleProviderDelayedEvaluations, delayedEvaluate, evaluateExpression, evaluatePrintWhenExpression, evaluateProperties, getBackcolor, getBand, getBookmarkLevel, getCollapsedHeightAbove, getCollapsedHeightBelow, getConditionalStylesContainer, getDefaultStyleProvider, getDependantElements, getDynamicProperties, getElementGroup, getElementOrigin, getElementTemplate, getEvaluatedProperties, getField, getFiller, getForecolor, getGroupElements, getHeight, getInitStyle, getKey, getOwnBackcolor, getOwnForecolor, getOwnMode, getParent, getParentProperties, getPositionType, getPrepareHeight, getPrintWhenExpression, getPrintWhenGroupChanges, getPropertiesMap, getPropertyExpressions, getRelativeY, getStretchHeight, getStretchType, getStyle, getStyleExpression, getStyleNameReference, getStyleResolver, getUUID, getVariable, getWidth, getX, getY, hasDynamicProperties, hasDynamicProperty, hasProperties, initDelayedEvaluationPrint, initDelayedEvaluations, initStyleProviders, isAlreadyPrinted, isAutoEvaluateNow, isDelayedStyleEvaluation, isEvaluateAuto, isEvaluateNow, isPrintInFirstWholeBand, isPrintRepeatedValues, isPrintWhenDetailOverflows, isPrintWhenExpressionNull, isPrintWhenTrue, isRemoveLineWhenBlank, isReprinted, isToPrint, isValueRepeating, moveDependantElements, performDelayedEvaluation, resolveElement, setAlreadyPrinted, setBackcolor, setBand, setCollapsedHeightAbove, setCollapsedHeightBelow, setConditionalStylesContainer, setCurrentEvaluation, setExpressionEvaluator, setForecolor, setMode, setOriginProvider, setPositionType, setPrepareHeight, setPrintInFirstWholeBand, setPrintRepeatedValues, setPrintWhenDetailOverflows, setPrintWhenExpressionNull, setPrintWhenTrue, setRelativeY, setRemoveLineWhenBlank, setReprinted, setShrinkable, setStretchHeight, setStretchType, setStyle, setStyleNameReference, setToPrint, setValueRepeating, setX, setY, stretchElement, stretchElementToContainer, stretchElementToElementGroup, stretchElementToHeight, toPopulateTemplateStyle, transferProperties, transferPropertiesMethods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface net.sf.jasperreports.engine.JRBoxContainer
getDefaultLineColor, getLineBoxMethods inherited from interface net.sf.jasperreports.engine.JRCloneable
cloneMethods inherited from interface net.sf.jasperreports.engine.JRCommonElement
getBackcolor, getForecolor, getHeight, getKey, getMode, getOwnBackcolor, getOwnForecolor, getOwnMode, getWidth, setBackcolor, setForecolor, setModeMethods inherited from interface net.sf.jasperreports.engine.JRCommonText
getFontSize, getMarkup, getOwnMarkup, getOwnRotation, getRotation, setMarkup, setRotationMethods 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, setXMethods 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, setUnderlineMethods inherited from interface net.sf.jasperreports.engine.JRIdentifiable
getUUIDMethods inherited from interface net.sf.jasperreports.engine.JRParagraphContainer
getParagraphMethods inherited from interface net.sf.jasperreports.engine.JRPropertiesHolder
getParentProperties, getPropertiesMap, hasPropertiesMethods inherited from interface net.sf.jasperreports.engine.JRStyleContainer
getDefaultStyleProvider, getStyle, getStyleName, getStyleNameReferenceMethods inherited from interface net.sf.jasperreports.engine.JRTextAlignment
getHorizontalTextAlign, getOwnHorizontalTextAlign, getOwnVerticalTextAlign, getVerticalTextAlign, setHorizontalTextAlign, setVerticalTextAlign
-
Field Details
-
log
protected static final org.apache.commons.logging.Log log -
textTemplates
-
-
Constructor Details
-
JRFillTextField
-
JRFillTextField
-
-
Method Details
-
getTextAdjust
Description copied from interface:JRTextFieldGets the text adjust type.- Specified by:
getTextAdjustin interfaceJRTextField- Returns:
- a value representing one of the text adjust constants in
TextAdjustEnum
-
setTextAdjust
Description copied from interface:JRTextFieldSets the text adjust type.- Specified by:
setTextAdjustin interfaceJRTextField- Parameters:
textAdjust- a value representing one of the text adjust type constants inTextAdjustEnum
-
getEvaluationTime
Description copied from interface:JREvaluationGets the evaluation time for this text field.- Specified by:
getEvaluationTimein interfaceJREvaluation- Overrides:
getEvaluationTimein classJRFillElement- Returns:
- one of the evaluation time constants in
JRExpression
-
getTextFormat
-
getPattern
Description copied from interface:JRTextFieldGets 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:
getPatternin interfaceJRTextField- Returns:
- a string containing the pattern.
-
getDatePattern
-
getNumberPattern
-
getLocalizedProperty
-
getOwnPattern
- Specified by:
getOwnPatternin interfaceJRTextField
-
setPattern
Description copied from interface:JRTextFieldSets 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:
setPatternin interfaceJRTextField
-
isBlankWhenNull
public boolean isBlankWhenNull()Description copied from interface:JRTextFieldIndicates whether an empty string will be displayed if the field's expression evaluates tonull.- Specified by:
isBlankWhenNullin interfaceJRTextField- Returns:
- true if an empty string will be displayed instead of null values, false otherwise
-
isOwnBlankWhenNull
- Specified by:
isOwnBlankWhenNullin interfaceJRTextField
-
setBlankWhenNull
Description copied from interface:JRTextFieldSpecifies whether an empty string should be displayed if the field's expression evaluates tonull.- Specified by:
setBlankWhenNullin interfaceJRTextField- Parameters:
isBlank- true if an empty string will be displayed instead of null values, false otherwise
-
getHyperlinkType
Description copied from interface:JRHyperlinkRetrieves 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,CUSTOMis returned.- Specified by:
getHyperlinkTypein interfaceJRHyperlink- Returns:
- one of the hyperlink type constants
- See Also:
-
getHyperlinkTarget
Description copied from interface:JRHyperlinkRetrieves 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.CUSTOMis returned.- Specified by:
getHyperlinkTargetin interfaceJRHyperlink- Returns:
- one of the hyperlink target constants
- See Also:
-
getLinkTarget
Description copied from interface:JRHyperlinkReturns 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:
getLinkTargetin interfaceJRHyperlink- Returns:
- the hyperlink target name
-
getEvaluationGroup
Description copied from interface:JREvaluationGets the evaluation group for this text field. Used only when evaluation time is group.- Specified by:
getEvaluationGroupin interfaceJREvaluation- See Also:
-
getExpression
Description copied from interface:JRTextFieldGets the expression for this field. The result obtained after evaluating this expression will be dispayed as the field text.- Specified by:
getExpressionin interfaceJRTextField
-
getPatternExpression
Description copied from interface:JRTextFieldGets the pattern expression, in case the patter needs to be dynamic.- Specified by:
getPatternExpressionin interfaceJRTextField- See Also:
-
getBookmarkLevelExpression
Description copied from interface:JRAnchorReturns 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:
getBookmarkLevelExpressionin interfaceJRAnchor
-
getAnchorNameExpression
Description copied from interface:JRAnchorReturns an expression whose value represents the anchor name.- Specified by:
getAnchorNameExpressionin interfaceJRAnchor
-
getHyperlinkReferenceExpression
Description copied from interface:JRHyperlinkReturns the expression whose value represents the hyperlink reference. It is only used when the hyperlink type is reference or anchor- Specified by:
getHyperlinkReferenceExpressionin interfaceJRHyperlink
-
getHyperlinkWhenExpression
Description copied from interface:JRHyperlinkReturns the expression that is evaluated in order to decide if the hyperlink should be displayed. This expression always returns a boolean value.- Specified by:
getHyperlinkWhenExpressionin interfaceJRHyperlink
-
getHyperlinkAnchorExpression
Description copied from interface:JRHyperlinkReturns the expression whose value represents the anchor. It is only used when the hyperlink type is anchor.- Specified by:
getHyperlinkAnchorExpressionin interfaceJRHyperlink
-
getHyperlinkPageExpression
Description copied from interface:JRHyperlinkReturns 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:
getHyperlinkPageExpressionin interfaceJRHyperlink
-
getValue
-
getAnchorName
-
getHyperlinkReference
-
getHyperlinkAnchor
-
getHyperlinkPage
-
getHyperlinkTooltip
-
getJRTemplateText
-
createElementTemplate
- Specified by:
createElementTemplatein classJRFillElement
-
evaluateTextFormat
-
getTemplate
- Overrides:
getTemplatein classJRFillElement
-
registerTemplate
- Overrides:
registerTemplatein classJRFillElement
-
delayedEvaluationUpdatesTemplate
protected boolean delayedEvaluationUpdatesTemplate()- Overrides:
delayedEvaluationUpdatesTemplatein classJRFillElement
-
toFormatTimeZone
-
evaluate
- Specified by:
evaluatein classJRFillElement- Throws:
JRException
-
evaluateText
- Throws:
JRException
-
getTimeZone
- Overrides:
getTimeZonein classJRFillElement
-
determineOwnTimeZone
protected void determineOwnTimeZone() -
getPatternTimeZone
-
prepare
public boolean prepare(int availableHeight, boolean isOverflow, boolean isOverflowAllowed) throws JRException - Overrides:
preparein classJRFillTextElement- Throws:
JRException
-
fill
- Specified by:
fillin classJRFillElement- Throws:
JRException
-
copy
-
textEvaluatedEvent
-
setPrintText
- Overrides:
setPrintTextin classJRFillTextElement
-
getFormat
-
getTemplatePattern
-
collectExpressions
- Specified by:
collectExpressionsin interfaceJRElement
-
visit
- Specified by:
visitin interfaceJRVisitable
-
resolveElement
Description copied from class:JRFillElementResolves an element.- Specified by:
resolveElementin classJRFillElement- Parameters:
element- the elementevaluation- the evaluation type- Throws:
JRException
-
getBookmarkLevel
public int getBookmarkLevel()Description copied from interface:JRAnchorReturns the level of the bookmark corresponding to the anchor.- Specified by:
getBookmarkLevelin interfaceJRAnchor- Returns:
- the level of the bookmark corresponding to the anchor (starting from 1)
or
NO_BOOKMARKif no bookmark should be created for this anchor
-
createClone
Description copied from interface:JRFillCloneableCreates a working clone of itself.- Specified by:
createClonein interfaceJRFillCloneable- Parameters:
factory- the clone factory to use while creating the clone- Returns:
- a working clone of itself
-
collectDelayedEvaluations
protected void collectDelayedEvaluations()- Overrides:
collectDelayedEvaluationsin classJRFillElement
-
getHyperlinkParameters
Description copied from interface:JRHyperlinkReturns the list of hyperlink parameters.The parameters can be used by custom hyperlink types to generate dynamic links.
- Specified by:
getHyperlinkParametersin interfaceJRHyperlink- Returns:
- the list of hyperlink parameters
-
getLinkType
Description copied from interface:JRHyperlinkReturns 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:
getLinkTypein interfaceJRHyperlink- Returns:
- the hyperlink type
-
getHyperlinkTooltipExpression
Description copied from interface:JRHyperlinkReturns the expression which will generate the hyperlink tooltip.- Specified by:
getHyperlinkTooltipExpressionin interfaceJRHyperlink- Returns:
- the expression which will generate the hyperlink tooltip
-
canOverflow
protected boolean canOverflow()- Specified by:
canOverflowin classJRFillTextElement
-
scaleFontToFit
protected boolean scaleFontToFit()- Specified by:
scaleFontToFitin classJRFillTextElement
-