|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.swt.graphics.Device
org.eclipse.swt.printing.Printer
public final class Printer
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.
PrinterData
,
PrintDialog
,
Printing snippets,
Sample code and further informationField Summary |
---|
Fields inherited from class org.eclipse.swt.graphics.Device |
---|
CurrentDevice, DEBUG, DeviceFinder, xDisplay |
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. |
Rectangle |
computeTrim(int x,
int y,
int width,
int height)
Given a client area (as described by the arguments), returns a rectangle, relative to the client area's coordinates, that is the client area expanded by the printer's trim (or minimum margins). |
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. |
Font |
getSystemFont()
Returns a reasonable font for applications to use. |
protected void |
init()
Initializes any internal resources needed by the device. |
void |
internal_dispose_GC(long gdkGC,
GCData data)
Invokes platform specific functionality to dispose a GC handle. |
long |
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(java.lang.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 |
---|
checkDevice, dispose, getDepth, getDeviceData, getFontList, getSystemColor, getWarnings, isDisposed, loadFont, setWarnings |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public Printer()
You must dispose the printer when it is no longer required.
SWTError
- Device.dispose()
public Printer(PrinterData data)
PrinterData
object representing the desired printer.
You must dispose the printer when it is no longer required.
data
- the printer data for the specified printer
java.lang.IllegalArgumentException
- SWTError
- Device.dispose()
Method Detail |
---|
public static PrinterData[] getPrinterList()
PrinterData
objects
representing all available printers.
public static PrinterData getDefaultPrinterData()
PrinterData
object representing
the default printer or null
if there is no
printer available on the System.
public Font getSystemFont()
Typically, applications which want the default look should simply not set the font on the widgets they create. Widgets are always created with the correct default font for the class of user-interface component they represent.
getSystemFont
in class Device
SWTException
- public long 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.
internal_new_GC
in interface Drawable
internal_new_GC
in class Device
data
- the platform specific GC data
public void internal_dispose_GC(long gdkGC, 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.
internal_dispose_GC
in interface Drawable
internal_dispose_GC
in class Device
hDC
- the platform specific GC handledata
- the platform specific GC dataprotected void release()
Device
class.
release
in class Device
Device.dispose()
,
Device.destroy()
public boolean startJob(java.lang.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.
jobName
- the name of the print job to start
SWTException
- startPage()
,
endPage()
,
endJob()
protected void destroy()
Device
class.
destroy
in class Device
Device.dispose()
,
Device.release()
public void endJob()
SWTException
- startJob(java.lang.String)
,
startPage()
,
endPage()
public void cancelJob()
SWTException
- public boolean startPage()
After calling startJob, this method may be called any number of times along with a matching endPage.
SWTException
- endPage()
,
startJob(java.lang.String)
,
endJob()
public void endPage()
SWTException
- startPage()
,
startJob(java.lang.String)
,
endJob()
public Point getDPI()
getDPI
in class Device
SWTException
- public Rectangle getBounds()
For a printer, this is the size of the physical page, in pixels.
getBounds
in class Device
SWTException
- getClientArea()
,
computeTrim(int, int, int, int)
public Rectangle getClientArea()
For a printer, this is the size of the printable area of the page, in pixels.
getClientArea
in class Device
SWTException
- getBounds()
,
computeTrim(int, int, int, int)
public Rectangle computeTrim(int x, int y, int width, int height)
Most printers have a minimum margin on each edge of the paper where the printer device is unable to print. This margin is known as the "trim." This method can be used to calculate the printer's minimum margins by passing in a client area of 0, 0, 0, 0 and then using the resulting x and y coordinates (which will be <= 0) to determine the minimum margins for the top and left edges of the paper, and the resulting width and height (offset by the resulting x and y) to determine the minimum margins for the bottom and right edges of the paper, as follows:
x
- the x coordinate of the client areay
- the y coordinate of the client areawidth
- the width of the client areaheight
- the height of the client area
SWTException
- getBounds()
,
getClientArea()
protected void create(DeviceData deviceData)
Device
class.
create
in class Device
deviceData
- the device dataDevice.init()
protected void init()
This method is called after create
.
If subclasses reimplement this method, they must
call the super
implementation.
init
in class Device
create(org.eclipse.swt.graphics.DeviceData)
public PrinterData getPrinterData()
PrinterData
object representing the
target printer for this print job.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |