net.sf.jasperreports.engine.fill
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.
|
templateRUN_DIRECTION_LTR, RUN_DIRECTION_RTL, ZERO_LINE_BREAK_OFFSETSHORIZONTAL_ALIGN_CENTER, HORIZONTAL_ALIGN_JUSTIFIED, HORIZONTAL_ALIGN_LEFT, HORIZONTAL_ALIGN_RIGHT, VERTICAL_ALIGN_BOTTOM, VERTICAL_ALIGN_JUSTIFIED, VERTICAL_ALIGN_MIDDLE, VERTICAL_ALIGN_TOPDEFAULT_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(JRTemplateText text)
Creates a print text element.
|
| Modifier and Type | Method and Description |
|---|---|
<T> void |
accept(PrintElementVisitor<T> visitor,
T arg)
Accepts a print element visitor.
|
java.lang.String |
getAnchorName() |
int |
getBookmarkLevel()
Returns the level of the bookmark corresponding to the anchor.
|
byte |
getBorder()
Deprecated.
Replaced by
getBox() |
java.awt.Color |
getBorderColor()
Deprecated.
Replaced by
getBox() |
byte |
getBottomBorder()
Deprecated.
Replaced by
getBox() |
java.awt.Color |
getBottomBorderColor()
Deprecated.
Replaced by
getBox() |
int |
getBottomPadding()
Deprecated.
Replaced by
getBox() |
JRBox |
getBox()
Deprecated.
Replaced by
getLineBox() |
JRFont |
getFont()
Deprecated.
|
java.lang.String |
getFontName() |
int |
getFontSize() |
java.lang.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.
|
java.lang.String |
getFullText()
Returns the full (not truncated) text of this object.
|
byte |
getHorizontalAlignment()
Deprecated.
Replaced by
getHorizontalAlignmentValue(). |
HorizontalAlignEnum |
getHorizontalAlignmentValue()
Gets the text horizontal alignment.
|
java.lang.String |
getHyperlinkAnchor() |
java.lang.Integer |
getHyperlinkPage() |
JRPrintHyperlinkParameters |
getHyperlinkParameters()
Returns the set of custom hyperlink parameters.
|
java.lang.String |
getHyperlinkReference() |
byte |
getHyperlinkTarget()
Deprecated.
Replaced by
getHyperlinkTargetValue(). |
HyperlinkTargetEnum |
getHyperlinkTargetValue() |
java.lang.String |
getHyperlinkTooltip()
Returns the hyperlink tooltip.
|
byte |
getHyperlinkType()
Deprecated.
Replaced by
getHyperlinkTypeValue(). |
HyperlinkTypeEnum |
getHyperlinkTypeValue()
Retrieves the hyperlink type for the element.
|
float |
getLeadingOffset() |
byte |
getLeftBorder()
Deprecated.
Replaced by
getBox() |
java.awt.Color |
getLeftBorderColor()
Deprecated.
Replaced by
getBox() |
int |
getLeftPadding()
Deprecated.
Replaced by
getBox() |
JRLineBox |
getLineBox() |
short[] |
getLineBreakOffsets()
Returns the line break offsets for the text if saved during report fill.
|
byte |
getLineSpacing()
Deprecated.
Replaced by
getLineSpacingValue(). |
float |
getLineSpacingFactor() |
LineSpacingEnum |
getLineSpacingValue()
Gets the text line spacing.
|
java.lang.String |
getLinkTarget()
Returns the hyperlink target name.
|
java.lang.String |
getLinkType()
Returns the hyperlink type.
|
java.lang.String |
getLocaleCode()
Returns the code of the
java.util.Locale which was used
while formatting the source value of the text. |
java.lang.String |
getMarkup()
Returns the text markup.
|
java.lang.String |
getOriginalText()
Returns the original text that was set in this object.
|
java.lang.Byte |
getOwnBorder()
Deprecated.
Replaced by
getBox() |
java.awt.Color |
getOwnBorderColor()
Deprecated.
Replaced by
getBox() |
java.lang.Byte |
getOwnBottomBorder()
Deprecated.
Replaced by
getBox() |
java.awt.Color |
getOwnBottomBorderColor()
Deprecated.
Replaced by
getBox() |
java.lang.Integer |
getOwnBottomPadding()
Deprecated.
Replaced by
getBox() |
java.lang.String |
getOwnFontName() |
java.lang.Integer |
getOwnFontSize() |
java.lang.Byte |
getOwnHorizontalAlignment()
Deprecated.
Replaced by
getOwnHorizontalAlignmentValue(). |
HorizontalAlignEnum |
getOwnHorizontalAlignmentValue() |
java.lang.Byte |
getOwnLeftBorder()
Deprecated.
Replaced by
getBox() |
java.awt.Color |
getOwnLeftBorderColor()
Deprecated.
Replaced by
getBox() |
java.lang.Integer |
getOwnLeftPadding()
Deprecated.
Replaced by
getBox() |
java.lang.Byte |
getOwnLineSpacing()
Deprecated.
Replaced by
getOwnLineSpacingValue(). |
LineSpacingEnum |
getOwnLineSpacingValue()
Gets the text own line spacing.
|
java.lang.String |
getOwnMarkup() |
java.lang.Integer |
getOwnPadding()
Deprecated.
Replaced by
getBox() |
java.lang.String |
getOwnPdfEncoding() |
java.lang.String |
getOwnPdfFontName() |
java.lang.Byte |
getOwnRightBorder()
Deprecated.
Replaced by
getBox() |
java.awt.Color |
getOwnRightBorderColor()
Deprecated.
Replaced by
getBox() |
java.lang.Integer |
getOwnRightPadding()
Deprecated.
Replaced by
getBox() |
java.lang.Byte |
getOwnRotation()
Deprecated.
Replaced by
getOwnRotationValue(). |
RotationEnum |
getOwnRotationValue()
Gets the text own rotation.
|
java.lang.Integer |
getOwnSize()
Deprecated.
Replaced by
getOwnFontSize(). |
java.lang.Byte |
getOwnTopBorder()
Deprecated.
Replaced by
getBox() |
java.awt.Color |
getOwnTopBorderColor()
Deprecated.
Replaced by
getBox() |
java.lang.Integer |
getOwnTopPadding()
Deprecated.
Replaced by
getBox() |
java.lang.Byte |
getOwnVerticalAlignment()
Deprecated.
Replaced by
getOwnVerticalAlignmentValue(). |
VerticalAlignEnum |
getOwnVerticalAlignmentValue() |
int |
getPadding()
Deprecated.
Replaced by
getBox() |
java.lang.String |
getPattern()
Returns the pattern used to format a value that was the source of this text.
|
java.lang.String |
getPdfEncoding() |
java.lang.String |
getPdfFontName() |
JRReportFont |
getReportFont() |
byte |
getRightBorder()
Deprecated.
Replaced by
getBox() |
java.awt.Color |
getRightBorderColor()
Deprecated.
Replaced by
getBox() |
int |
getRightPadding()
Deprecated.
Replaced by
getBox() |
byte |
getRotation()
Deprecated.
Replaced by
getRotationValue(). |
RotationEnum |
getRotationValue()
Gets the text rotation.
|
byte |
getRunDirection()
Deprecated.
Replaced by
getRunDirectionValue(). |
RunDirectionEnum |
getRunDirectionValue()
Gets the text run direction.
|
int |
getSize()
Deprecated.
Replaced by
getFontSize(). |
JRStyledText |
getStyledText(JRStyledTextAttributeSelector attributeSelector)
Returns the styled text for this object.
|
java.lang.String |
getText()
Returns the possibly truncated (when
JRPrintText.getTextTruncateIndex() is not null) text of this object. |
byte |
getTextAlignment()
Deprecated.
Replaced by
getHorizontalAlignment(). |
float |
getTextHeight() |
java.lang.Integer |
getTextTruncateIndex()
Returns the index to which this object's text is to be truncated.
|
java.lang.String |
getTextTruncateSuffix()
Returns the suffix that is to be appended to the truncated text
(as returned by
JRPrintText.getText(). |
java.lang.String |
getTimeZoneId()
Returns the
ID of the java.util.TimeZone
used to format this text's date source value. |
byte |
getTopBorder()
Deprecated.
Replaced by
getBox() |
java.awt.Color |
getTopBorderColor()
Deprecated.
Replaced by
getBox() |
int |
getTopPadding()
Deprecated.
Replaced by
getBox() |
java.lang.String |
getValueClassName()
Returns the type of the value which was used to generate this text.
|
byte |
getVerticalAlignment()
Deprecated.
Replaced by
getVerticalAlignmentValue(). |
VerticalAlignEnum |
getVerticalAlignmentValue()
Gets the text vertical alignment.
|
boolean |
isBold() |
boolean |
isItalic() |
java.lang.Boolean |
isOwnBold() |
java.lang.Boolean |
isOwnItalic() |
java.lang.Boolean |
isOwnPdfEmbedded() |
java.lang.Boolean |
isOwnStrikeThrough() |
java.lang.Boolean |
isOwnStyledText()
Deprecated.
Replaced by
getOwnMarkup() |
java.lang.Boolean |
isOwnUnderline() |
boolean |
isPdfEmbedded() |
boolean |
isStrikeThrough() |
boolean |
isStyledText()
Deprecated.
Replaced by
getMarkup() |
boolean |
isUnderline() |
void |
setAnchorName(java.lang.String anchorName) |
void |
setBold(boolean isBold) |
void |
setBold(java.lang.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 |
setBorder(byte border)
Deprecated.
Replaced by
getBox() |
void |
setBorder(java.lang.Byte border)
Deprecated.
Replaced by
getBox() |
void |
setBorderColor(java.awt.Color borderColor)
Deprecated.
Replaced by
getBox() |
void |
setBottomBorder(byte bottomBorder)
Deprecated.
Replaced by
getBox() |
void |
setBottomBorder(java.lang.Byte bottomBorder)
Deprecated.
Replaced by
getBox() |
void |
setBottomBorderColor(java.awt.Color bottomBorderColor)
Deprecated.
Replaced by
getBox() |
void |
setBottomPadding(int bottomPadding)
Deprecated.
Replaced by
getBox() |
void |
setBottomPadding(java.lang.Integer bottomPadding)
Deprecated.
Replaced by
getBox() |
void |
setBox(JRBox box)
Deprecated.
Replaced by
getLineBox() |
void |
setFont(JRFont font)
Deprecated.
|
void |
setFontName(java.lang.String fontName) |
void |
setFontSize(int fontSize) |
void |
setFontSize(java.lang.Integer fontSize)
Alternative setSize method which allows also to reset
the "own" size property.
|
void |
setHorizontalAlignment(byte horizontalAlignment)
Deprecated.
Replaced by
setHorizontalAlignment(HorizontalAlignEnum). |
void |
setHorizontalAlignment(java.lang.Byte horizontalAlignment)
Deprecated.
Replaced by
setHorizontalAlignment(HorizontalAlignEnum). |
void |
setHorizontalAlignment(HorizontalAlignEnum horizontalAlignment)
Sets the text horizontal alignment.
|
void |
setHyperlinkAnchor(java.lang.String hyperlinkAnchor) |
void |
setHyperlinkPage(java.lang.Integer hyperlinkPage) |
void |
setHyperlinkParameters(JRPrintHyperlinkParameters hyperlinkParameters)
Sets the custom hyperlink parameters.
|
void |
setHyperlinkReference(java.lang.String hyperlinkReference) |
void |
setHyperlinkTarget(byte hyperlinkTarget)
Deprecated.
Replaced by
setHyperlinkTarget(HyperlinkTargetEnum). |
void |
setHyperlinkTarget(HyperlinkTargetEnum hyperlinkTarget) |
void |
setHyperlinkTooltip(java.lang.String hyperlinkTooltip)
Sets the tooltip to be used for the hyperlink.
|
void |
setHyperlinkType(byte hyperlinkType)
Deprecated.
Replaced by
setHyperlinkType(HyperlinkTypeEnum). |
void |
setHyperlinkType(HyperlinkTypeEnum hyperlinkType)
Sets the link type as a built-in hyperlink type.
|
void |
setItalic(boolean isItalic) |
void |
setItalic(java.lang.Boolean isItalic)
Alternative setItalic method which allows also to reset
the "own" isItalic property.
|
void |
setLeadingOffset(float leadingOffset) |
void |
setLeftBorder(byte leftBorder)
Deprecated.
Replaced by
getBox() |
void |
setLeftBorder(java.lang.Byte leftBorder)
Deprecated.
Replaced by
getBox() |
void |
setLeftBorderColor(java.awt.Color leftBorderColor)
Deprecated.
Replaced by
getBox() |
void |
setLeftPadding(int leftPadding)
Deprecated.
Replaced by
getBox() |
void |
setLeftPadding(java.lang.Integer leftPadding)
Deprecated.
Replaced by
getBox() |
void |
setLineBreakOffsets(short[] lineBreakOffsets)
Sets the line break offsets for the text.
|
void |
setLineSpacing(byte lineSpacing)
Deprecated.
Replaced by
setLineSpacing(LineSpacingEnum). |
void |
setLineSpacing(java.lang.Byte lineSpacing)
Deprecated.
Replaced by
setLineSpacing(LineSpacingEnum). |
void |
setLineSpacing(LineSpacingEnum lineSpacing)
Sets the text line spacing.
|
void |
setLineSpacingFactor(float lineSpacingFactor) |
void |
setLinkTarget(byte hyperlinkTarget) |
void |
setLinkTarget(java.lang.String linkTarget)
Sets the hyperlink target name.
|
void |
setLinkType(java.lang.String type)
Sets the hyperlink type.
|
void |
setMarkup(java.lang.String markup) |
void |
setPadding(int padding)
Deprecated.
Replaced by
getBox() |
void |
setPadding(java.lang.Integer padding)
Deprecated.
Replaced by
getBox() |
void |
setPdfEmbedded(boolean isPdfEmbedded) |
void |
setPdfEmbedded(java.lang.Boolean isPdfEmbedded)
Alternative setPdfEmbedded method which allows also to reset
the "own" isPdfEmbedded property.
|
void |
setPdfEncoding(java.lang.String pdfEncoding) |
void |
setPdfFontName(java.lang.String pdfFontName) |
void |
setReportFont(JRReportFont reportFont) |
void |
setRightBorder(byte rightBorder)
Deprecated.
Replaced by
getBox() |
void |
setRightBorder(java.lang.Byte rightBorder)
Deprecated.
Replaced by
getBox() |
void |
setRightBorderColor(java.awt.Color rightBorderColor)
Deprecated.
Replaced by
getBox() |
void |
setRightPadding(int rightPadding)
Deprecated.
Replaced by
getBox() |
void |
setRightPadding(java.lang.Integer rightPadding)
Deprecated.
Replaced by
getBox() |
void |
setRotation(byte rotation)
Deprecated.
Replaced by
setRotation(RotationEnum). |
void |
setRotation(java.lang.Byte rotation)
Deprecated.
Replaced by
setRotation(RotationEnum). |
void |
setRotation(RotationEnum rotation)
Sets the text rotation.
|
void |
setRunDirection(byte runDirection)
Deprecated.
Replaced by
setRunDirection(RunDirectionEnum). |
void |
setRunDirection(RunDirectionEnum runDirectionValue)
Sets the text run direction.
|
void |
setSize(int size)
Deprecated.
Replaced by
setFontSize(int). |
void |
setSize(java.lang.Integer size)
Deprecated.
Replaced by
setFontSize(Integer). |
void |
setStrikeThrough(boolean isStrikeThrough) |
void |
setStrikeThrough(java.lang.Boolean isStrikeThrough)
Alternative setStrikeThrough method which allows also to reset
the "own" isStrikeThrough property.
|
void |
setStyledText(boolean isStyledText)
Deprecated.
Replaced by
setMarkup(String). |
void |
setStyledText(java.lang.Boolean isStyledText)
Deprecated.
Replaced by
setMarkup(String). |
void |
setText(java.lang.String text)
Set the text for this object.
|
void |
setTextAlignment(byte horizontalAlignment)
Deprecated.
Replaced by
setHorizontalAlignment(byte). |
void |
setTextHeight(float textHeight) |
void |
setTextTruncateIndex(java.lang.Integer textTruncateIndex)
Sets the index to which this object's text is to be truncated.
|
void |
setTextTruncateSuffix(java.lang.String textTruncateSuffix)
Sets the suffix to be appended to the truncated text.
|
void |
setTopBorder(byte topBorder)
Deprecated.
Replaced by
getBox() |
void |
setTopBorder(java.lang.Byte topBorder)
Deprecated.
Replaced by
getBox() |
void |
setTopBorderColor(java.awt.Color topBorderColor)
Deprecated.
Replaced by
getBox() |
void |
setTopPadding(int topPadding)
Deprecated.
Replaced by
getBox() |
void |
setTopPadding(java.lang.Integer topPadding)
Deprecated.
Replaced by
getBox() |
void |
setUnderline(boolean isUnderline) |
void |
setUnderline(java.lang.Boolean isUnderline)
Alternative setUnderline method which allows also to reset
the "own" isUnderline property.
|
void |
setVerticalAlignment(byte verticalAlignment)
Deprecated.
Replaced by
setVerticalAlignment(VerticalAlignEnum). |
void |
setVerticalAlignment(java.lang.Byte verticalAlignment)
Deprecated.
Replaced by
setVerticalAlignment(VerticalAlignEnum). |
void |
setVerticalAlignment(VerticalAlignEnum verticalAlignment)
Gets the text vertical alignment.
|
getBackcolor, getDefaultLineColor, getDefaultStyleProvider, getForecolor, getHeight, getKey, getMode, getModeValue, getOrigin, getOwnBackcolor, getOwnForecolor, getOwnMode, getOwnModeValue, getParentProperties, getPropertiesMap, getStyle, getStyleNameReference, getTemplate, getWidth, getX, getY, hasProperties, setBackcolor, setForecolor, setHeight, setMode, setMode, setMode, setStyle, setTemplate, setWidth, setX, setY, updateElementTemplateclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitgetHeight, getKey, getOrigin, getWidth, getX, getY, setHeight, setStyle, setWidth, setX, setYgetParentProperties, getPropertiesMap, hasPropertiesgetBackcolor, getForecolor, getMode, getModeValue, getOwnBackcolor, getOwnForecolor, getOwnMode, getOwnModeValue, setBackcolor, setForecolor, setMode, setMode, setModegetDefaultLineColorgetDefaultStyleProvider, getStyle, getStyleNameReferenceprotected int bookmarkLevel
JRAnchor.getBookmarkLevel()public JRTemplatePrintText(JRTemplateText text)
text - the template text that the element will usepublic java.lang.String getText()
JRPrintTextJRPrintText.getTextTruncateIndex() is not null) text of this object.getText in interface JRPrintTextJRPrintText.getFullText(),
JRPrintText.getTextTruncateSuffix()public void setText(java.lang.String text)
JRPrintTextsetText in interface JRPrintTexttext - the textJRPrintText.setTextTruncateIndex(Integer)public java.lang.Integer getTextTruncateIndex()
JRPrintTextgetTextTruncateIndex in interface JRPrintTextJRTextElement.PROPERTY_PRINT_KEEP_FULL_TEXT,
JRPrintText.getTextTruncateSuffix()public void setTextTruncateIndex(java.lang.Integer textTruncateIndex)
JRPrintTextJRPrintText.getText() or JRPrintText.getStyledText(JRStyledTextAttributeSelector)
are called.setTextTruncateIndex in interface JRPrintTexttextTruncateIndex - the index to which this object's text is to be truncatedpublic java.lang.String getTextTruncateSuffix()
JRPrintTextJRPrintText.getText().getTextTruncateSuffix in interface JRPrintTextJRTextElement.PROPERTY_TRUNCATE_SUFFIXpublic void setTextTruncateSuffix(java.lang.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 java.lang.String getFullText()
JRPrintTextgetFullText in interface JRPrintTextJRPrintText.getText(),
JRPrintText.getTextTruncateIndex()public java.lang.String getOriginalText()
JRPrintTextgetOriginalText in interface JRPrintTextpublic JRStyledText getStyledText(JRStyledTextAttributeSelector attributeSelector)
JRPrintTextJRPrintText.getText().getStyledText in interface JRPrintTextattributeSelector - the styled text attribute selectorpublic JRStyledText getFullStyledText(JRStyledTextAttributeSelector attributeSelector)
JRPrintTextgetFullStyledText in interface JRPrintTextattributeSelector - the styled text attribute selectorJRPrintText.getFullText()public 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 byte getTextAlignment()
getHorizontalAlignment().getTextAlignment in interface JRPrintTextpublic void setTextAlignment(byte horizontalAlignment)
setHorizontalAlignment(byte).setTextAlignment in interface JRPrintTextpublic byte getHorizontalAlignment()
getHorizontalAlignmentValue().getHorizontalAlignment in interface JRAlignmentpublic java.lang.Byte getOwnHorizontalAlignment()
getOwnHorizontalAlignmentValue().getOwnHorizontalAlignment in interface JRAlignmentpublic HorizontalAlignEnum getHorizontalAlignmentValue()
JRAlignmentgetHorizontalAlignmentValue in interface JRAlignmentHorizontalAlignEnumpublic HorizontalAlignEnum getOwnHorizontalAlignmentValue()
getOwnHorizontalAlignmentValue in interface JRAlignmentpublic void setHorizontalAlignment(byte horizontalAlignment)
setHorizontalAlignment(HorizontalAlignEnum).setHorizontalAlignment in interface JRAlignmentpublic void setHorizontalAlignment(java.lang.Byte horizontalAlignment)
setHorizontalAlignment(HorizontalAlignEnum).setHorizontalAlignment in interface JRAlignmentpublic void setHorizontalAlignment(HorizontalAlignEnum horizontalAlignment)
JRAlignmentsetHorizontalAlignment in interface JRAlignmenthorizontalAlignment - a value representing one of the horizontal alignment constants in HorizontalAlignEnumpublic byte getVerticalAlignment()
getVerticalAlignmentValue().getVerticalAlignment in interface JRAlignmentpublic java.lang.Byte getOwnVerticalAlignment()
getOwnVerticalAlignmentValue().getOwnVerticalAlignment in interface JRAlignmentpublic VerticalAlignEnum getVerticalAlignmentValue()
JRAlignmentgetVerticalAlignmentValue in interface JRAlignmentVerticalAlignEnumpublic VerticalAlignEnum getOwnVerticalAlignmentValue()
getOwnVerticalAlignmentValue in interface JRAlignmentpublic void setVerticalAlignment(byte verticalAlignment)
setVerticalAlignment(VerticalAlignEnum).setVerticalAlignment in interface JRAlignmentpublic void setVerticalAlignment(java.lang.Byte verticalAlignment)
setVerticalAlignment(VerticalAlignEnum).setVerticalAlignment in interface JRAlignmentpublic void setVerticalAlignment(VerticalAlignEnum verticalAlignment)
JRAlignmentsetVerticalAlignment in interface JRAlignmentverticalAlignment - a value representing one of the vertical alignment constants in VerticalAlignEnumpublic byte getRotation()
getRotationValue().getRotation in interface JRCommonTextpublic java.lang.Byte getOwnRotation()
getOwnRotationValue().getOwnRotation in interface JRCommonTextgetOwnRotation in interface JRPrintTextpublic void setRotation(byte rotation)
setRotation(RotationEnum).setRotation in interface JRCommonTextsetRotation in interface JRPrintTextpublic void setRotation(java.lang.Byte rotation)
setRotation(RotationEnum).setRotation in interface JRCommonTextsetRotation in interface JRPrintTextpublic 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 byte getRunDirection()
getRunDirectionValue().getRunDirection in interface JRPrintTextpublic void setRunDirection(byte runDirection)
setRunDirection(RunDirectionEnum).setRunDirection in interface JRPrintTextpublic 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 byte getLineSpacing()
getLineSpacingValue().getLineSpacing in interface JRCommonTextpublic java.lang.Byte getOwnLineSpacing()
getOwnLineSpacingValue().getOwnLineSpacing in interface JRCommonTextgetOwnLineSpacing in interface JRPrintTextpublic void setLineSpacing(byte lineSpacing)
setLineSpacing(LineSpacingEnum).setLineSpacing in interface JRCommonTextsetLineSpacing in interface JRPrintTextpublic void setLineSpacing(java.lang.Byte lineSpacing)
setLineSpacing(LineSpacingEnum).setLineSpacing in interface JRCommonTextsetLineSpacing in interface JRPrintTextpublic LineSpacingEnum getLineSpacingValue()
JRCommonTextgetLineSpacingValue in interface JRCommonTextLineSpacingEnumpublic LineSpacingEnum getOwnLineSpacingValue()
JRCommonTextgetOwnLineSpacingValue in interface JRCommonTextgetOwnLineSpacingValue in interface JRPrintTextLineSpacingEnumpublic void setLineSpacing(LineSpacingEnum lineSpacing)
JRCommonTextsetLineSpacing in interface JRCommonTextsetLineSpacing in interface JRPrintTextlineSpacing - a value representing one of the line spacing constants in LineSpacingEnumpublic boolean isStyledText()
getMarkup()JRCommonTextisStyledText in interface JRCommonTextpublic java.lang.Boolean isOwnStyledText()
getOwnMarkup()isOwnStyledText in interface JRCommonTextpublic void setStyledText(boolean isStyledText)
setMarkup(String).setStyledText in interface JRPrintTextpublic void setStyledText(java.lang.Boolean isStyledText)
setMarkup(String).setStyledText in interface JRPrintTextpublic java.lang.String getMarkup()
JRCommonTextgetMarkup in interface JRCommonTextpublic java.lang.String getOwnMarkup()
getOwnMarkup in interface JRCommonTextgetOwnMarkup in interface JRPrintTextpublic void setMarkup(java.lang.String markup)
setMarkup in interface JRCommonTextsetMarkup in interface JRPrintTextpublic JRBox getBox()
getLineBox()getBox in interface JRPrintTextpublic JRLineBox getLineBox()
getLineBox in interface JRBoxContainerpublic void setBox(JRBox box)
getLineBox()setBox in interface JRPrintTextpublic JRFont getFont()
getFont in interface JRPrintTextpublic void setFont(JRFont font)
setFont in interface JRPrintTextpublic java.lang.String getAnchorName()
getAnchorName in interface JRPrintAnchorpublic void setAnchorName(java.lang.String anchorName)
setAnchorName in interface JRPrintAnchorpublic byte getHyperlinkType()
getHyperlinkTypeValue().getHyperlinkType in interface JRPrintHyperlinkpublic 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(byte hyperlinkType)
setHyperlinkType(HyperlinkTypeEnum).setHyperlinkType in interface JRPrintHyperlinkpublic void setHyperlinkType(HyperlinkTypeEnum hyperlinkType)
JRPrintHyperlinksetHyperlinkType in interface JRPrintHyperlinkhyperlinkType - the built-in hyperlink typeJRPrintHyperlink.getLinkType()public byte getHyperlinkTarget()
getHyperlinkTargetValue().getHyperlinkTarget in interface JRPrintHyperlinkpublic HyperlinkTargetEnum getHyperlinkTargetValue()
getHyperlinkTargetValue in interface JRPrintHyperlinkpublic void setHyperlinkTarget(byte hyperlinkTarget)
setHyperlinkTarget(HyperlinkTargetEnum).setHyperlinkTarget in interface JRPrintHyperlinkpublic void setHyperlinkTarget(HyperlinkTargetEnum hyperlinkTarget)
setHyperlinkTarget in interface JRPrintHyperlinkpublic java.lang.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(java.lang.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 java.lang.String getHyperlinkReference()
getHyperlinkReference in interface JRPrintHyperlinkpublic void setHyperlinkReference(java.lang.String hyperlinkReference)
setHyperlinkReference in interface JRPrintHyperlinkpublic java.lang.String getHyperlinkAnchor()
getHyperlinkAnchor in interface JRPrintHyperlinkpublic void setHyperlinkAnchor(java.lang.String hyperlinkAnchor)
setHyperlinkAnchor in interface JRPrintHyperlinkpublic java.lang.Integer getHyperlinkPage()
getHyperlinkPage in interface JRPrintHyperlinkpublic void setHyperlinkPage(java.lang.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 byte getBorder()
getBox()public java.lang.Byte getOwnBorder()
getBox()getOwnBorder in interface JRBoxpublic void setBorder(byte border)
getBox()public void setBorder(java.lang.Byte border)
getBox()public java.awt.Color getBorderColor()
getBox()getBorderColor in interface JRBoxpublic java.awt.Color getOwnBorderColor()
getBox()getOwnBorderColor in interface JRBoxpublic void setBorderColor(java.awt.Color borderColor)
getBox()setBorderColor in interface JRBoxpublic int getPadding()
getBox()getPadding in interface JRBoxpublic java.lang.Integer getOwnPadding()
getBox()getOwnPadding in interface JRBoxpublic void setPadding(int padding)
getBox()setPadding in interface JRBoxpublic void setPadding(java.lang.Integer padding)
getBox()setPadding in interface JRBoxpublic byte getTopBorder()
getBox()getTopBorder in interface JRBoxpublic java.lang.Byte getOwnTopBorder()
getBox()getOwnTopBorder in interface JRBoxpublic void setTopBorder(byte topBorder)
getBox()setTopBorder in interface JRBoxpublic void setTopBorder(java.lang.Byte topBorder)
getBox()setTopBorder in interface JRBoxpublic java.awt.Color getTopBorderColor()
getBox()getTopBorderColor in interface JRBoxpublic java.awt.Color getOwnTopBorderColor()
getBox()getOwnTopBorderColor in interface JRBoxpublic void setTopBorderColor(java.awt.Color topBorderColor)
getBox()setTopBorderColor in interface JRBoxpublic int getTopPadding()
getBox()getTopPadding in interface JRBoxpublic java.lang.Integer getOwnTopPadding()
getBox()getOwnTopPadding in interface JRBoxpublic void setTopPadding(int topPadding)
getBox()setTopPadding in interface JRBoxpublic void setTopPadding(java.lang.Integer topPadding)
getBox()setTopPadding in interface JRBoxpublic byte getLeftBorder()
getBox()getLeftBorder in interface JRBoxpublic java.lang.Byte getOwnLeftBorder()
getBox()getOwnLeftBorder in interface JRBoxpublic void setLeftBorder(byte leftBorder)
getBox()setLeftBorder in interface JRBoxpublic void setLeftBorder(java.lang.Byte leftBorder)
getBox()setLeftBorder in interface JRBoxpublic java.awt.Color getLeftBorderColor()
getBox()getLeftBorderColor in interface JRBoxpublic java.awt.Color getOwnLeftBorderColor()
getBox()getOwnLeftBorderColor in interface JRBoxpublic void setLeftBorderColor(java.awt.Color leftBorderColor)
getBox()setLeftBorderColor in interface JRBoxpublic int getLeftPadding()
getBox()getLeftPadding in interface JRBoxpublic java.lang.Integer getOwnLeftPadding()
getBox()getOwnLeftPadding in interface JRBoxpublic void setLeftPadding(int leftPadding)
getBox()setLeftPadding in interface JRBoxpublic void setLeftPadding(java.lang.Integer leftPadding)
getBox()setLeftPadding in interface JRBoxpublic byte getBottomBorder()
getBox()getBottomBorder in interface JRBoxpublic java.lang.Byte getOwnBottomBorder()
getBox()getOwnBottomBorder in interface JRBoxpublic void setBottomBorder(byte bottomBorder)
getBox()setBottomBorder in interface JRBoxpublic void setBottomBorder(java.lang.Byte bottomBorder)
getBox()setBottomBorder in interface JRBoxpublic java.awt.Color getBottomBorderColor()
getBox()getBottomBorderColor in interface JRBoxpublic java.awt.Color getOwnBottomBorderColor()
getBox()getOwnBottomBorderColor in interface JRBoxpublic void setBottomBorderColor(java.awt.Color bottomBorderColor)
getBox()setBottomBorderColor in interface JRBoxpublic int getBottomPadding()
getBox()getBottomPadding in interface JRBoxpublic java.lang.Integer getOwnBottomPadding()
getBox()getOwnBottomPadding in interface JRBoxpublic void setBottomPadding(int bottomPadding)
getBox()setBottomPadding in interface JRBoxpublic void setBottomPadding(java.lang.Integer bottomPadding)
getBox()setBottomPadding in interface JRBoxpublic byte getRightBorder()
getBox()getRightBorder in interface JRBoxpublic java.lang.Byte getOwnRightBorder()
getBox()getOwnRightBorder in interface JRBoxpublic void setRightBorder(byte rightBorder)
getBox()setRightBorder in interface JRBoxpublic void setRightBorder(java.lang.Byte rightBorder)
getBox()setRightBorder in interface JRBoxpublic java.awt.Color getRightBorderColor()
getBox()getRightBorderColor in interface JRBoxpublic java.awt.Color getOwnRightBorderColor()
getBox()getOwnRightBorderColor in interface JRBoxpublic void setRightBorderColor(java.awt.Color rightBorderColor)
getBox()setRightBorderColor in interface JRBoxpublic int getRightPadding()
getBox()getRightPadding in interface JRBoxpublic java.lang.Integer getOwnRightPadding()
getBox()getOwnRightPadding in interface JRBoxpublic void setRightPadding(int rightPadding)
getBox()setRightPadding in interface JRBoxpublic void setRightPadding(java.lang.Integer rightPadding)
getBox()setRightPadding in interface JRBoxpublic JRReportFont getReportFont()
getReportFont in interface JRFontpublic void setReportFont(JRReportFont reportFont)
setReportFont in interface JRFontpublic java.lang.String getFontName()
getFontName in interface JRFontpublic java.lang.String getOwnFontName()
getOwnFontName in interface JRFontpublic void setFontName(java.lang.String fontName)
setFontName in interface JRFontpublic void setBold(java.lang.Boolean isBold)
public java.lang.Boolean isOwnItalic()
isOwnItalic in interface JRFontpublic void setItalic(java.lang.Boolean isItalic)
public boolean isUnderline()
isUnderline in interface JRFontpublic java.lang.Boolean isOwnUnderline()
isOwnUnderline in interface JRFontpublic void setUnderline(boolean isUnderline)
setUnderline in interface JRFontpublic void setUnderline(java.lang.Boolean isUnderline)
setUnderline in interface JRFontpublic boolean isStrikeThrough()
isStrikeThrough in interface JRFontpublic java.lang.Boolean isOwnStrikeThrough()
isOwnStrikeThrough in interface JRFontpublic void setStrikeThrough(boolean isStrikeThrough)
setStrikeThrough in interface JRFontpublic void setStrikeThrough(java.lang.Boolean isStrikeThrough)
setStrikeThrough in interface JRFontpublic int getFontSize()
getFontSize in interface JRCommonTextgetFontSize in interface JRFontpublic java.lang.Integer getOwnFontSize()
getOwnFontSize in interface JRFontpublic void setFontSize(int fontSize)
setFontSize in interface JRFontpublic void setFontSize(java.lang.Integer fontSize)
setFontSize in interface JRFontpublic int getSize()
getFontSize().public java.lang.Integer getOwnSize()
getOwnFontSize().getOwnSize in interface JRFontpublic void setSize(int size)
setFontSize(int).public void setSize(java.lang.Integer size)
setFontSize(Integer).public java.lang.String getPdfFontName()
getPdfFontName in interface JRFontpublic java.lang.String getOwnPdfFontName()
getOwnPdfFontName in interface JRFontpublic void setPdfFontName(java.lang.String pdfFontName)
setPdfFontName in interface JRFontpublic java.lang.String getPdfEncoding()
getPdfEncoding in interface JRFontpublic java.lang.String getOwnPdfEncoding()
getOwnPdfEncoding in interface JRFontpublic void setPdfEncoding(java.lang.String pdfEncoding)
setPdfEncoding in interface JRFontpublic boolean isPdfEmbedded()
isPdfEmbedded in interface JRFontpublic java.lang.Boolean isOwnPdfEmbedded()
isOwnPdfEmbedded in interface JRFontpublic void setPdfEmbedded(boolean isPdfEmbedded)
setPdfEmbedded in interface JRFontpublic void setPdfEmbedded(java.lang.Boolean isPdfEmbedded)
setPdfEmbedded in interface JRFontpublic java.lang.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 JRPrintTextpublic java.lang.String getPattern()
JRPrintTextThe pattern can be used to parse the text back to its source value.
getPattern in interface JRPrintTextJRPrintText.getValueClassName()public java.lang.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 JRPrintTextpublic java.lang.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 JRPrintTextjava.util.Locale used when formatting this text's source valuepublic java.lang.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 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 java.lang.String getLinkType()
JRPrintHyperlinkgetLinkType in interface JRPrintHyperlinkpublic void setLinkType(java.lang.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 java.lang.String getHyperlinkTooltip()
JRPrintHyperlinkgetHyperlinkTooltip in interface JRPrintHyperlinkpublic void setHyperlinkTooltip(java.lang.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 operation© 2001-2010 Jaspersoft Corporation www.jaspersoft.com