Serialized Form

  • Package com.scroogexhtml

  • Package com.scroogexhtml.configuration

    • Class com.scroogexhtml.configuration.CharPropConfiguration

      class CharPropConfiguration extends Object implements Serializable
      serialVersionUID:
      -6113238107694515352L

      • Serialized Fields

        • allowedFontSizeUnits
          Set<LengthUnit> allowedFontSizeUnits
          The `allowedFontSizeUnits` variable represents a set of length units that are allowed for font sizes.
        • convertFontBGColor
          boolean convertFontBGColor
          Set this property to convert text background colors.
        • convertFontColor
          boolean convertFontColor
          Set this property to convert text foreground colors.
        • convertFontHLColor
          boolean convertFontHLColor
          Set this property to convert text highlight colors.
        • convertFontName
          boolean convertFontName
          Set this property to convert font names.
        • convertFontSize
          boolean convertFontSize
          Set this property to convert font sizes.
        • convertFontStyle
          boolean convertFontStyle
          Set this property to convert font styles (bold, italic, underline...).
        • convertLanguage
          boolean convertLanguage
          Set this property to enable language attribute.
        • fontSizeUnit
          LengthUnit fontSizeUnit
          the font size length unit.

    • Class com.scroogexhtml.configuration.HeaderFooterConfiguration

      class HeaderFooterConfiguration extends Object implements Serializable
      serialVersionUID:
      -3147034415125177906L

      • Serialized Fields

        • convertHeaderAndFooter
          boolean convertHeaderAndFooter
          Specifies whether the converter should convert RTF headers and footers.

    • Class com.scroogexhtml.configuration.HtmlHeadConfiguration

      class HtmlHeadConfiguration extends Object implements Serializable
      serialVersionUID:
      -3740719564592358594L

      • Serialized Fields

        • documentTitle
          String documentTitle
          the document title.
        • includeDefaultFontStyle
          boolean includeDefaultFontStyle
          include a CSS definition for the default font style.
        • metaAuthor
          String metaAuthor
          use this property to define the Meta tag for the author name.
        • metaDescription
          String metaDescription
          use this property to define the Meta tag for the description.
        • metaGenerator
          String metaGenerator
          use this property to define the Meta generator tag.
        • metaKeywords
          String metaKeywords
          use this property to define the Meta tag for keywords.
        • metaViewport
          String metaViewport
          use this property to define the "meta viewport" tag.
        • styleSheetInclude
          String styleSheetInclude
          Embedded style sheet.
        • styleSheetLinks
          List<String> styleSheetLinks
          use this property to link to one or more external style sheets.

    • Class com.scroogexhtml.configuration.ListConversionConfiguration

      class ListConversionConfiguration extends Object implements Serializable
      serialVersionUID:
      5697473120538625028L

      • Serialized Fields

        • supportListTable
          boolean supportListTable
          Specifies whether the converter should process the listtable.
          Default value:
          true
        • supportStarPn
          boolean supportStarPn
          Specifies whether the converter should convert \*\pn groups.

          It is the responsibility of RTF readers that understand the \*\pn destination to ignore the \pntext group.

    • Class com.scroogexhtml.configuration.ParaPropConfiguration

      class ParaPropConfiguration extends Object implements Serializable
      serialVersionUID:
      -6113238107694515353L

      • Serialized Fields

        • convertAlignment
          boolean convertAlignment
          Set this property to convert paragraph alignment.
        • convertIndent
          boolean convertIndent
          Set this property to true if you want to activate support for left and right paragraph indent.
        • convertParagraphBorders
          boolean convertParagraphBorders
          Set this property to enable conversion of paragraph borders.
        • convertParagraphMargins
          boolean convertParagraphMargins
          Set this property to enable conversion of paragraph margins.

    • Class com.scroogexhtml.configuration.TablePropConfiguration

      class TablePropConfiguration extends Object implements Serializable
      serialVersionUID:
      -7147890848609669774L

      • Serialized Fields

        • convertCellStyles
          boolean convertCellStyles
          Flag indicating conversion of table cell styles.
        • convertNestedTables
          boolean convertNestedTables
          Flag indicating conversion of nested tables.
        • maxTableWidthPercent
          int maxTableWidthPercent
          The maximum table width in percent.
        • tableWidthUnit
          LengthUnit tableWidthUnit
          The length unit used for table and column widths.

  • Package com.scroogexhtml.converter

    • Exception Class com.scroogexhtml.converter.ConversionException

      class ConversionException extends RuntimeException implements Serializable
      serialVersionUID:
      -1L

    • Class com.scroogexhtml.converter.ScroogeXHTMLBase

      class ScroogeXHTMLBase extends Object implements Serializable
      serialVersionUID:
      -6113238107694515351L

      • Serialized Fields

        • addOuterHTML
          boolean addOuterHTML
          true = include HTML header.
        • charPropConvConfig
          CharPropConfiguration charPropConvConfig
          Nested property which contains character conversion properties.
        • convertBookmarks
          boolean convertBookmarks
          Set this property to convert bookmarks.
        • convertEmptyParagraphs
          boolean convertEmptyParagraphs
          true = convert empty paragraphs to br (line break).
        • convertFootnotes
          boolean convertFootnotes
          Set this property to convert footnotes.
        • convertHyperlinks
          boolean convertHyperlinks
          Set this property to enable hyperlink conversion.
        • convertPictures
          boolean convertPictures
          Set this property to enable picture conversion.
        • convertTables
          boolean convertTables
          Set this property to enable table conversion.
        • curFontCSet
          int curFontCSet
          the current font character set.
        • curFontFamily
          FontFamily curFontFamily
          the current font type.
        • curFontName
          StringBuilder curFontName
          the current font name.
        • curFontNr
          int curFontNr
          the current font number.
        • defaultFontColor
          String defaultFontColor
          font color optimizer.
        • defaultFontName
          String defaultFontName
          font name optimizer.
        • defaultFontNr
          int defaultFontNr
          the default Font number.
        • defaultFontSize
          int defaultFontSize
          font size optimizer.
        • defaultLanguage
          String defaultLanguage
          default text language.
        • documentType
          DocumentType documentType
          document type.
        • fontReplacing
          FontReplacing fontReplacing
          the font replacer.
        • headerFooterConfiguration
          HeaderFooterConfiguration headerFooterConfiguration
          Holds the configuration for header and footer processing.
        • htmlHeadConfig
          HtmlHeadConfiguration htmlHeadConfig
          Holds the configuration for the HTML HEAD section properties.
        • indentAmount
          int indentAmount
          Indent amount.
        • invalidRtfHeaderAction
          InvalidRtfHeaderAction invalidRtfHeaderAction
          The action to take when encountering an invalid RTF header.

          The value of this variable represents the action to be taken when an invalid RTF header is encountered. The default action is to log a warning message.

          Possible values are: - InvalidRtfHeaderAction.LOG_WARNING: Logs a warning message when encountering an invalid RTF header. - InvalidRtfHeaderAction.LOG_ERROR: Logs an error message when encountering an invalid RTF header. - InvalidRtfHeaderAction.THROW_EXCEPTION: Throws an exception when encountering an invalid RTF header.

          Usage: invalidRtfHeaderAction can be used to configure the action to be taken when an invalid RTF header is encountered.

          See Also:
        • listConversionConfig
          ListConversionConfiguration listConversionConfig
          Holds the configuration for list table processing.
        • paraPropConvConfig
          ParaPropConfiguration paraPropConvConfig
          Nested property which contains paragraph conversion properties.
        • pictureAdapter
          PictureAdapter pictureAdapter
          picture adapter.
        • postProcessListeners
          List<PostProcessListener> postProcessListeners
          the post-processing listeners.
        • tablePropConfiguration
          TablePropConfiguration tablePropConfiguration
          Holds the configuration for the table properties.
        • tabString
          String tabString
          Tabulator replacement string.

    • Class com.scroogexhtml.converter.ScroogeXHTMLMain

      class ScroogeXHTMLMain extends ScroogeXHTMLBase implements Serializable
      serialVersionUID:
      4958279723474988581L

      • Serialized Fields

        • colorTable
          ColorTable colorTable
          the color table
        • currUniSkip
          int currUniSkip
          Skip counter.
        • nextChar
          int nextChar
          the next RTF input character.
        • pictHex
          char[] pictHex
          picture hex data
        • pictNibble
          int pictNibble
          decode picture date (2 hex characters to 1 byte)
        • skipPicture
          boolean skipPicture
          if true, skip the current picture
        • skipUnknownDest
          boolean skipUnknownDest
          true = skip the group destination.
        • unicodeSkip
          int unicodeSkip
          no. of characters to skip.

  • Package com.scroogexhtml.events

  • Package com.scroogexhtml.fonts

  • Package com.scroogexhtml.pictures

    • Class com.scroogexhtml.pictures.EmbeddedPicture

      class EmbeddedPicture extends Object implements Serializable
      serialVersionUID:
      222642688906940579L

      • Serialized Fields

        • hGoalTwips
          long hGoalTwips
        • imgAltAttribute
          String imgAltAttribute
        • mappingMode
          int mappingMode
        • originalHeight
          long originalHeight
        • originalWidth
          long originalWidth
        • pictureFormat
          PictureFormat pictureFormat
        • pictureUrl
          String pictureUrl
        • scaleX
          long scaleX
        • scaleY
          long scaleY
        • visible
          boolean visible
        • wGoalTwips
          long wGoalTwips

  • Package com.scroogexhtml.rtf

    • Class com.scroogexhtml.rtf.ColorTable

      class ColorTable extends Object implements Serializable
      serialVersionUID:
      8648438136362230736L

      • Serialized Fields

        • blue
          int blue
        • colors
          List<String> colors
          list of colors which represents the color table
        • green
          int green
        • hasColorTableEntry
          boolean hasColorTableEntry
        • red
          int red