Package net.webpdf.wsclient.schema.operation

Class TextHighlightType

  • public class TextHighlightType
extends Object
     <?xml version="1.0" encoding="UTF-8"?><p xmlns:p117921_="https://jakarta.ee/xml/ns/jaxb" xmlns:p71612_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">This element is used to configure the display of contents for which the syntax highlighter was unable to identify a known language.</p>

    Java class for TextHighlightType complex type

    .

    The following schema fragment specifies the expected content contained within this class.

    
 <complexType name="TextHighlightType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <attribute name="fontSize" type="{http://www.w3.org/2001/XMLSchema}string" default="10px" />
       <attribute name="fontOrigin" type="{http://schema.webpdf.de/1.0/operation}FontOriginModeType" default="system" />
       <attribute name="fontFamily" type="{http://www.w3.org/2001/XMLSchema}string" default="" />
       <attribute name="wordBreak" type="{http://schema.webpdf.de/1.0/operation}TextWrapModeType" default="auto" />
       <attribute name="lineNumbers" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="lineHeight" type="{http://www.w3.org/2001/XMLSchema}string" default="12px" />
       <attribute name="color" type="{http://www.w3.org/2001/XMLSchema}string" default="#000000" />
     </restriction>
   </complexContent>
 </complexType>

    • Field Detail

      • fontSize

        protected String fontSize
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p117921_="https://jakarta.ee/xml/ns/jaxb" xmlns:p71612_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Used to set the font size for the text to the specified value.
                         You can use any of the following units:
                         <ul><li>px = Pixels</li><li>cm = Centimeters</li><li>mm = Millimeters</li><li>in = Inches</li><li>pt = Points</li><li>pc = Pica</li></ul></p>

      • fontOrigin

        protected FontOriginModeType fontOrigin
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p117921_="https://jakarta.ee/xml/ns/jaxb" xmlns:p71612_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">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:
                         <ul><li>system = It will be possible to select from the fonts available system-wide.</li><li>folder =It will be possible to select from the fonts in "templates/fonts".</li></ul></p>

      • fontFamily

        protected String fontFamily
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p117921_="https://jakarta.ee/xml/ns/jaxb" xmlns:p71612_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">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.</p>

      • wordBreak

        protected TextWrapModeType wordBreak
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p117921_="https://jakarta.ee/xml/ns/jaxb" xmlns:p71612_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Can be used to configure the word wrap behaviour during highlighting
                         Possible values:
                         <ul><li>auto = Automatic word wrap if necessary.</li><li>none = Suppress the addition of extra line breaks.</li><li>word = Line breaks allowed only after words.</li><li>all = Line breaks allowed unconditionally.</li></ul></p>

      • lineNumbers

        protected Boolean lineNumbers
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p117921_="https://jakarta.ee/xml/ns/jaxb" xmlns:p71612_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">If this value is set to "true", line numbers are added before the code.</p>

      • lineHeight

        protected String lineHeight
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p117921_="https://jakarta.ee/xml/ns/jaxb" xmlns:p71612_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Used to set the line height. You can use any of the following units:
                         <ul><li>px = Pixels</li><li>cm = Centimeters</li><li>mm = Millimeters</li><li>in = Inches</li><li>pt = Points</li><li>pc = Pica</li></ul></p>

      • color

        protected String color
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p117921_="https://jakarta.ee/xml/ns/jaxb" xmlns:p71612_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">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.</p>

    • Constructor Detail

      • TextHighlightType

        public TextHighlightType()

    • Method Detail

      • getFontSize

        public String getFontSize()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p117921_="https://jakarta.ee/xml/ns/jaxb" xmlns:p71612_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Used to set the font size for the text to the specified value.
                         You can use any of the following units:
                         <ul><li>px = Pixels</li><li>cm = Centimeters</li><li>mm = Millimeters</li><li>in = Inches</li><li>pt = Points</li><li>pc = Pica</li></ul></p>
        Returns:
        possible object is String

      • setFontSize

        public void setFontSize​(String value)
        Sets the value of the fontSize property.
        Parameters:
        value - allowed object is String
        See Also:
        getFontSize()

      • isSetFontSize

        public boolean isSetFontSize()

      • getFontOrigin

        public FontOriginModeType getFontOrigin()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p117921_="https://jakarta.ee/xml/ns/jaxb" xmlns:p71612_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">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:
                         <ul><li>system = It will be possible to select from the fonts available system-wide.</li><li>folder =It will be possible to select from the fonts in "templates/fonts".</li></ul></p>
        Returns:
        possible object is FontOriginModeType

      • isSetFontOrigin

        public boolean isSetFontOrigin()

      • getFontFamily

        public String getFontFamily()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p117921_="https://jakarta.ee/xml/ns/jaxb" xmlns:p71612_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">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.</p>
        Returns:
        possible object is String

      • setFontFamily

        public void setFontFamily​(String value)
        Sets the value of the fontFamily property.
        Parameters:
        value - allowed object is String
        See Also:
        getFontFamily()

      • isSetFontFamily

        public boolean isSetFontFamily()

      • getWordBreak

        public TextWrapModeType getWordBreak()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p117921_="https://jakarta.ee/xml/ns/jaxb" xmlns:p71612_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Can be used to configure the word wrap behaviour during highlighting
                         Possible values:
                         <ul><li>auto = Automatic word wrap if necessary.</li><li>none = Suppress the addition of extra line breaks.</li><li>word = Line breaks allowed only after words.</li><li>all = Line breaks allowed unconditionally.</li></ul></p>
        Returns:
        possible object is TextWrapModeType

      • isSetWordBreak

        public boolean isSetWordBreak()

      • isLineNumbers

        public boolean isLineNumbers()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p117921_="https://jakarta.ee/xml/ns/jaxb" xmlns:p71612_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">If this value is set to "true", line numbers are added before the code.</p>
        Returns:
        possible object is Boolean

      • setLineNumbers

        public void setLineNumbers​(boolean value)
        Sets the value of the lineNumbers property.
        Parameters:
        value - allowed object is Boolean
        See Also:
        isLineNumbers()

      • isSetLineNumbers

        public boolean isSetLineNumbers()

      • unsetLineNumbers

        public void unsetLineNumbers()

      • getLineHeight

        public String getLineHeight()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p117921_="https://jakarta.ee/xml/ns/jaxb" xmlns:p71612_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">Used to set the line height. You can use any of the following units:
                         <ul><li>px = Pixels</li><li>cm = Centimeters</li><li>mm = Millimeters</li><li>in = Inches</li><li>pt = Points</li><li>pc = Pica</li></ul></p>
        Returns:
        possible object is String

      • setLineHeight

        public void setLineHeight​(String value)
        Sets the value of the lineHeight property.
        Parameters:
        value - allowed object is String
        See Also:
        getLineHeight()

      • isSetLineHeight

        public boolean isSetLineHeight()

      • getColor

        public String getColor()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p117921_="https://jakarta.ee/xml/ns/jaxb" xmlns:p71612_="http://jaxb2-commons.dev.java.net/basic/inheritance" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">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.</p>
        Returns:
        possible object is String

      • setColor

        public void setColor​(String value)
        Sets the value of the color property.
        Parameters:
        value - allowed object is String
        See Also:
        getColor()

      • isSetColor

        public boolean isSetColor()