Package org.eclipse.swt.printing

Class PrinterData

java.lang.Object
org.eclipse.swt.graphics.DeviceData
org.eclipse.swt.printing.PrinterData
public final class PrinterData extends DeviceData
Instances of this class are descriptions of a print job in terms of the printer, and the scope and type of printing that is desired. For example, the number of pages and copies can be specified, as well as whether or not the print job should go to a file.

Application code does not need to explicitly release the resources managed by each instance when those instances are no longer required, and thus no dispose() method is provided.

See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    ALL_PAGES
    scope field value indicating that all pages should be printed
    boolean
    collate
    whether or not the printer should collate the printed paper Note that this field may be controlled by the printer driver.
    int
    copyCount
    the number of copies to print.
    String
    driver
    the printer driver On Windows systems, this is the name of the driver (often "winspool").
    int
    duplex
    Single-sided or double-sided printing, expressed as one of the following values: SWT.DEFAULT the default duplex value for the printer DUPLEX_NONE single-sided printing DUPLEX_LONG_EDGE double-sided printing as if bound on the long edge DUPLEX_SHORT_EDGE double-sided printing as if bound on the short edge
    static final int
    DUPLEX_LONG_EDGE
    duplex field value indicating double-sided printing for binding on the long edge.
    static final int
    DUPLEX_NONE
    duplex field value indicating single-sided printing.
    static final int
    DUPLEX_SHORT_EDGE
    duplex field value indicating double-sided printing for binding on the short edge.
    int
    endPage
    the end page of a page range, used when scope is PAGE_RANGE.
    String
    fileName
    the name of the file to print to if printToFile is true.
    static final int
    LANDSCAPE
    orientation field value indicating landscape paper orientation
    String
    name
    the name of the printer On Windows systems, this is the name of the 'device'.
    int
    orientation
    The orientation of the paper, which can be either PORTRAIT or LANDSCAPE.
    static final int
    PAGE_RANGE
    scope field value indicating that the range of pages specified by startPage and endPage should be printed
    static final int
    PORTRAIT
    orientation field value indicating portrait paper orientation
    boolean
    printToFile
    whether or not the print job should go to a file
    int
    scope
    the scope of the print job, expressed as one of the following values: ALL_PAGES Print all pages in the current document PAGE_RANGE Print the range of pages specified by startPage and endPage SELECTION Print the current selection
    static final int
    SELECTION
    scope field value indicating that the current selection should be printed
    int
    startPage
    the start page of a page range, used when scope is PAGE_RANGE.

    Fields inherited from class org.eclipse.swt.graphics.DeviceData

    debug, errors, objects, tracking

  • Constructor Summary

    Constructors
    Constructor
    Description
    PrinterData()
    Constructs an instance of this class that can be used to print to the default printer.
    PrinterData(String driver, String name)
    Constructs an instance of this class with the given printer driver and printer name.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    toString()
    Returns a string containing a concise, human-readable description of the receiver.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

  • Field Details

    • driver

      public String driver
      the printer driver On Windows systems, this is the name of the driver (often "winspool"). On Mac OSX, this is the destination type ("Printer", "Fax", "File", or "Preview"). On X/Window systems, this is the name of a display connection to the Xprt server (the default is ":1"). On GTK+, this is the backend type name (eg. GtkPrintBackendCups).

    • name

      public String name
      the name of the printer On Windows systems, this is the name of the 'device'. On Mac OSX, X/Window systems, and GTK+, this is the printer's 'name'.

    • scope

      public int scope
      the scope of the print job, expressed as one of the following values:
      ALL_PAGES
      Print all pages in the current document
      PAGE_RANGE
      Print the range of pages specified by startPage and endPage
      SELECTION
      Print the current selection

    • startPage

      public int startPage
      the start page of a page range, used when scope is PAGE_RANGE. This value can be from 1 to the maximum number of pages for the platform.

    • endPage

      public int endPage
      the end page of a page range, used when scope is PAGE_RANGE. This value can be from 1 to the maximum number of pages for the platform.

    • printToFile

      public boolean printToFile
      whether or not the print job should go to a file

    • fileName

      public String fileName
      the name of the file to print to if printToFile is true. Note that this field is ignored if printToFile is false.

    • copyCount

      public int copyCount
      the number of copies to print. Note that this field may be controlled by the printer driver In other words, the printer itself may be capable of printing multiple copies, and if so, the value of this field will always be 1.

    • collate

      public boolean collate
      whether or not the printer should collate the printed paper Note that this field may be controlled by the printer driver. In other words, the printer itself may be capable of doing the collation, and if so, the value of this field will always be false.

    • orientation

      public int orientation
      The orientation of the paper, which can be either PORTRAIT or LANDSCAPE.
      Since:
      3.5

    • duplex

      public int duplex
      Single-sided or double-sided printing, expressed as one of the following values:
      SWT.DEFAULT
      the default duplex value for the printer
      DUPLEX_NONE
      single-sided printing
      DUPLEX_LONG_EDGE
      double-sided printing as if bound on the long edge
      DUPLEX_SHORT_EDGE
      double-sided printing as if bound on the short edge

      The default value is SWT.DEFAULT, meaning do not set a value; use the printer's default duplex setting. A printer's default value is typically single-sided, however it can default to double-sided in order to save paper.

      Since:
      3.7

    • ALL_PAGES

      public static final int ALL_PAGES
      scope field value indicating that all pages should be printed
      See Also:

    • PAGE_RANGE

      public static final int PAGE_RANGE
      scope field value indicating that the range of pages specified by startPage and endPage should be printed
      See Also:

    • SELECTION

      public static final int SELECTION
      scope field value indicating that the current selection should be printed
      See Also:

    • PORTRAIT

      public static final int PORTRAIT
      orientation field value indicating portrait paper orientation
      Since:
      3.5
      See Also:

    • LANDSCAPE

      public static final int LANDSCAPE
      orientation field value indicating landscape paper orientation
      Since:
      3.5
      See Also:

    • DUPLEX_NONE

      public static final int DUPLEX_NONE
      duplex field value indicating single-sided printing.

      This is also known as simplex printing.

      Since:
      3.7
      See Also:

    • DUPLEX_LONG_EDGE

      public static final int DUPLEX_LONG_EDGE
      duplex field value indicating double-sided printing for binding on the long edge.

      For portrait orientation, the long edge is vertical. For landscape orientation, the long edge is horizontal.

      This is also known as duplex printing.

      Since:
      3.7
      See Also:

    • DUPLEX_SHORT_EDGE

      public static final int DUPLEX_SHORT_EDGE
      duplex field value indicating double-sided printing for binding on the short edge.

      For portrait orientation, the short edge is horizontal. For landscape orientation, the short edge is vertical.

      This is also known as duplex tumble printing.

      Since:
      3.7
      See Also:

  • Constructor Details

    • PrinterData

      public PrinterData()
      Constructs an instance of this class that can be used to print to the default printer.
      See Also:

    • PrinterData

      public PrinterData(String driver, String name)
      Constructs an instance of this class with the given printer driver and printer name.
      Parameters:
      driver - the printer driver for the printer
      name - the name of the printer
      See Also:

  • Method Details

    • toString

      public String toString()
      Returns a string containing a concise, human-readable description of the receiver.
      Overrides:
      toString in class Object
      Returns:
      a string representation of the receiver