org.eclipse.swt.graphics.Device
org.eclipse.swt.printing.Printer
|
Eclipse Platform Release 3.0 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
java.lang.Object
Instances of this class are used to print to a printer. Applications create a GC on a printer using new GC(printer) and then draw on the printer GC using the usual graphics calls.
A Printer object may be constructed by providing a PrinterData object which identifies the printer. A PrintDialog presents a print dialog to the user and returns an initialized instance of PrinterData. Alternatively, calling new Printer() will construct a printer object for the user's default printer.
Application code must explicitly invoke the Printer.dispose() method to release the operating system resources managed by each instance when those instances are no longer required.
| Field Summary | |
| int | handle
the handle to the printer DC (Warning: This field is platform dependent) |
| Fields inherited from class org.eclipse.swt.graphics.Device |
| CurrentDevice, DEBUG, DeviceFinder, hPalette |
| Constructor Summary | |
| Printer()
Constructs a new printer representing the default printer. | |
| Printer(PrinterData data)
Constructs a new printer given a PrinterData object representing the desired printer. | |
| Method Summary | |
| void | cancelJob()
Cancels a print job in progress. |
| protected void | checkDevice()
Checks the validity of this device. |
| Rectangle | computeTrim(int x,
int y,
int width,
int height)
Given a desired client area for the receiver (as described by the arguments), returns the bounding rectangle which would be required to produce that client area. |
| protected void | create(DeviceData deviceData)
Creates the printer handle. |
| protected void | destroy()
Destroys the printer handle. |
| void | endJob()
Ends the current print job. |
| void | endPage()
Ends the current page. |
| Rectangle | getBounds()
Returns a rectangle describing the receiver's size and location. |
| Rectangle | getClientArea()
Returns a rectangle which describes the area of the receiver which is capable of displaying data. |
| static PrinterData | getDefaultPrinterData()
Returns a PrinterData object representing the default printer or null if there is no printer available on the System. |
| Point | getDPI()
Returns a point whose x coordinate is the horizontal dots per inch of the printer, and whose y coordinate is the vertical dots per inch of the printer. |
| PrinterData | getPrinterData()
Returns a PrinterData object representing the target printer for this print job. |
| static PrinterData[] | getPrinterList()
Returns an array of PrinterData objects representing all available printers. |
| void | internal_dispose_GC(int hDC,
GCData data)
Invokes platform specific functionality to dispose a GC handle. |
| int | internal_new_GC(GCData data)
Invokes platform specific functionality to allocate a new GC handle. |
| protected void | release()
Releases any internal state prior to destroying this printer. |
| boolean | startJob(String jobName)
Starts a print job and returns true if the job started successfully and false otherwise. |
| boolean | startPage()
Starts a page and returns true if the page started successfully and false otherwise. |
| Methods inherited from class org.eclipse.swt.graphics.Device |
| dispose, getDepth, getDeviceData, getFontList, getSystemColor, getSystemFont, getWarnings, init, isDisposed, setWarnings |
| Methods inherited from class java.lang.Object |
| clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
|
Field Detail |
public int handle
| Constructor Detail |
public Printer()
You must dispose the printer when it is no longer required.
public Printer(PrinterData data)
You must dispose the printer when it is no longer required.
| Method Detail |
public static PrinterData[] getPrinterList()
public static PrinterData getDefaultPrinterData()
protected void create(DeviceData deviceData)
public int internal_new_GC(GCData data)
IMPORTANT: This method is not part of the public API for Printer. It is marked public only so that it can be shared within the packages provided by SWT. It is not available on all platforms, and should never be called from application code.
public void internal_dispose_GC(int hDC,
GCData data)
IMPORTANT: This method is not part of the public API for Printer. It is marked public only so that it can be shared within the packages provided by SWT. It is not available on all platforms, and should never be called from application code.
public boolean startJob(String jobName)
This must be the first method called to initiate a print job, followed by any number of startPage/endPage calls, followed by endJob. Calling startPage, endPage, or endJob before startJob will result in undefined behavior.
public void endJob()
public void cancelJob()
public boolean startPage()
After calling startJob, this method may be called any number of times along with a matching endPage.
public void endPage()
public Point getDPI()
public Rectangle getBounds()
public Rectangle getClientArea()
public Rectangle computeTrim(int x,
int y,
int width,
int height)
In other words, it returns a rectangle such that, if the receiver's bounds were set to that rectangle, the area of the receiver which is capable of displaying data (that is, not covered by the "trimmings") would be the rectangle described by the arguments (relative to the receiver's parent).
Note that there is no setBounds for a printer. This method is usually used by passing in the client area (the 'printable area') of the printer. It can also be useful to pass in 0, 0, 0, 0.
public PrinterData getPrinterData()
protected void checkDevice()
protected void release()
protected void destroy()
|
Eclipse Platform Release 3.0 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2004. All rights reserved.