|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface JRPrintText
Field Summary | |
---|---|
static short[] |
ZERO_LINE_BREAK_OFFSETS
Zero-length line break offset array used for getLineBreakOffsets()
when the text does not have any line breaks. |
Fields inherited from interface net.sf.jasperreports.engine.JRPrintElement |
---|
UNSET_SOURCE_ELEMENT_ID |
Fields inherited from interface net.sf.jasperreports.engine.JRFont |
---|
DEFAULT_FONT_NAME, DEFAULT_FONT_SIZE, DEFAULT_PDF_EMBEDDED, DEFAULT_PDF_ENCODING, DEFAULT_PDF_FONT_NAME |
Fields inherited from interface net.sf.jasperreports.engine.JRCommonText |
---|
MARKUP_HTML, MARKUP_NONE, MARKUP_RTF, MARKUP_STYLED_TEXT |
Method Summary | |
---|---|
JRFont |
getFont()
Deprecated. |
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. |
float |
getLeadingOffset()
|
short[] |
getLineBreakOffsets()
Returns the line break offsets for the text if saved during report fill. |
float |
getLineSpacingFactor()
|
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 |
getOriginalText()
Returns the original text that was set in this object. |
LineSpacingEnum |
getOwnLineSpacingValue()
Deprecated. Replaced by JRParagraph.getOwnLineSpacing() . |
java.lang.String |
getOwnMarkup()
|
RotationEnum |
getOwnRotationValue()
Gets the text own rotation. |
java.lang.String |
getPattern()
Returns the pattern used to format a value that was the source of this text. |
RunDirectionEnum |
getRunDirectionValue()
Gets the text run direction. |
JRStyledText |
getStyledText(JRStyledTextAttributeSelector attributeSelector)
Returns the styled text for this object. |
java.lang.String |
getText()
Returns the possibly truncated (when getTextTruncateIndex() is not null) text of this object. |
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 getText() . |
java.lang.String |
getTimeZoneId()
Returns the ID of the java.util.TimeZone
used to format this text's date source value. |
java.lang.Object |
getValue()
|
java.lang.String |
getValueClassName()
Returns the type of the value which was used to generate this text. |
void |
setFont(JRFont font)
Deprecated. |
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 |
setMarkup(java.lang.String markup)
|
void |
setRotation(RotationEnum rotationEnum)
Sets the text rotation. |
void |
setRunDirection(RunDirectionEnum runDirectionEnum)
Sets the text run direction. |
void |
setText(java.lang.String text)
Set the text for this object. |
void |
setTextFormat(TextFormat textFormat)
|
void |
setTextHeight(float textHeight)
|
void |
setTextTruncateIndex(java.lang.Integer index)
Sets the index to which this object's text is to be truncated. |
void |
setTextTruncateSuffix(java.lang.String suffix)
Sets the suffix to be appended to the truncated text. |
void |
setValue(java.lang.Object value)
|
Methods inherited from interface net.sf.jasperreports.engine.JRPrintElement |
---|
accept, getHeight, getKey, getOrigin, getSourceElementId, getWidth, getX, getY, setHeight, setStyle, setWidth, setX, setY |
Methods inherited from interface net.sf.jasperreports.engine.JRPropertiesHolder |
---|
getParentProperties, getPropertiesMap, hasProperties |
Methods inherited from interface net.sf.jasperreports.engine.JRAlignment |
---|
getHorizontalAlignmentValue, getOwnHorizontalAlignmentValue, getOwnVerticalAlignmentValue, getVerticalAlignmentValue, setHorizontalAlignment, setVerticalAlignment |
Methods inherited from interface net.sf.jasperreports.engine.JRPrintAnchor |
---|
getAnchorName, getBookmarkLevel, setAnchorName, setBookmarkLevel |
Methods inherited from interface net.sf.jasperreports.engine.JRPrintHyperlink |
---|
getHyperlinkAnchor, getHyperlinkPage, getHyperlinkParameters, getHyperlinkReference, getHyperlinkTargetValue, getHyperlinkTooltip, getHyperlinkTypeValue, getLinkTarget, getLinkType, setHyperlinkAnchor, setHyperlinkPage, setHyperlinkParameters, setHyperlinkReference, setHyperlinkTarget, setHyperlinkTooltip, setHyperlinkType, setLinkTarget, setLinkType |
Methods inherited from interface net.sf.jasperreports.engine.JRFont |
---|
getFontName, getFontSize, getOwnFontName, getOwnFontSize, getOwnPdfEncoding, getOwnPdfFontName, getPdfEncoding, getPdfFontName, isBold, isItalic, isOwnBold, isOwnItalic, isOwnPdfEmbedded, isOwnStrikeThrough, isOwnUnderline, isPdfEmbedded, isStrikeThrough, isUnderline, setBold, setBold, setFontName, setFontSize, setFontSize, setItalic, setItalic, setPdfEmbedded, setPdfEmbedded, setPdfEncoding, setPdfFontName, setStrikeThrough, setStrikeThrough, setUnderline, setUnderline |
Methods inherited from interface net.sf.jasperreports.engine.JRCommonText |
---|
getFontSize, getLineSpacingValue, getMarkup, getRotationValue |
Methods inherited from interface net.sf.jasperreports.engine.JRCommonElement |
---|
getBackcolor, getForecolor, getModeValue, getOwnBackcolor, getOwnForecolor, getOwnModeValue, setBackcolor, setForecolor, setMode |
Methods inherited from interface net.sf.jasperreports.engine.JRIdentifiable |
---|
getUUID |
Methods inherited from interface net.sf.jasperreports.engine.JRBoxContainer |
---|
getDefaultLineColor, getLineBox |
Methods inherited from interface net.sf.jasperreports.engine.JRParagraphContainer |
---|
getParagraph |
Methods inherited from interface net.sf.jasperreports.engine.JRStyleContainer |
---|
getDefaultStyleProvider, getStyle, getStyleNameReference |
Field Detail |
---|
static final short[] ZERO_LINE_BREAK_OFFSETS
getLineBreakOffsets()
when the text does not have any line breaks.
Method Detail |
---|
java.lang.String getText()
getTextTruncateIndex()
is not null) text of this object.
getFullText()
,
getTextTruncateSuffix()
void setText(java.lang.String text)
text
- the textsetTextTruncateIndex(Integer)
java.lang.Object getValue()
void setValue(java.lang.Object value)
java.lang.Integer getTextTruncateIndex()
JRTextElement.PROPERTY_PRINT_KEEP_FULL_TEXT
,
getTextTruncateSuffix()
void setTextTruncateIndex(java.lang.Integer index)
getText()
or getStyledText(JRStyledTextAttributeSelector)
are called.
index
- the index to which this object's text is to be truncatedjava.lang.String getTextTruncateSuffix()
getText()
.
JRTextElement.PROPERTY_TRUNCATE_SUFFIX
void setTextTruncateSuffix(java.lang.String suffix)
suffix
- the suffix to be appended to the truncated textgetTextTruncateSuffix()
java.lang.String getFullText()
getText()
,
getTextTruncateIndex()
java.lang.String getOriginalText()
JRStyledText getStyledText(JRStyledTextAttributeSelector attributeSelector)
getText()
.
attributeSelector
- the styled text attribute selector
JRStyledText getFullStyledText(JRStyledTextAttributeSelector attributeSelector)
attributeSelector
- the styled text attribute selector
getFullText()
void setTextFormat(TextFormat textFormat)
float getLineSpacingFactor()
void setLineSpacingFactor(float lineSpacingFactor)
float getLeadingOffset()
void setLeadingOffset(float leadingOffset)
RotationEnum getOwnRotationValue()
getOwnRotationValue
in interface JRCommonText
RotationEnum
void setRotation(RotationEnum rotationEnum)
setRotation
in interface JRCommonText
rotationEnum
- a value representing one of the text rotation constants in RotationEnum
RunDirectionEnum getRunDirectionValue()
RunDirectionEnum
void setRunDirection(RunDirectionEnum runDirectionEnum)
runDirectionEnum
- a value representing one of the text run direction constants in RunDirectionEnum
float getTextHeight()
void setTextHeight(float textHeight)
LineSpacingEnum getOwnLineSpacingValue()
JRParagraph.getOwnLineSpacing()
.
getOwnLineSpacingValue
in interface JRCommonText
void setLineSpacing(LineSpacingEnum lineSpacing)
JRParagraph.setLineSpacing(LineSpacingEnum)
.
setLineSpacing
in interface JRCommonText
java.lang.String getOwnMarkup()
getOwnMarkup
in interface JRCommonText
void setMarkup(java.lang.String markup)
setMarkup
in interface JRCommonText
JRFont getFont()
void setFont(JRFont font)
java.lang.String getValueClassName()
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 TextFormat
java.lang.String getPattern()
The pattern can be used to parse the text back to its source value.
getPattern
in interface TextFormat
getValueClassName()
java.lang.String getFormatFactoryClass()
FormatFactory
interface to use with this text element, in case it is not the same as the one for the overall document.
getFormatFactoryClass
in interface TextFormat
java.lang.String getLocaleCode()
java.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 TextFormat
java.util.Locale
used when formatting this text's source valuejava.lang.String getTimeZoneId()
ID
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 TextFormat
ID
of the java.util.TimeZone
used to format this text's date source valueshort[] getLineBreakOffsets()
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
.
null
if no line break positions were saved during the fillJRTextElement.PROPERTY_SAVE_LINE_BREAKS
void setLineBreakOffsets(short[] lineBreakOffsets)
lineBreakOffsets
- the line break offsetsgetLineBreakOffsets()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |