Package net.webpdf.wsclient.openapi

Class OperationSyntaxHighlight

  • public class OperationSyntaxHighlight
extends Object
    This element is used to configure language detection and the representation of syntax elements in recognized programming/script languages.

    • Constructor Detail

      • OperationSyntaxHighlight

        public OperationSyntaxHighlight()

    • Method Detail

      • getAvailable

        @Nullable
public @Nullable String getAvailable()
        Can be used to specify the languages to which the syntax highlighted should be limited. You can enter multiple languages by separating them with a comma (\"java,cpp\"). If you do not specify a value, all the languages listed below will be recognized. You can select any of the following languages: * abnf = Augmented Backus-Naur form * accesslog = Apache/Nginx Access Logs * actionscript = ActionScript * ada = Ada * angelscript = AngelScript * apache = Apache configuration language * applescript = AppleScript * arcade = ArcGIS Arcade * arduino = Arduino * armasm = ARM Assembly * asciidoc = AsciiDoc * aspectj = AspectJ * autohotkey = AutoHotkey * autoit = AutoIt * avrasm = AVR Assembler * awk = Awk * axapta = Axapta * bash = Bash * basic = Basic * bnf = Backus-Naur Form * brainfuck = Brainfuck * cal = C/AL * capnproto = Cap'n Proto * ceylon = Ceylon * clean = Clean * clojure-repl = Clojure REPL * clojure = Clojure * cmake = CMake * coffeescript = CoffeeScript * coq = Coq * cos = Caché Object Script * cpp = C++ * crmsh = crmsh * crystal = Crystal * cs = C# * csp = CSP * css = CSS * d = D * dart = Dart * delphi = Delphi * diff = Diff * django = Django * dns = DNS Zone file * dockerfile = Dockerfile * dos = DOS .bat * dsconfig = dsconfig * dts = Device Tree * dust = Dust * ebnf = Extended Backus-Naur Form * elixir = Elixir * elm = Elm * erb = Embedded Ruby * erlang-repl = Erlang REPL * erlang = Erlang * excel = Excel * fix = FIX * flix = FLIX * fortran = Fortran * fsharp = F# * gams = GAMS * gauss = GAUSS * gcode = G-code * gherkin = Gherkin * glsl = GLSL * gml = GML * go = Go * golo = Golo * gradle = Gradle * groovy = Groovy * haml = Haml * arduino = Arduino * handlebars = Handlebars * haskell = Haskell * haxe = Haxe * hsp = HSP * htmlbars = HTMLBars * http = HTTP * hy = Hy * inform7 = Inform 7 * arduino = Ini, TOML * irpf90 = IRPF90 * isbl = ISBL * java = Java * javascript = Javascript * jboss-cli = jboss-cli * json = JSON * julia-repl = Julia REPL * julia = Julia * kotlin = Kotlin * lasso = Lasso * ldif = LDIF * leaf = Leaf * less = Less * lisp = Lisp * livecodeserver = LiveCode * livescript = LiveScript * llvm = LLVM IR * lsl = Linden Scripting Language * lua = Lua * makefile = Makefile * markdown = Markdown * mathematica = Mathematica * matlab = Matlab * maxima = Maxima * mel = MEL * mercury = Mercury * mipsasm = MIPS Assembly * mizar = Mizar * mojolicious = Mojolicious * monkey = Monkey * moonscript = MoonScript * n1ql = N1QL * nginx = Nginx * nimrod = Nimrod * nix = Nix * nsis = NSIS * objectivec = Objective-C * ocaml = OCaml * openscad = OpenSCAD * oxygene = Oxygene * parser3 = Parser3 * perl = Perl * pf = pf * pgsql = PostgreSQL * php = PHP * plaintext = plaintext * pony = Pony * powershell = PowerShell * processing = Processing * profile = Python profile * prolog = Prolog * properties = Properties * protobuf = Protocol Buffers * puppet = Puppet * purebasic = PureBASIC * python = Python * q = Q * qml = QML * r = R * reasonml = ReasonML * rib = RenderMan RIB * roboconf = Roboconf * routeros = Microtik RouterOS Script * rsl = RenderMan RSL * ruby = Ruby * ruleslanguage = Oracle Rules Language * rust = Rust * sas = SAS * scala = Scala * scheme = Scheme * scilab = Scilab * scss = SCSS * shell = Shell Session * smali = Smali * smalltalk = Smalltalk * sml = SML * sqf = SQF * sql = SQL * stan = Stan * stata = Stata * step21 = Step Part 21 * stylus = Stylus * subunit = SubUnit * swift = Swift * taggerscript = Tagger Script * tap = Test Anything Protocol * tcl = Tcl * tex = TeX * thrift = Thrift * tp = TP * twig = Twig * typescript = TypeScript * vala = Vala * vbnet = VB.NET * vbscript-html = VBScript in HTML * vbscript = VBScript * verilog = Verilog * vhdl = VHDL * vim = Vim Script * x86asm = Intel x86 Assembly * xl = XL * xml = XML * xquery = XQuery * yaml = YAML * zephir = Zephir
        Returns:
        available

      • setAvailable

        public void setAvailable​(String available)

      • getFontFamily

        @Nullable
public @Nullable String getFontFamily()
        Used to specify the font that should be used for syntax highlighting. 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 \"Fira Code\" font will be used automatically.
        Returns:
        fontFamily

      • setFontFamily

        public void setFontFamily​(String fontFamily)

      • getFontOrigin

        @Nullable
public @Nullable OperationSyntaxHighlight.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 syntax highlighting 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)

      • getLanguage

        @Nullable
public @Nullable String getLanguage()
        Used to select a specific language for highlighting recognition. You can select one of the languages listed for the \"available\" parameter. If you do not set this value, the system will attempt to automatically select an appropriate language from the list of available languages.
        Returns:
        language

      • setLanguage

        public void setLanguage​(String language)

      • 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)

      • getRelevance

        @Nullable
public @Nullable Integer getRelevance()
        The syntax highlighter evaluates the degree of reliability with which it recognizes a language with a value ranging from 0 to 1000 points. This value determines the reliability level starting from which it should highlight syntax for a recognized language. The higher the value, the more closely the content found must match the criteria.
        Returns:
        relevance

      • setRelevance

        public void setRelevance​(Integer relevance)

      • getWordBreak

        @Nullable
public @Nullable OperationSyntaxHighlight.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