Class CharPropConfiguration

java.lang.Object
com.scroogexhtml.configuration.CharPropConfiguration
All Implemented Interfaces:
Serializable

public class CharPropConfiguration extends Object implements Serializable
Nested property which contains character conversion properties.
See Also:
  • Constructor Details

    • CharPropConfiguration

      public CharPropConfiguration()
  • Method Details

    • setFontSizeUnit

      public void setFontSizeUnit(LengthUnit newValue)
      Sets the font size unit to the specified value.
      Parameters:
      newValue - the new font size unit
      Throws:
      ConversionException - if the specified unit is not allowed
    • setConvertFontBGColor

      public void setConvertFontBGColor(boolean newValue)
      Set ConvertFontBGColor to true to enable conversion of text background colors.

      Code Example:

       // switch off background color conversion
       scrooge.setConvertBGColor(false);
       
      Note: in RTF documents, background colors may also be defined as 'highlight colors'. If the background colors do not appear in the output document, try setting the ConvertFontHLColor property.
      Parameters:
      newValue - The new convertFontBGColor value
      See Also:
      Default value:
      true
    • setConvertFontColor

      public void setConvertFontColor(boolean newValue)
      Set this property to true to enable conversion of font colors.
      Parameters:
      newValue - The new convertFontColor value
      See Also:
      Default value:
      true
    • setConvertFontHLColor

      public void setConvertFontHLColor(boolean newValue)
      Set ConvertFontHLColor to true to enable conversion of text highlight colors.

      Code Example:

       // switch off highlight color conversion
       scrooge.setConvertHLColor(false);
       
      Note: in RTF documents, highlight colors may also be defined as 'background colors'. If the highlight colors do not appear in the output document, try setting the ConvertFontBGColor property.
      Parameters:
      newValue - The new convertFontHLColor value
      See Also:
      Default value:
      true
    • setConvertFontName

      public void setConvertFontName(boolean newValue)
      Set this property to true to enable conversion of font names.
      Parameters:
      newValue - The new convertFontName value
      See Also:
      Default value:
      true
    • setConvertFontSize

      public void setConvertFontSize(boolean newValue)
      Set this property to true to enable conversion of font sizes.
      Parameters:
      newValue - The new convertFontSize value
      See Also:
      Default value:
      true
    • setConvertFontStyle

      public void setConvertFontStyle(boolean newValue)
      Set this property to true to enable conversion of font styles (bold, italic, strike, underline, subscript, superscript).
      Parameters:
      newValue - The new convertFontStyle value
      See Also:
      Default value:
      true
    • setConvertLanguage

      public void setConvertLanguage(boolean newValue)
      Set this property to true to enable generation of lang attributes.
      Parameters:
      newValue - The new convertLanguage value
      See Also:
      Default value:
      false
    • getFontSizeUnit

      public LengthUnit getFontSizeUnit()
    • isConvertFontBGColor

      public boolean isConvertFontBGColor()
    • isConvertFontColor

      public boolean isConvertFontColor()
    • isConvertFontHLColor

      public boolean isConvertFontHLColor()
    • isConvertFontName

      public boolean isConvertFontName()
    • isConvertFontSize

      public boolean isConvertFontSize()
    • isConvertFontStyle

      public boolean isConvertFontStyle()
    • isConvertLanguage

      public boolean isConvertLanguage()