DocumentPrintSettings (Gnostice XtremeDocumentStudio (for Java) API Docs)

java.lang.Object
- com.gnostice.documents.controls.swing.printer.DocumentPrintSettings

```
public class DocumentPrintSettings
extends Object
```
This class represents settings for a printing operation of the DocumentPrinter component.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Chromaticity`	`getChromaticity()` Returns if the printing output is in color or monochrome.
`int`	`getCopies()` Returns number of copies that need to be made for the print job.
`String`	`getDefaultPrinterName()` Returns name of the default printer.
`String`	`getFileName()` Returns name of the file to which the document will be printed.
`Finishings`	`getFinishings()` Return finishing operation(s) that the printer applies for each printed document in the job.
`String`	`getJobName()` Returns the name of the print job in the print queue.
`MediaTray`	`getMediaTray()` Returns the current media tray or bin for the print job.
`Dimension`	`getPageDimension()` Returns page dimensions.
`Margin`	`getPageMargins()` Returns current page margins.
`Orientation`	`getPageOrientation()` Returns page orientation.
`PageAlignment`	`getPagePositioning()` Returns page alignment settings.
`PageRangeSettings`	`getPageRangeSettings()` Returns page range settings.
`PageScaling`	`getPageScaling()` Returns how pages in the PDF document are scaled to fit the printer paper size.
`PaperSize`	`getPaperSize()` Returns page size.
`String`	`getSelectedPrinter()` Returns name of current printer.
`SheetCollate`	`getSheetCollate()` Returns how media sheets of each copy of each printed document are collated.
`Sides`	`getSides()` Returns how print-stream pages are to be imposed upon the sides of the output medium.
`boolean`	`isAutoPageRotate()` Returns whether the printer automatically rotates the pages to suit the current orientation of the physical printer (landscape or portrait).
`boolean`	`isPrintToFile()` Returns whether the document is set to be printed to a file.
`void`	`printToFile(boolean printToFile)` Specifies whether documents need to be printed to a file.
`void`	`setAutoPageRotate(boolean autoRotate)` Specifies whether the printer automatically rotates the pages to suit the current orientation of the physical printer (landscape or portrait).
`void`	`setChromaticity(Chromaticity chromaticity)` Specifies printing output needs to be in color or monochrome.
`void`	`setCopies(int copies)` Sets specified number of copies for the print job.
`void`	`setCustomPaperSize(double width, double height, MeasurementUnit measurementUnit)` Sets specified page dimensions in specified measurement unit.
`void`	`setFileName(String printToFileName)` Sets specified name of the file to which the document will be printed.
`void`	`setFinishings(Finishings finishings)` Specifies finishing operation(s) that the printer applies for each printed document in the job.
`void`	`setJobName(String printJobName)` Sets specified name for the print job in the print queue.
`void`	`setMediaTray(MediaTray mediaTray)` Specifies the current media tray or bin for the print job.
`void`	`setPageMargins(Margin pageMargins, MeasurementUnit inUnits)` Sets specified page margins in specified measurement units.
`void`	`setPageOrientation(Orientation pageOrientation)` Sets specified page orientation.
`void`	`setPagePositioning(PageAlignment pageAlignment)` Sets specified page alignment settings.
`void`	`setPageScaling(PageScaling pageScaling)` Specifies how pages in the PDF document need to be scaled to fit the printer paper size.
`void`	`setPageSize(PaperSize pageSize)` Sets specified page size.
`void`	`setSelectedPrinter(String selectedPrinterName)` Sets printer with specified name as the current printer.
`void`	`setSheetCollate(SheetCollate sheetCollate)` Specifies how media sheets of each copy of each printed document are collated.
`void`	`setSides(Sides sides)` Specifies how print-stream pages need to be imposed upon the sides of the output medium.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - setJobName
```
public void setJobName(String printJobName)
```
    Sets specified name for the print job in the print queue.
    
    Parameters:
    
    printJobName - name for the print job
  - getJobName
```
public String getJobName()
```
    Returns the name of the print job in the print queue.
    
    Returns:
    
    name of the print job
  - setSelectedPrinter
```
public void setSelectedPrinter(String selectedPrinterName)
                        throws XDocException
```
    Sets printer with specified name as the current printer.
    
    Parameters:
    
    selectedPrinterName - name of the printer
    
    Throws:
    
    XDocException - if an error occurs setting the printer
  - getSelectedPrinter
```
public String getSelectedPrinter()
```
    Returns name of current printer.
    
    Returns:
    
    name of current printer
  - setPageSize
```
public void setPageSize(PaperSize pageSize)
```
    Sets specified page size.
    
    Parameters:
    
    pageSize - page size
  - getPaperSize
```
public PaperSize getPaperSize()
```
    Returns page size.
    
    Returns:
    
    page size
  - setPageOrientation
```
public void setPageOrientation(Orientation pageOrientation)
```
    Sets specified page orientation. (This value will be ignored if autoRotate is set to true.)
    
    Parameters:
    
    pageOrientation - page orientation
  - getPageOrientation
```
public Orientation getPageOrientation()
```
    Returns page orientation.
    
    Returns:
    
    page orientation
  - setCopies
```
public void setCopies(int copies)
```
    Sets specified number of copies for the print job.
    
    Parameters:
    
    copies - number of copies
  - getCopies
```
public int getCopies()
```
    Returns number of copies that need to be made for the print job.
    
    Returns:
    
    number of print copies
  - setPageScaling
```
public void setPageScaling(PageScaling pageScaling)
```
    Specifies how pages in the PDF document need to be scaled to fit the printer paper size.
    
    Parameters:
    
    pageScaling - how pages in the PDF document need to be scaled to fit the printer paper size
  - getPageScaling
```
public PageScaling getPageScaling()
```
    Returns how pages in the PDF document are scaled to fit the printer paper size.
    
    Returns:
    
    how pages in the PDF document are scaled to fit the printer paper size
  - isAutoPageRotate
```
public boolean isAutoPageRotate()
```
    Returns whether the printer automatically rotates the pages to suit the current orientation of the physical printer (landscape or portrait).
    
    Returns:
    
    whether the printer automatically rotates the pages
  - setAutoPageRotate
```
public void setAutoPageRotate(boolean autoRotate)
```
    Specifies whether the printer automatically rotates the pages to suit the current orientation of the physical printer (landscape or portrait).
    
    Parameters:
    
    autoRotate - whether the printer automatically rotates the pages
  - getDefaultPrinterName
```
public String getDefaultPrinterName()
```
    Returns name of the default printer.
    
    Returns:
    
    name of the default printer
  - setFileName
```
public void setFileName(String printToFileName)
```
    Sets specified name of the file to which the document will be printed.
    
    Parameters:
    
    printToFileName - name of the print-to-file file
  - getFileName
```
public String getFileName()
```
    Returns name of the file to which the document will be printed.
    
    Returns:
    
    name of the print-to-file file
  - printToFile
```
public void printToFile(boolean printToFile)
```
    Specifies whether documents need to be printed to a file.
    
    Parameters:
    
    printToFile - true if documents need to be printed to a file; false if otherwise
  - isPrintToFile
```
public boolean isPrintToFile()
```
    Returns whether the document is set to be printed to a file.
    
    Returns:
    
    true if document will be printed to a file; false if otherwise
  - setCustomPaperSize
```
public void setCustomPaperSize(double width,
                               double height,
                               MeasurementUnit measurementUnit)
                        throws XDocException
