Class OperationTextHighlight


  • public class OperationTextHighlight
    extends Object
    This element is used to configure the display of contents for which the syntax highlighter was unable to identify a known language.
    • Constructor Detail

      • OperationTextHighlight

        public OperationTextHighlight()
    • Method Detail

      • getColor

        @Nullable
        public @Nullable String getColor()
        Sets the font color for the text to the given value. The colour needs to be specified as a hexadecimal RGB value with a number sign before it.
        Returns:
        color
      • setColor

        public void setColor​(String color)
      • getFontFamily

        @Nullable
        public @Nullable String getFontFamily()
        Specifies the font to use for the text. If you select \"folder\" for the \"fontOrigin\" parameter, the font here needs to be specified with the filename for the file. Otherwise, use the name of the font you want. If the value is left blank, the \"SourceHanSans\" font will be used automatically.
        Returns:
        fontFamily
      • setFontFamily

        public void setFontFamily​(String fontFamily)
      • getFontOrigin

        @Nullable
        public @Nullable OperationTextHighlight.FontOriginEnum getFontOrigin()
        Used to specify whether the selected font should be obtained from your operating system or from the \"templates/fonts\" folder (in your webPDF installation path). Possible values: * system = It will be possible to select from the fonts available system-wide. * folder =It will be possible to select from the fonts in \"templates/fonts\".
        Returns:
        fontOrigin
      • getFontSize

        @Nullable
        public @Nullable String getFontSize()
        Used to set the font size for the text to the specified value. You can use any of the following units: * px = Pixels * cm = Centimeters * mm = Millimeters * in = Inches * pt = Points * pc = Pica
        Returns:
        fontSize
      • setFontSize

        public void setFontSize​(String fontSize)
      • getLineHeight

        @Nullable
        public @Nullable String getLineHeight()
        Used to set the line height. You can use any of the following units: * px = Pixels * cm = Centimeters * mm = Millimeters * in = Inches * pt = Points * pc = Pica
        Returns:
        lineHeight
      • setLineHeight

        public void setLineHeight​(String lineHeight)
      • getLineNumbers

        @Nullable
        public @Nullable Boolean getLineNumbers()
        If this value is set to \"true\", line numbers are added before the code.
        Returns:
        lineNumbers
      • setLineNumbers

        public void setLineNumbers​(Boolean lineNumbers)
      • getWordBreak

        @Nullable
        public @Nullable OperationTextHighlight.WordBreakEnum getWordBreak()
        Can be used to configure the word wrap behaviour during highlighting Possible values: * auto = Automatic word wrap if necessary. * none = Suppress the addition of extra line breaks. * word = Line breaks allowed only after words. * all = Line breaks allowed unconditionally.
        Returns:
        wordBreak
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object