public class JRTemplatePrintText extends JRTemplatePrintElement implements JRPrintText
JRPrintText that uses
a JRTemplateText instance to
store common attributes.| Modifier and Type | Field and Description |
|---|---|
protected int |
bookmarkLevel
The bookmark level for the anchor associated with this field.
|
EXCEPTION_MESSAGE_KEY_TEMPLATE_NOT_FOUND, templateZERO_LINE_BREAK_OFFSETSUNSET_PRINT_ELEMENT_ID, UNSET_SOURCE_ELEMENT_IDPROPERTY_IGNORE_HYPERLINK_SUFFIXDEFAULT_FONT_NAME, DEFAULT_FONT_SIZE, DEFAULT_PDF_EMBEDDED, DEFAULT_PDF_ENCODING, DEFAULT_PDF_FONT_NAMEMARKUP_HTML, MARKUP_NONE, MARKUP_RTF, MARKUP_STYLED_TEXT| Constructor and Description |
|---|
JRTemplatePrintText() |
JRTemplatePrintText(JRTemplateText text)
Deprecated.
provide a source Id via
JRTemplatePrintText(JRTemplateText, int) |
JRTemplatePrintText(JRTemplateText text,
int sourceElementId)
Deprecated.
|
JRTemplatePrintText(JRTemplateText text,
PrintElementOriginator originator)
Creates a print text element.
|
| Modifier and Type | Method and Description |
|---|---|
<T> void |
accept(PrintElementVisitor<T> visitor,
T arg)
Accepts a print element visitor.
|
String |
getAnchorName() |
int |
getBookmarkLevel()
Returns the level of the bookmark corresponding to the anchor.
|
String |
getFontName() |
float |
getFontsize() |
int |
getFontSize()
Deprecated.
Replaced by
getFontsize(). |
String |
getFormatFactoryClass()
Returns the name of the class implementing the
FormatFactory
interface to use with this text element, in case it is not the same as the one for the overall document. |
JRStyledText |
getFullStyledText(JRStyledTextAttributeSelector attributeSelector)
Returns the full styled text of this object.
|
String |
getFullText()
Returns the full (not truncated) text of this object.
|
HorizontalAlignEnum |
getHorizontalAlignmentValue()
Deprecated.
Replaced by
getHorizontalTextAlign(). |
HorizontalTextAlignEnum |
getHorizontalTextAlign()
Gets the text horizontal alignment.
|
String |
getHyperlinkAnchor() |
Integer |
getHyperlinkPage() |
JRPrintHyperlinkParameters |
getHyperlinkParameters()
Returns the set of custom hyperlink parameters.
|
String |
getHyperlinkReference() |
HyperlinkTargetEnum |
getHyperlinkTargetValue() |
String |
getHyperlinkTooltip()
Returns the hyperlink tooltip.
|
HyperlinkTypeEnum |
getHyperlinkTypeValue()
Retrieves the hyperlink type for the element.
|
float |
getLeadingOffset() |
JRLineBox |
getLineBox() |
short[] |
getLineBreakOffsets()
Returns the line break offsets for the text if saved during report fill.
|
float |
getLineSpacingFactor() |
LineSpacingEnum |
getLineSpacingValue()
Deprecated.
Replaced by
JRParagraph.getLineSpacing(). |
String |
getLinkTarget()
Returns the hyperlink target name.
|
String |
getLinkType()
Returns the hyperlink type.
|
String |
getLocaleCode()
Returns the code of the
java.util.Locale which was used
while formatting the source value of the text. |
String |
getMarkup()
Returns the text markup.
|
String |
getOriginalText()
Returns the original text that was set in this object.
|
String |
getOwnFontName() |
Float |
getOwnFontsize() |
Integer |
getOwnFontSize()
Deprecated.
Replaced by
getOwnFontsize(). |
HorizontalAlignEnum |
getOwnHorizontalAlignmentValue()
Deprecated.
Replaced by
getOwnHorizontalTextAlign(). |
HorizontalTextAlignEnum |
getOwnHorizontalTextAlign() |
LineSpacingEnum |
getOwnLineSpacingValue()
Deprecated.
Replaced by
JRParagraph.getOwnLineSpacing(). |
String |
getOwnMarkup() |
String |
getOwnPdfEncoding() |
String |
getOwnPdfFontName() |
RotationEnum |
getOwnRotationValue()
Gets the text own rotation.
|
VerticalAlignEnum |
getOwnVerticalAlignmentValue()
Deprecated.
Replaced by
getOwnVerticalTextAlign(). |
VerticalTextAlignEnum |
getOwnVerticalTextAlign() |
JRParagraph |
getParagraph() |
String |
getPattern()
Returns the pattern used to format a value that was the source of this text.
|
String |
getPdfEncoding() |
String |
getPdfFontName() |
RotationEnum |
getRotationValue()
Gets the text rotation.
|
RunDirectionEnum |
getRunDirectionValue()
Gets the text run direction.
|
float |
getTextHeight() |
Integer |
getTextTruncateIndex()
Returns the index to which this object's text is to be truncated.
|
String |
getTextTruncateSuffix()
Returns the suffix that is to be appended to the truncated text
(as returned by
JRStyledTextUtil.getTruncatedText(JRPrintText). |
String |
getTimeZoneId()
Returns the
ID of the java.util.TimeZone
used to format this text's date source value. |
Object |
getValue() |
String |
getValueClassName()
Returns the type of the value which was used to generate this text.
|
VerticalAlignEnum |
getVerticalAlignmentValue()
Deprecated.
Replaced by
getVerticalTextAlign(). |
VerticalTextAlignEnum |
getVerticalTextAlign()
Gets the text vertical alignment.
|
boolean |
isBold() |
boolean |
isItalic() |
Boolean |
isOwnBold() |
Boolean |
isOwnItalic() |
Boolean |
isOwnPdfEmbedded() |
Boolean |
isOwnStrikeThrough() |
Boolean |
isOwnUnderline() |
boolean |
isPdfEmbedded() |
boolean |
isStrikeThrough() |
boolean |
isUnderline() |
void |
readVirtualized(VirtualizationInput in) |
void |
setAnchorName(String anchorName) |
void |
setBold(boolean isBold) |
void |
setBold(Boolean isBold)
Alternative setBold method which allows also to reset
the "own" isBold property.
|
void |
setBookmarkLevel(int bookmarkLevel)
Sets the boomark level for the anchor.
|
void |
setFontName(String fontName) |
void |
setFontSize(Float fontSize)
Method which allows also to reset the "own" size property.
|
void |
setFontSize(int fontSize)
Deprecated.
Replaced by
setFontSize(Float). |
void |
setFontSize(Integer fontSize)
Deprecated.
Replaced by
setFontSize(Float). |
void |
setHorizontalAlignment(HorizontalAlignEnum horizontalAlignment)
Deprecated.
Replaced by
setHorizontalTextAlign(HorizontalTextAlignEnum). |
void |
setHorizontalTextAlign(HorizontalTextAlignEnum horizontalAlignment)
Sets the text horizontal alignment.
|
void |
setHyperlinkAnchor(String hyperlinkAnchor) |
void |
setHyperlinkOmitted(boolean hyperlinkOmitted) |
void |
setHyperlinkPage(Integer hyperlinkPage) |
void |
setHyperlinkParameters(JRPrintHyperlinkParameters hyperlinkParameters)
Sets the custom hyperlink parameters.
|
void |
setHyperlinkReference(String hyperlinkReference) |
void |
setHyperlinkTarget(HyperlinkTargetEnum hyperlinkTarget) |
void |
setHyperlinkTooltip(String hyperlinkTooltip)
Sets the tooltip to be used for the hyperlink.
|
void |
setHyperlinkType(HyperlinkTypeEnum hyperlinkType)
Sets the link type as a built-in hyperlink type.
|
void |
setItalic(boolean isItalic) |
void |
setItalic(Boolean isItalic)
Alternative setItalic method which allows also to reset
the "own" isItalic property.
|
void |
setLeadingOffset(float leadingOffset) |
void |
setLineBreakOffsets(short[] lineBreakOffsets)
Sets the line break offsets for the text.
|
void |
setLineSpacing(LineSpacingEnum lineSpacing)
Deprecated.
Replaced by
JRParagraph.setLineSpacing(LineSpacingEnum). |
void |
setLineSpacingFactor(float lineSpacingFactor) |
void |
setLinkTarget(byte hyperlinkTarget) |
void |
setLinkTarget(String linkTarget)
Sets the hyperlink target name.
|
void |
setLinkType(String type)
Sets the hyperlink type.
|
void |
setMarkup(String markup) |
void |
setPdfEmbedded(boolean isPdfEmbedded) |
void |
setPdfEmbedded(Boolean isPdfEmbedded)
Alternative setPdfEmbedded method which allows also to reset
the "own" isPdfEmbedded property.
|
void |
setPdfEncoding(String pdfEncoding) |
void |
setPdfFontName(String pdfFontName) |
void |
setRotation(RotationEnum rotation)
Sets the text rotation.
|
void |
setRunDirection(RunDirectionEnum runDirectionValue)
Sets the text run direction.
|
void |
setStrikeThrough(boolean isStrikeThrough) |
void |
setStrikeThrough(Boolean isStrikeThrough)
Alternative setStrikeThrough method which allows also to reset
the "own" isStrikeThrough property.
|
void |
setText(String text)
Set the text for this object.
|
void |
setTextFormat(TextFormat textFormat) |
void |
setTextHeight(float textHeight) |
void |
setTextTruncateIndex(Integer textTruncateIndex)
Sets the index to which this object's text is to be truncated.
|
void |
setTextTruncateSuffix(String textTruncateSuffix)
Sets the suffix to be appended to the truncated text.
|
void |
setUnderline(boolean isUnderline) |
void |
setUnderline(Boolean isUnderline)
Alternative setUnderline method which allows also to reset
the "own" isUnderline property.
|
void |
setValue(Object value) |
void |
setVerticalAlignment(VerticalAlignEnum verticalAlignment)
Deprecated.
Replaced by
setVerticalTextAlign(VerticalTextAlignEnum). |
void |
setVerticalTextAlign(VerticalTextAlignEnum verticalAlignment)
Gets the text vertical alignment.
|
void |
writeVirtualized(VirtualizationOutput out) |
getBackcolor, getDefaultLineColor, getDefaultStyleProvider, getForecolor, getHeight, getKey, getModeValue, getOrigin, getOwnBackcolor, getOwnForecolor, getOwnModeValue, getParentProperties, getPrintElementId, getPropertiesMap, getSourceElementId, getStyle, getStyleNameReference, getTemplate, getUUID, getWidth, getX, getY, hasProperties, setBackcolor, setForecolor, setHeight, setMode, setSourceElementId, setStyle, setTemplate, setUUID, setWidth, setX, setY, updateElementTemplateclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitgetHeight, getKey, getOrigin, getPrintElementId, getSourceElementId, getWidth, getX, getY, setHeight, setStyle, setUUID, setWidth, setX, setYgetParentProperties, getPropertiesMap, hasPropertiesgetUUIDgetBackcolor, getForecolor, getModeValue, getOwnBackcolor, getOwnForecolor, getOwnModeValue, setBackcolor, setForecolor, setModegetDefaultLineColorgetDefaultStyleProvider, getStyle, getStyleNameReferenceprotected int bookmarkLevel
JRAnchor.getBookmarkLevel()public JRTemplatePrintText()
public JRTemplatePrintText(JRTemplateText text)
JRTemplatePrintText(JRTemplateText, int)text - the template text that the element will usepublic JRTemplatePrintText(JRTemplateText text, int sourceElementId)
JRTemplatePrintText(JRTemplateText, PrintElementOriginator)text - the template text that the element will usesourceElementId - the Id of the source elementpublic JRTemplatePrintText(JRTemplateText text, PrintElementOriginator originator)
text - the template text that the element will useoriginator - public void setText(String text)
JRPrintTextsetText in interface JRPrintTexttext - the textJRPrintText.setTextTruncateIndex(Integer)public Integer getTextTruncateIndex()
JRPrintTextgetTextTruncateIndex in interface JRPrintTextJRTextElement.PROPERTY_PRINT_KEEP_FULL_TEXT,
JRPrintText.getTextTruncateSuffix()public void setTextTruncateIndex(Integer textTruncateIndex)
JRPrintTextJRStyledTextUtil.getTruncatedText(JRPrintText) or JRPrintText.getFullStyledText(JRStyledTextAttributeSelector)
are called.setTextTruncateIndex in interface JRPrintTexttextTruncateIndex - the index to which this object's text is to be truncatedpublic String getTextTruncateSuffix()
JRPrintTextJRStyledTextUtil.getTruncatedText(JRPrintText).getTextTruncateSuffix in interface JRPrintTextJRTextElement.PROPERTY_TRUNCATE_SUFFIXpublic void setTextTruncateSuffix(String textTruncateSuffix)
JRPrintTextsetTextTruncateSuffix in interface JRPrintTexttextTruncateSuffix - the suffix to be appended to the truncated textJRPrintText.getTextTruncateSuffix()public short[] getLineBreakOffsets()
JRPrintText
The array of offsets is incremental, each offset adds to the
previous value. I.e. the positions at which line breaks occur
are offset[0], offset[0] + offset[1],
offset[0] + offset[1] + offset[2] and so on.
This array does not include positions for explicit line breaks in the text, i.e. for line breaks that occur due to new line characters in the text. The array only includes line break positions within a paragraph in the text.
If the text was meant to have saved line break offsets but no (non
explicit) breaks were detected (e.g. if the text is a single line),
this method will return a zero-length array. If the text was not meant
to include saved line breaks, the method will return null.
getLineBreakOffsets in interface JRPrintTextnull if no line break positions were saved during the fillJRTextElement.PROPERTY_SAVE_LINE_BREAKSpublic void setLineBreakOffsets(short[] lineBreakOffsets)
JRPrintTextsetLineBreakOffsets in interface JRPrintTextlineBreakOffsets - the line break offsetsJRPrintText.getLineBreakOffsets()public String getFullText()
JRPrintTextgetFullText in interface JRPrintTextJRStyledTextUtil.getTruncatedText(JRPrintText),
JRPrintText.getTextTruncateIndex()public String getOriginalText()
JRPrintTextgetOriginalText in interface JRPrintTextpublic JRStyledText getFullStyledText(JRStyledTextAttributeSelector attributeSelector)
JRPrintTextgetFullStyledText in interface JRPrintTextattributeSelector - the styled text attribute selectorJRPrintText.getFullText()public Object getValue()
getValue in interface JRPrintTextpublic void setValue(Object value)
setValue in interface JRPrintTextpublic float getLineSpacingFactor()
getLineSpacingFactor in interface JRPrintTextpublic void setLineSpacingFactor(float lineSpacingFactor)
setLineSpacingFactor in interface JRPrintTextpublic float getLeadingOffset()
getLeadingOffset in interface JRPrintTextpublic void setLeadingOffset(float leadingOffset)
setLeadingOffset in interface JRPrintTextpublic HorizontalAlignEnum getHorizontalAlignmentValue()
getHorizontalTextAlign().JRAlignmentgetHorizontalAlignmentValue in interface JRAlignmentHorizontalAlignEnumpublic HorizontalAlignEnum getOwnHorizontalAlignmentValue()
getOwnHorizontalTextAlign().getOwnHorizontalAlignmentValue in interface JRAlignmentpublic void setHorizontalAlignment(HorizontalAlignEnum horizontalAlignment)
setHorizontalTextAlign(HorizontalTextAlignEnum).JRAlignmentsetHorizontalAlignment in interface JRAlignmenthorizontalAlignment - a value representing one of the horizontal alignment constants in HorizontalAlignEnumpublic VerticalAlignEnum getVerticalAlignmentValue()
getVerticalTextAlign().JRAlignmentgetVerticalAlignmentValue in interface JRAlignmentVerticalAlignEnumpublic VerticalAlignEnum getOwnVerticalAlignmentValue()
getOwnVerticalTextAlign().getOwnVerticalAlignmentValue in interface JRAlignmentpublic void setVerticalAlignment(VerticalAlignEnum verticalAlignment)
setVerticalTextAlign(VerticalTextAlignEnum).JRAlignmentsetVerticalAlignment in interface JRAlignmentverticalAlignment - a value representing one of the vertical alignment constants in VerticalAlignEnumpublic HorizontalTextAlignEnum getHorizontalTextAlign()
JRTextAlignmentgetHorizontalTextAlign in interface JRTextAlignmentHorizontalTextAlignEnumpublic HorizontalTextAlignEnum getOwnHorizontalTextAlign()
getOwnHorizontalTextAlign in interface JRTextAlignmentpublic void setHorizontalTextAlign(HorizontalTextAlignEnum horizontalAlignment)
JRTextAlignmentsetHorizontalTextAlign in interface JRTextAlignmenthorizontalAlignment - a value representing one of the horizontal text alignment constants in HorizontalTextAlignEnumpublic VerticalTextAlignEnum getVerticalTextAlign()
JRTextAlignmentgetVerticalTextAlign in interface JRTextAlignmentVerticalTextAlignEnumpublic VerticalTextAlignEnum getOwnVerticalTextAlign()
getOwnVerticalTextAlign in interface JRTextAlignmentpublic void setVerticalTextAlign(VerticalTextAlignEnum verticalAlignment)
JRTextAlignmentsetVerticalTextAlign in interface JRTextAlignmentverticalAlignment - a value representing one of the vertical text alignment constants in VerticalTextAlignEnumpublic RotationEnum getRotationValue()
JRCommonTextgetRotationValue in interface JRCommonTextRotationEnumpublic RotationEnum getOwnRotationValue()
JRPrintTextgetOwnRotationValue in interface JRCommonTextgetOwnRotationValue in interface JRPrintTextRotationEnumpublic void setRotation(RotationEnum rotation)
JRPrintTextsetRotation in interface JRCommonTextsetRotation in interface JRPrintTextrotation - a value representing one of the text rotation constants in RotationEnumpublic RunDirectionEnum getRunDirectionValue()
JRPrintTextgetRunDirectionValue in interface JRPrintTextRunDirectionEnumpublic void setRunDirection(RunDirectionEnum runDirectionValue)
JRPrintTextsetRunDirection in interface JRPrintTextrunDirectionValue - a value representing one of the text run direction constants in RunDirectionEnumpublic float getTextHeight()
getTextHeight in interface JRPrintTextpublic void setTextHeight(float textHeight)
setTextHeight in interface JRPrintTextpublic LineSpacingEnum getLineSpacingValue()
JRParagraph.getLineSpacing().getLineSpacingValue in interface JRCommonTextpublic LineSpacingEnum getOwnLineSpacingValue()
JRParagraph.getOwnLineSpacing().getOwnLineSpacingValue in interface JRCommonTextgetOwnLineSpacingValue in interface JRPrintTextpublic void setLineSpacing(LineSpacingEnum lineSpacing)
JRParagraph.setLineSpacing(LineSpacingEnum).setLineSpacing in interface JRCommonTextsetLineSpacing in interface JRPrintTextpublic String getMarkup()
JRCommonTextgetMarkup in interface JRCommonTextpublic String getOwnMarkup()
getOwnMarkup in interface JRCommonTextgetOwnMarkup in interface JRPrintTextpublic void setMarkup(String markup)
setMarkup in interface JRCommonTextsetMarkup in interface JRPrintTextpublic JRLineBox getLineBox()
getLineBox in interface JRBoxContainerpublic JRParagraph getParagraph()
getParagraph in interface JRParagraphContainerpublic void setTextFormat(TextFormat textFormat)
setTextFormat in interface JRPrintTextpublic String getAnchorName()
getAnchorName in interface JRPrintAnchorpublic void setAnchorName(String anchorName)
setAnchorName in interface JRPrintAnchorpublic void setHyperlinkOmitted(boolean hyperlinkOmitted)
public HyperlinkTypeEnum getHyperlinkTypeValue()
JRPrintHyperlink
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 JRPrintHyperlinkJRPrintHyperlink.getLinkType()public void setHyperlinkType(HyperlinkTypeEnum hyperlinkType)
JRPrintHyperlinksetHyperlinkType in interface JRPrintHyperlinkhyperlinkType - the built-in hyperlink typeJRPrintHyperlink.getLinkType()public HyperlinkTargetEnum getHyperlinkTargetValue()
getHyperlinkTargetValue in interface JRPrintHyperlinkpublic void setHyperlinkTarget(HyperlinkTargetEnum hyperlinkTarget)
setHyperlinkTarget in interface JRPrintHyperlinkpublic String getLinkTarget()
JRPrintHyperlinkThe target name can be one of the built-in names (Self, Blank, Top, Parent), or can be an arbitrary name.
getLinkTarget in interface JRPrintHyperlinkpublic void setLinkTarget(String linkTarget)
JRPrintHyperlinkThe target name can be one of the built-in names (Self, Blank, Top, Parent), or can be an arbitrary name.
setLinkTarget in interface JRPrintHyperlinklinkTarget - the hyperlink target namepublic void setLinkTarget(byte hyperlinkTarget)
public String getHyperlinkReference()
getHyperlinkReference in interface JRPrintHyperlinkpublic void setHyperlinkReference(String hyperlinkReference)
setHyperlinkReference in interface JRPrintHyperlinkpublic String getHyperlinkAnchor()
getHyperlinkAnchor in interface JRPrintHyperlinkpublic void setHyperlinkAnchor(String hyperlinkAnchor)
setHyperlinkAnchor in interface JRPrintHyperlinkpublic Integer getHyperlinkPage()
getHyperlinkPage in interface JRPrintHyperlinkpublic void setHyperlinkPage(Integer hyperlinkPage)
setHyperlinkPage in interface JRPrintHyperlinkpublic int getBookmarkLevel()
JRPrintAnchorgetBookmarkLevel in interface JRPrintAnchorNO_BOOKMARK if no bookmark should be created for this anchorpublic void setBookmarkLevel(int bookmarkLevel)
JRPrintAnchorsetBookmarkLevel in interface JRPrintAnchorbookmarkLevel - the bookmark level (starting from 1)
or NO_BOOKMARK if no bookmark should be createdpublic String getFontName()
getFontName in interface JRFontpublic String getOwnFontName()
getOwnFontName in interface JRFontpublic void setFontName(String fontName)
setFontName in interface JRFontpublic void setBold(Boolean isBold)
public Boolean isOwnItalic()
isOwnItalic in interface JRFontpublic void setItalic(Boolean isItalic)
public boolean isUnderline()
isUnderline in interface JRFontpublic Boolean isOwnUnderline()
isOwnUnderline in interface JRFontpublic void setUnderline(boolean isUnderline)
setUnderline in interface JRFontpublic void setUnderline(Boolean isUnderline)
setUnderline in interface JRFontpublic boolean isStrikeThrough()
isStrikeThrough in interface JRFontpublic Boolean isOwnStrikeThrough()
isOwnStrikeThrough in interface JRFontpublic void setStrikeThrough(boolean isStrikeThrough)
setStrikeThrough in interface JRFontpublic void setStrikeThrough(Boolean isStrikeThrough)
setStrikeThrough in interface JRFontpublic float getFontsize()
getFontsize in interface JRCommonTextgetFontsize in interface JRFontpublic Float getOwnFontsize()
getOwnFontsize in interface JRFontpublic void setFontSize(Float fontSize)
setFontSize in interface JRFontpublic int getFontSize()
getFontsize().getFontSize in interface JRCommonTextgetFontSize in interface JRFontpublic Integer getOwnFontSize()
getOwnFontsize().getOwnFontSize in interface JRFontpublic void setFontSize(int fontSize)
setFontSize(Float).setFontSize in interface JRFontpublic void setFontSize(Integer fontSize)
setFontSize(Float).setFontSize in interface JRFontpublic String getPdfFontName()
getPdfFontName in interface JRFontpublic String getOwnPdfFontName()
getOwnPdfFontName in interface JRFontpublic void setPdfFontName(String pdfFontName)
setPdfFontName in interface JRFontpublic String getPdfEncoding()
getPdfEncoding in interface JRFontpublic String getOwnPdfEncoding()
getOwnPdfEncoding in interface JRFontpublic void setPdfEncoding(String pdfEncoding)
setPdfEncoding in interface JRFontpublic boolean isPdfEmbedded()
isPdfEmbedded in interface JRFontpublic Boolean isOwnPdfEmbedded()
isOwnPdfEmbedded in interface JRFontpublic void setPdfEmbedded(boolean isPdfEmbedded)
setPdfEmbedded in interface JRFontpublic void setPdfEmbedded(Boolean isPdfEmbedded)
setPdfEmbedded in interface JRFontpublic String getValueClassName()
JRPrintText
Text fields that have a non-String expression
save the value type using this attribute. This information can be used by
exporters to treat numerical or date texts (for instance) in a special manner.
getValueClassName in interface TextFormatgetValueClassName in interface JRPrintTextpublic String getPattern()
JRPrintTextThe pattern can be used to parse the text back to its source value.
getPattern in interface TextFormatgetPattern in interface JRPrintTextJRPrintText.getValueClassName()public String getFormatFactoryClass()
JRPrintTextFormatFactory
interface to use with this text element, in case it is not the same as the one for the overall document.getFormatFactoryClass in interface TextFormatgetFormatFactoryClass in interface JRPrintTextpublic String getLocaleCode()
JRPrintTextjava.util.Locale which was used
while formatting the source value of the text.
The code is created using the java.util.Locale.toString()
convention.
When this attribute is null, the locale returned by
JasperPrint.getLocaleCode() is used.
This way, the locale is specified in a single place when all the (or many ) texts from a print object
were formatted using the same locale.
getLocaleCode in interface TextFormatgetLocaleCode in interface JRPrintTextjava.util.Locale used when formatting this text's source valuepublic String getTimeZoneId()
JRPrintTextID of the java.util.TimeZone
used to format this text's date source value.
When this attribute is null, the time zone returned by
JasperPrint.getTimeZoneId() is used.
getTimeZoneId in interface TextFormatgetTimeZoneId in interface JRPrintTextID of the java.util.TimeZone
used to format this text's date source valuepublic JRPrintHyperlinkParameters getHyperlinkParameters()
JRPrintHyperlinkgetHyperlinkParameters in interface JRPrintHyperlinkJRPrintHyperlink.setHyperlinkParameters(JRPrintHyperlinkParameters),
JRPrintHyperlinkParameterpublic void setHyperlinkParameters(JRPrintHyperlinkParameters hyperlinkParameters)
JRPrintHyperlinkThese parameters will be used to produce the actual hyperlink when the report is exported.
setHyperlinkParameters in interface JRPrintHyperlinkhyperlinkParameters - the set of custom hyperlink parameterspublic String getLinkType()
JRPrintHyperlinkgetLinkType in interface JRPrintHyperlinkpublic void setLinkType(String type)
JRPrintHyperlinkThe type can be one of the built-in types (Reference, LocalAnchor, LocalPage, RemoteAnchor, RemotePage), or can be an arbitrary type.
setLinkType in interface JRPrintHyperlinktype - the hyperlink typepublic String getHyperlinkTooltip()
JRPrintHyperlinkgetHyperlinkTooltip in interface JRPrintHyperlinkpublic void setHyperlinkTooltip(String hyperlinkTooltip)
JRPrintHyperlinksetHyperlinkTooltip in interface JRPrintHyperlinkhyperlinkTooltip - the tooltippublic <T> void accept(PrintElementVisitor<T> visitor, T arg)
JRPrintElementThe element calls the method that corresponds to the element type on the visitor.
accept in interface JRPrintElementaccept in class JRTemplatePrintElementT - the type of the argument passed to the visit operationvisitor - the visitor objectsarg - the argument passed to the visit operationpublic void writeVirtualized(VirtualizationOutput out) throws IOException
writeVirtualized in interface VirtualizationSerializablewriteVirtualized in class JRTemplatePrintElementIOExceptionpublic void readVirtualized(VirtualizationInput in) throws IOException
readVirtualized in interface VirtualizationSerializablereadVirtualized in class JRTemplatePrintElementIOExceptionCopyright © 2017. All rights reserved.