```
    Sets specified page dimensions in specified measurement unit.
    
    Parameters:
    
    width - width of the page
    
    height - height of the page
    
    measurementUnit - measurement unit in which the dimensions need to be applied
    
    Throws:
    
    XDocException - if an illegal value is specified
  - getPageDimension
```
public Dimension getPageDimension()
```
    Returns page dimensions.
    
    Returns:
    
    dimensions of the page
  - setPageMargins
```
public void setPageMargins(Margin pageMargins,
                           MeasurementUnit inUnits)
                    throws XDocException
```
    Sets specified page margins in specified measurement units.
    
    Parameters:
    
    pageMargins - page margins that need to be set
    
    inUnits - measurement unit in which the margins are specified
    
    Throws:
    
    XDocException - if an invalid value is specified
  - getPageMargins
```
public Margin getPageMargins()
```
    Returns current page margins.
    
    Returns:
    
    current page margins
  - setPagePositioning
```
public void setPagePositioning(PageAlignment pageAlignment)
```
    Sets specified page alignment settings.
    
    Parameters:
    
    pageAlignment - page alignment settings that need to be applied
  - getPagePositioning
```
public PageAlignment getPagePositioning()
```
    Returns page alignment settings.
    
    Returns:
    
    page alignment settings
  - setMediaTray
```
public void setMediaTray(MediaTray mediaTray)
```
    Specifies the current media tray or bin for the print job.
    
    Parameters:
    
    mediaTray - current media tray or bin for the print job
  - getMediaTray
```
public MediaTray getMediaTray()
```
    Returns the current media tray or bin for the print job.
    
    Returns:
    
    current media tray or bin
  - setChromaticity
```
public void setChromaticity(Chromaticity chromaticity)
```
    Specifies printing output needs to be in color or monochrome.
    
    Parameters:
    
    chromaticity - if printing output needs to be in color or monochrome
  - getChromaticity
```
public Chromaticity getChromaticity()
```
    Returns if the printing output is in color or monochrome.
    
    Returns:
    
    whether output is in color or monochrome
  - setSides
```
public void setSides(Sides sides)
```
    Specifies how print-stream pages need to be imposed upon the sides of the output medium.
    
    Parameters:
    
    sides - how print-stream pages need to be imposed
  - getSides
```
public Sides getSides()
```
    Returns how print-stream pages are to be imposed upon the sides of the output medium.
    
    Returns:
    
    how print-stream pages are to be imposed
  - setSheetCollate
```
public void setSheetCollate(SheetCollate sheetCollate)
```
    Specifies how media sheets of each copy of each printed document are collated.
    
    Parameters:
    
    sheetCollate - how the sheets need to be collated
  - getSheetCollate
```
public SheetCollate getSheetCollate()
```
    Returns how media sheets of each copy of each printed document are collated.
    
    Returns:
    
    how the sheets are collated
  - getFinishings
```
public Finishings getFinishings()
```
    Return finishing operation(s) that the printer applies for each printed document in the job.
    
    Returns:
    
    finishing operation(s)
  - setFinishings
```
public void setFinishings(Finishings finishings)
```
    Specifies finishing operation(s) that the printer applies for each printed document in the job.
    
    Parameters:
    
    finishings - finishing operation(s)
  - getPageRangeSettings
```
public PageRangeSettings getPageRangeSettings()
```
    Returns page range settings.
    
    Returns:
    
    current page range settings

Class DocumentPrintSettings

Method Summary

Methods inherited from class java.lang.Object

Method Detail

setJobName

getJobName

setSelectedPrinter

getSelectedPrinter

setPageSize

getPaperSize

setPageOrientation

getPageOrientation

setCopies

getCopies

setPageScaling

getPageScaling

isAutoPageRotate

setAutoPageRotate

getDefaultPrinterName

setFileName

getFileName

printToFile

isPrintToFile

setCustomPaperSize

getPageDimension

setPageMargins

getPageMargins

setPagePositioning

getPagePositioning

setMediaTray

getMediaTray

setChromaticity

getChromaticity

setSides

getSides

setSheetCollate

getSheetCollate

getFinishings

setFinishings

getPageRangeSettings