Package net.sf.jasperreports.engine

Interface JRPrintText

All Superinterfaces:
JRBoxContainer, JRCommonElement, JRCommonText, JRFont, JRIdentifiable, JRParagraphContainer, JRPrintAnchor, JRPrintElement, JRPrintHyperlink, JRPropertiesHolder, JRStyleContainer, JRTextAlignment, TextFormat
All Known Implementing Classes:
JRBasePrintText, JRRecordedValuesPrintText, JRTemplatePrintText
public interface JRPrintText extends JRPrintElement, JRTextAlignment, JRPrintAnchor, JRPrintHyperlink, JRFont, JRCommonText, TextFormat
Author:
Teodor Danciu (teodord@users.sourceforge.net)

  • Field Details

    • PROPERTY_AWT_INDENT_FIRST_LINE

      static final String PROPERTY_AWT_INDENT_FIRST_LINE
      Specifies if the first line in a paragraph should be indented.
      See Also:

    • PROPERTY_AWT_JUSTIFY_LAST_LINE

      static final String PROPERTY_AWT_JUSTIFY_LAST_LINE
      Specifies if the last line in a paragraph should be justified.
      See Also:

    • ZERO_LINE_BREAK_OFFSETS

      static final short[] ZERO_LINE_BREAK_OFFSETS
      Zero-length line break offset array used for getLineBreakOffsets() when the text does not have any line breaks.

  • Method Details

    • setText

      void setText(String text)
      Set the text for this object.
      Parameters:
      text - the text
      See Also:

    • getValue

      Object getValue()

    • setValue

      void setValue(Object value)

    • getTextTruncateIndex

      Integer getTextTruncateIndex()
      Returns the index to which this object's text is to be truncated. This index is usually set at report fill time when the engine is instructed to keep the full text in the print text object.
      Returns:
      the index to which this object's text is to be truncated
      See Also:

    • setTextTruncateIndex

      void setTextTruncateIndex(Integer index)
      Sets the index to which this object's text is to be truncated. The text is truncated when JRStyledTextUtil.getTruncatedText(JRPrintText) or getFullStyledText(JRStyledTextAttributeSelector) are called.
      Parameters:
      index - the index to which this object's text is to be truncated

    • getTextTruncateSuffix

      String getTextTruncateSuffix()
      Returns the suffix that is to be appended to the truncated text (as returned by JRStyledTextUtil.getTruncatedText(JRPrintText).
      Returns:
      the truncated text suffix
      See Also:

    • setTextTruncateSuffix

      void setTextTruncateSuffix(String suffix)
      Sets the suffix to be appended to the truncated text.
      Parameters:
      suffix - the suffix to be appended to the truncated text
      See Also:

    • getFullText

      String getFullText()
      Returns the full (not truncated) text of this object.
      Returns:
      the full text of this object
      See Also:

    • getOriginalText

      String getOriginalText()
      Returns the original text that was set in this object.
      Returns:
      the original text

    • getFullStyledText

      JRStyledText getFullStyledText(JRStyledTextAttributeSelector attributeSelector)
      Returns the full styled text of this object.
      Parameters:
      attributeSelector - the styled text attribute selector
      Returns:
      the full styled text of this object
      See Also:

    • setTextFormat

      void setTextFormat(TextFormat textFormat)

    • getLineSpacingFactor

      float getLineSpacingFactor()

    • setLineSpacingFactor

      void setLineSpacingFactor(float lineSpacingFactor)

    • getLeadingOffset

      float getLeadingOffset()

    • setLeadingOffset

      void setLeadingOffset(float leadingOffset)

    • getRunDirection

      RunDirectionEnum getRunDirection()
      Gets the text run direction.
      Returns:
      a value representing one of the run direction constants in RunDirectionEnum

    • setRunDirection

      void setRunDirection(RunDirectionEnum runDirectionEnum)
      Sets the text run direction.
      Parameters:
      runDirectionEnum - a value representing one of the text run direction constants in RunDirectionEnum

    • getAverageCharWidth

      Float getAverageCharWidth()

    • setAverageCharWidth

      void setAverageCharWidth(Float averageCharWidth)

    • getTextHeight

      float getTextHeight()

    • setTextHeight

      void setTextHeight(float textHeight)

    • getValueClassName

      String getValueClassName()
      Returns the type of the value which was used to generate this text.

      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.

      Specified by:
      getValueClassName in interface TextFormat
      Returns:
      the type of the original value used to generate the text

    • getPattern

      String getPattern()
      Returns the pattern used to format a value that was the source of this text.

      The pattern can be used to parse the text back to its source value.

      Specified by:
      getPattern in interface TextFormat
      Returns:
      the pattern used to format this text's source value
      See Also:

    • getFormatFactoryClass

      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.
      Specified by:
      getFormatFactoryClass in interface TextFormat

    • getLocaleCode

      String getLocaleCode()
      Returns the code of the 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.

      Specified by:
      getLocaleCode in interface TextFormat
      Returns:
      the code of the java.util.Locale used when formatting this text's source value

    • getTimeZoneId

      String getTimeZoneId()
      Returns the 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.

      Specified by:
      getTimeZoneId in interface TextFormat
      Returns:
      the ID of the java.util.TimeZone used to format this text's date source value

    • getLineBreakOffsets

      short[] getLineBreakOffsets()
      Returns the line break offsets for the text if saved during report fill.

      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.

      Returns:
      the line break offsets (possibly zero-length array), or null if no line break positions were saved during the fill
      See Also:

    • setLineBreakOffsets

      void setLineBreakOffsets(short[] lineBreakOffsets)
      Sets the line break offsets for the text.
      Parameters:
      lineBreakOffsets - the line break offsets
      See Also: