Package net.webpdf.wsclient.openapi
Class OperationTextHighlight
- java.lang.Object
-
- net.webpdf.wsclient.openapi.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.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classOperationTextHighlight.FontOriginEnumUsed to specify whether the selected font should be obtained from your operating system or from the \"templates/fonts\" folder (in your webPDF installation path).static classOperationTextHighlight.WordBreakEnumCan 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.
-
Field Summary
Fields Modifier and Type Field Description static StringJSON_PROPERTY_COLORstatic StringJSON_PROPERTY_FONT_FAMILYstatic StringJSON_PROPERTY_FONT_ORIGINstatic StringJSON_PROPERTY_FONT_SIZEstatic StringJSON_PROPERTY_LINE_HEIGHTstatic StringJSON_PROPERTY_LINE_NUMBERSstatic StringJSON_PROPERTY_WORD_BREAK
-
Constructor Summary
Constructors Constructor Description OperationTextHighlight()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description OperationTextHighlightcolor(String color)booleanequals(Object o)OperationTextHighlightfontFamily(String fontFamily)OperationTextHighlightfontOrigin(OperationTextHighlight.FontOriginEnum fontOrigin)OperationTextHighlightfontSize(String fontSize)@Nullable StringgetColor()Sets the font color for the text to the given value.@Nullable StringgetFontFamily()Specifies the font to use for the text.@Nullable OperationTextHighlight.FontOriginEnumgetFontOrigin()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).@Nullable StringgetFontSize()Used to set the font size for the text to the specified value.@Nullable StringgetLineHeight()Used to set the line height.@Nullable BooleangetLineNumbers()If this value is set to \"true\", line numbers are added before the code.@Nullable OperationTextHighlight.WordBreakEnumgetWordBreak()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.inthashCode()OperationTextHighlightlineHeight(String lineHeight)OperationTextHighlightlineNumbers(Boolean lineNumbers)voidsetColor(String color)voidsetFontFamily(String fontFamily)voidsetFontOrigin(OperationTextHighlight.FontOriginEnum fontOrigin)voidsetFontSize(String fontSize)voidsetLineHeight(String lineHeight)voidsetLineNumbers(Boolean lineNumbers)voidsetWordBreak(OperationTextHighlight.WordBreakEnum wordBreak)StringtoString()OperationTextHighlightwordBreak(OperationTextHighlight.WordBreakEnum wordBreak)
-
-
-
Field Detail
-
JSON_PROPERTY_COLOR
public static final String JSON_PROPERTY_COLOR
- See Also:
- Constant Field Values
-
JSON_PROPERTY_FONT_FAMILY
public static final String JSON_PROPERTY_FONT_FAMILY
- See Also:
- Constant Field Values
-
JSON_PROPERTY_FONT_ORIGIN
public static final String JSON_PROPERTY_FONT_ORIGIN
- See Also:
- Constant Field Values
-
JSON_PROPERTY_FONT_SIZE
public static final String JSON_PROPERTY_FONT_SIZE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_LINE_HEIGHT
public static final String JSON_PROPERTY_LINE_HEIGHT
- See Also:
- Constant Field Values
-
JSON_PROPERTY_LINE_NUMBERS
public static final String JSON_PROPERTY_LINE_NUMBERS
- See Also:
- Constant Field Values
-
JSON_PROPERTY_WORD_BREAK
public static final String JSON_PROPERTY_WORD_BREAK
- See Also:
- Constant Field Values
-
-
Method Detail
-
color
public OperationTextHighlight color(String color)
-
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)
-
fontFamily
public OperationTextHighlight fontFamily(String fontFamily)
-
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)
-
fontOrigin
public OperationTextHighlight fontOrigin(OperationTextHighlight.FontOriginEnum fontOrigin)
-
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
-
setFontOrigin
public void setFontOrigin(OperationTextHighlight.FontOriginEnum fontOrigin)
-
fontSize
public OperationTextHighlight fontSize(String fontSize)
-
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)
-
lineHeight
public OperationTextHighlight lineHeight(String lineHeight)
-
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)
-
lineNumbers
public OperationTextHighlight lineNumbers(Boolean lineNumbers)
-
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)
-
wordBreak
public OperationTextHighlight wordBreak(OperationTextHighlight.WordBreakEnum wordBreak)
-
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
-
setWordBreak
public void setWordBreak(OperationTextHighlight.WordBreakEnum wordBreak)
-
-