|
Eclipse Platform Release 3.7 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.swt.graphics.DeviceData
org.eclipse.swt.printing.PrinterData
public final class PrinterData
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.
Printer
,
Printer.getPrinterList()
,
PrintDialog.open()
,
Printing snippets,
Sample code and further informationField Summary | |
---|---|
static 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
The default value is SWT.DEFAULT , meaning do not set a value;
use the printer's default duplex setting. |
static int |
DUPLEX_LONG_EDGE
duplex field value indicating
double-sided printing for binding on the long edge. |
static int |
DUPLEX_NONE
duplex field value indicating
single-sided printing. |
static 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 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 int |
PAGE_RANGE
scope field value indicating that
the range of pages specified by startPage and endPage
should be printed |
static 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 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 | |
---|---|
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 | |
---|---|
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 Detail |
---|
public String driver
public String name
public int scope
ALL_PAGES
PAGE_RANGE
SELECTION
public int startPage
public int endPage
public boolean printToFile
public String fileName
public int copyCount
public boolean collate
public int orientation
public int duplex
SWT.DEFAULT
DUPLEX_NONE
DUPLEX_LONG_EDGE
DUPLEX_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.
public static final int ALL_PAGES
scope
field value indicating that
all pages should be printed
public static final int PAGE_RANGE
scope
field value indicating that
the range of pages specified by startPage and endPage
should be printed
public static final int SELECTION
scope
field value indicating that
the current selection should be printed
public static final int PORTRAIT
orientation
field value indicating
portrait paper orientation
public static final int LANDSCAPE
orientation
field value indicating
landscape paper orientation
public static final int DUPLEX_NONE
duplex
field value indicating
single-sided printing.
This is also known as simplex printing.
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.
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.
Constructor Detail |
---|
public PrinterData()
Printer.getDefaultPrinterData()
public PrinterData(String driver, String name)
driver
- the printer driver for the printername
- the name of the printerdriver
,
name
Method Detail |
---|
public String toString()
toString
in class Object
|
Eclipse Platform Release 3.7 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2011. All rights reserved.