Package net.webpdf.wsclient.openapi
Class OperationToolboxPrintPrint
- java.lang.Object
-
- net.webpdf.wsclient.openapi.OperationToolboxPrintPrint
-
public class OperationToolboxPrintPrint extends Object
The print operation element can be used to print documents.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classOperationToolboxPrintPrint.ModeEnumSelect the printing mode, that shall be used
-
Field Summary
Fields Modifier and Type Field Description static StringJSON_PROPERTY_AUTO_ROTATEstatic StringJSON_PROPERTY_CENTER_IN_PAGEstatic StringJSON_PROPERTY_COPIESstatic StringJSON_PROPERTY_DPIstatic StringJSON_PROPERTY_EXPAND_TO_MARGINSstatic StringJSON_PROPERTY_JOB_NAMEstatic StringJSON_PROPERTY_MODEstatic StringJSON_PROPERTY_PAGESstatic StringJSON_PROPERTY_PRINTER_NAMEstatic StringJSON_PROPERTY_SHRINK_TO_MARGINS
-
Constructor Summary
Constructors Constructor Description OperationToolboxPrintPrint()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description OperationToolboxPrintPrintautoRotate(Boolean autoRotate)OperationToolboxPrintPrintcenterInPage(Boolean centerInPage)OperationToolboxPrintPrintcopies(Integer copies)OperationToolboxPrintPrintdpi(Integer dpi)booleanequals(Object o)OperationToolboxPrintPrintexpandToMargins(Boolean expandToMargins)@Nullable BooleangetAutoRotate()If \"true,\" the PDF document's orientation will be automatically adjusted in line with the printer's configured paper orientation.@Nullable BooleangetCenterInPage()If \"true\", the PDF page will be centered in the middle of the paper.@Nullable IntegergetCopies()Defines the number of copies that should be printed.@Nullable IntegergetDpi()Sets the printer resolution for the \"image\" print mode.@Nullable BooleangetExpandToMargins()If \"true,\" any PDF page that is smaller than the paper will be enlarged to fit the paper size.@Nullable StringgetJobName()This attribute is used to define the name of the print job (as shown in the Print Spooler in Windows, for example).@Nullable OperationToolboxPrintPrint.ModeEnumgetMode()Select the printing mode, that shall be used@Nullable StringgetPages()Defines which page(s) should be printed.@Nullable StringgetPrinterName()This attribute is used to specify the name of the printer that should be used to print the PDF document.@Nullable BooleangetShrinkToMargins()If \"true,\" any PDF page that is larger than the paper will be shrunk to fit the paper size.inthashCode()OperationToolboxPrintPrintjobName(String jobName)OperationToolboxPrintPrintmode(OperationToolboxPrintPrint.ModeEnum mode)OperationToolboxPrintPrintpages(String pages)OperationToolboxPrintPrintprinterName(String printerName)voidsetAutoRotate(Boolean autoRotate)voidsetCenterInPage(Boolean centerInPage)voidsetCopies(Integer copies)voidsetDpi(Integer dpi)voidsetExpandToMargins(Boolean expandToMargins)voidsetJobName(String jobName)voidsetMode(OperationToolboxPrintPrint.ModeEnum mode)voidsetPages(String pages)voidsetPrinterName(String printerName)voidsetShrinkToMargins(Boolean shrinkToMargins)OperationToolboxPrintPrintshrinkToMargins(Boolean shrinkToMargins)StringtoString()
-
-
-
Field Detail
-
JSON_PROPERTY_AUTO_ROTATE
public static final String JSON_PROPERTY_AUTO_ROTATE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_CENTER_IN_PAGE
public static final String JSON_PROPERTY_CENTER_IN_PAGE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_COPIES
public static final String JSON_PROPERTY_COPIES
- See Also:
- Constant Field Values
-
JSON_PROPERTY_DPI
public static final String JSON_PROPERTY_DPI
- See Also:
- Constant Field Values
-
JSON_PROPERTY_EXPAND_TO_MARGINS
public static final String JSON_PROPERTY_EXPAND_TO_MARGINS
- See Also:
- Constant Field Values
-
JSON_PROPERTY_JOB_NAME
public static final String JSON_PROPERTY_JOB_NAME
- See Also:
- Constant Field Values
-
JSON_PROPERTY_MODE
public static final String JSON_PROPERTY_MODE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_PAGES
public static final String JSON_PROPERTY_PAGES
- See Also:
- Constant Field Values
-
JSON_PROPERTY_PRINTER_NAME
public static final String JSON_PROPERTY_PRINTER_NAME
- See Also:
- Constant Field Values
-
JSON_PROPERTY_SHRINK_TO_MARGINS
public static final String JSON_PROPERTY_SHRINK_TO_MARGINS
- See Also:
- Constant Field Values
-
-
Method Detail
-
autoRotate
public OperationToolboxPrintPrint autoRotate(Boolean autoRotate)
-
getAutoRotate
@Nullable public @Nullable Boolean getAutoRotate()
If \"true,\" the PDF document's orientation will be automatically adjusted in line with the printer's configured paper orientation.- Returns:
- autoRotate
-
setAutoRotate
public void setAutoRotate(Boolean autoRotate)
-
centerInPage
public OperationToolboxPrintPrint centerInPage(Boolean centerInPage)
-
getCenterInPage
@Nullable public @Nullable Boolean getCenterInPage()
If \"true\", the PDF page will be centered in the middle of the paper.- Returns:
- centerInPage
-
setCenterInPage
public void setCenterInPage(Boolean centerInPage)
-
copies
public OperationToolboxPrintPrint copies(Integer copies)
-
getCopies
@Nullable public @Nullable Integer getCopies()
Defines the number of copies that should be printed. minimum: 1- Returns:
- copies
-
setCopies
public void setCopies(Integer copies)
-
dpi
public OperationToolboxPrintPrint dpi(Integer dpi)
-
getDpi
@Nullable public @Nullable Integer getDpi()
Sets the printer resolution for the \"image\" print mode. If this value is set to 0, the document will be printed, using a resolution suggested by the printer. (High resolutions will lead to better quality results, but will tremendously increase the required time and resources.)- Returns:
- dpi
-
setDpi
public void setDpi(Integer dpi)
-
expandToMargins
public OperationToolboxPrintPrint expandToMargins(Boolean expandToMargins)
-
getExpandToMargins
@Nullable public @Nullable Boolean getExpandToMargins()
If \"true,\" any PDF page that is smaller than the paper will be enlarged to fit the paper size.- Returns:
- expandToMargins
-
setExpandToMargins
public void setExpandToMargins(Boolean expandToMargins)
-
jobName
public OperationToolboxPrintPrint jobName(String jobName)
-
getJobName
@Nullable public @Nullable String getJobName()
This attribute is used to define the name of the print job (as shown in the Print Spooler in Windows, for example).- Returns:
- jobName
-
setJobName
public void setJobName(String jobName)
-
mode
public OperationToolboxPrintPrint mode(OperationToolboxPrintPrint.ModeEnum mode)
-
getMode
@Nullable public @Nullable OperationToolboxPrintPrint.ModeEnum getMode()
Select the printing mode, that shall be used. * default = The drawing operations are applied to the printout as defined in the PDF document. * image = Creates an image of a fixed resolution for every page of the document, to guarantee a uniform printing result. * raster = Every page of the document is rastered before printing. This is a compatibility mode for older printers.- Returns:
- mode
-
setMode
public void setMode(OperationToolboxPrintPrint.ModeEnum mode)
-
pages
public OperationToolboxPrintPrint pages(String pages)
-
getPages
@Nullable public @Nullable String getPages()
Defines which page(s) should be printed. The page number can be an individual page, a page range, or a list (separated with commas) (e.g., \"1,5-6,9\"). To specify \"all pages,\" use an asterisk (\"\\*\").- Returns:
- pages
-
setPages
public void setPages(String pages)
-
printerName
public OperationToolboxPrintPrint printerName(String printerName)
-
getPrinterName
@Nullable public @Nullable String getPrinterName()
This attribute is used to specify the name of the printer that should be used to print the PDF document. If a printer is not declared, then the system's default printer will be used for printing.- Returns:
- printerName
-
setPrinterName
public void setPrinterName(String printerName)
-
shrinkToMargins
public OperationToolboxPrintPrint shrinkToMargins(Boolean shrinkToMargins)
-
getShrinkToMargins
@Nullable public @Nullable Boolean getShrinkToMargins()
If \"true,\" any PDF page that is larger than the paper will be shrunk to fit the paper size.- Returns:
- shrinkToMargins
-
setShrinkToMargins
public void setShrinkToMargins(Boolean shrinkToMargins)
-
-