Standard Widget Toolkit for GTK 3.125.0 · org.eclipse.swt.printing.Printer

Modifier and Type	Field and Description
pack-priv long	cairo
pack-priv PrinterData	data
pack-priv static boolean	disablePrinting
pack-priv static int	end
pack-priv static PrinterData	findData
pack-priv static long	findPrinter
pack-priv static final String	GTK_FILE_BACKEND
pack-priv static final String	GTK_LPR_BACKEND
pack-priv boolean	isGCCreated whether or not a GC was created for this printer
pack-priv long	pageSetup
pack-priv long	printer
pack-priv static PrinterData[]	printerList
pack-priv long	printJob
pack-priv long	settings
pack-priv static byte[]	settingsData
pack-priv static int	start
pack-priv long	surface

Access	Constructor and Description
public	Printer() Constructs a new printer representing the default printer.
public	Printer(PrinterData the printer data for the specified printer, or null to use the default printer data) Constructs a new printer given a `PrinterData` object representing the desired printer.

Method Summary

Modifier and Type	Method and Description
public void	cancelJob() Cancels a print job in progress.
pack-priv static DeviceData	checkNull(PrinterData data)
public Rectangle	Returns: a rectangle, relative to the client area's coordinates, that is the client area expanded by the printer's trim (or minimum margins) computeTrim(int the x coordinate of the client area x, int the y coordinate of the client area y, int the width of the client area width, int the height of the client area 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 the device data deviceData) Overrides org.eclipse.swt.graphics.Device.create. Creates the printer handle.
protected void	destroy() Overrides org.eclipse.swt.graphics.Device.destroy. Destroys the printer handle.
public void	endJob() Ends the current print job.
public void	endPage() Ends the current page.
public Rectangle	Returns: the bounding rectangle getBounds() Overrides org.eclipse.swt.graphics.Device.getBounds. Returns a rectangle describing the receiver's size and location.
public Rectangle	Returns: the client area getClientArea() Overrides org.eclipse.swt.graphics.Device.getClientArea. Returns a rectangle which describes the area of the receiver which is capable of displaying data.
public static PrinterData	Returns: the default printer data or null getDefaultPrinterData() Returns a `PrinterData` object representing the default printer or `null` if there is no default printer.
public Point	Returns: the horizontal and vertical DPI getDPI() Overrides org.eclipse.swt.graphics.Device.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.
pack-priv Point	getIndependentDPI()
public PrinterData	Returns: a PrinterData object describing the receiver getPrinterData() Returns a `PrinterData` object representing the target printer for this print job.
public static PrinterData[]	Returns: an array of PrinterData objects representing the available printers getPrinterList() Returns an array of `PrinterData` objects representing all available printers.
pack-priv static void	gtk_init()
pack-priv static long	gtkPrinterFromPrinterData(PrinterData data)
pack-priv static long	GtkPrinterFunc_Default(long printer, long user_data)
pack-priv static long	GtkPrinterFunc_FindNamedPrinter(long printer, long user_data)
pack-priv static long	GtkPrinterFunc_List(long printer, long user_data)
protected void	init() Overrides org.eclipse.swt.graphics.Device.init. Initializes any internal resources needed by the device.
public void	internal_dispose_GC(long the platform specific GC handle hDC, GCData the platform specific GC data data) Implements abstract org.eclipse.swt.graphics.Device.internal_dispose_GC. Implements org.eclipse.swt.graphics.Drawable.internal_dispose_GC. Invokes platform specific functionality to dispose a GC handle.
public long	Returns: the platform specific GC handle internal_new_GC(GCData the platform specific GC data data) Implements abstract org.eclipse.swt.graphics.Device.internal_new_GC. Implements org.eclipse.swt.graphics.Drawable.internal_new_GC. Invokes platform specific functionality to allocate a new GC handle.
public boolean	isAutoScalable() Overrides default org.eclipse.swt.graphics.Drawable.isAutoScalable. Returns `true` iff coordinates can be auto-scaled on this drawable and `false` if not.
pack-priv static PrinterData	printerDataFromGtkPrinter(long printer)
pack-priv static void	restore(byte[] data, long settings, long page_setup)
pack-priv static boolean	restoreBoolean(String key)
pack-priv static byte[]	restoreBytes(String key, boolean nullTerminate)
pack-priv static double	restoreDouble(String key)
pack-priv static int	restoreInt(String key)
public boolean	Returns: true if the job started successfully and false otherwise. startJob(String the name of the print job to start jobName) Starts a print job and returns true if the job started successfully and false otherwise.
public boolean	Returns: true if the page started successfully and false otherwise. startPage() Starts a page and returns true if the page started successfully and false otherwise.
pack-priv static byte[]	uriFromFilename(String filename)

Inherited from org.eclipse.swt.graphics.Device:: checkDevice dispose getDepth getDeviceData getDeviceZoom getFontList getSystemColor getSystemFont getWarnings isDisposed isTracking loadFont release setTracking setWarnings

cairo	back to summary
pack-priv long cairo

data	back to summary
pack-priv PrinterData data

disablePrinting	back to summary
pack-priv static boolean disablePrinting

end	back to summary
pack-priv static int end

findData	back to summary
pack-priv static PrinterData findData

findPrinter	back to summary
pack-priv static long findPrinter

GTK_FILE_BACKEND	back to summary
pack-priv static final String GTK_FILE_BACKEND

GTK_LPR_BACKEND	back to summary
pack-priv static final String GTK_LPR_BACKEND

isGCCreated	back to summary
pack-priv boolean isGCCreated whether or not a GC was created for this printer

pageSetup	back to summary
pack-priv long pageSetup

printer	back to summary
pack-priv long printer

printerList	back to summary
pack-priv static PrinterData[] printerList

printJob	back to summary
pack-priv long printJob

settings	back to summary
pack-priv long settings

settingsData	back to summary
pack-priv static byte[] settingsData

start	back to summary
pack-priv static int start

surface	back to summary
pack-priv long surface

Printer	back to summary
public Printer() Constructs a new printer representing the default printer. Note You must dispose the printer when it is no longer required. Exceptions SWTError: ERROR_NO_HANDLES - if there is no valid default printer See Also `Device#dispose`

Printer	back to summary
public Printer(PrinterData data) Constructs a new printer given a `PrinterData` object representing the desired printer. If the argument is null, then the default printer will be used. Note You must dispose the printer when it is no longer required. Parameters data:PrinterData the printer data for the specified printer, or null to use the default printer Exceptions IllegalArgumentException: ERROR_INVALID_ARGUMENT - if the specified printer data does not represent a valid printer SWTError: ERROR_NO_HANDLES - if there are no valid printers See Also `Device#dispose`

Method Detail

cancelJob	back to summary
public void cancelJob() Cancels a print job in progress. Exceptions SWTException: ERROR_DEVICE_DISPOSED - if the receiver has been disposed

cancelJob

back to summary

public void cancelJob()

Cancels a print job in progress.

Exceptions

SWTException:

ERROR_DEVICE_DISPOSED - if the receiver has been disposed

checkNull	back to summary
pack-priv static DeviceData checkNull(PrinterData data)

computeTrim back to summary

computeTrim	back to summary
public 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). 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: The left trim width is -x pixels The top trim height is -y pixels The right trim width is (x + width) pixels The bottom trim height is (y + height) pixels Parameters x:int the x coordinate of the client area y:int the y coordinate of the client area width:int the width of the client area height:int the height of the client area Returns:Rectangle a rectangle, relative to the client area's coordinates, that is the client area expanded by the printer's trim (or minimum margins) Exceptions SWTException: ERROR_DEVICE_DISPOSED - if the receiver has been disposed See Also `getBounds`, `getClientArea`

public 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).

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:

The left trim width is -x pixels
The top trim height is -y pixels
The right trim width is (x + width) pixels
The bottom trim height is (y + height) pixels

Parameters

x:int: the x coordinate of the client area
y:int: the y coordinate of the client area
width:int: the width of the client area
height:int: the height of the client area

Returns:Rectangle

a rectangle, relative to the client area's coordinates, that is the client area expanded by the printer's trim (or minimum margins)

Exceptions

SWTException:

ERROR_DEVICE_DISPOSED - if the receiver has been disposed

See Also

getBounds, getClientArea

create back to summary

create	back to summary
protected void create(DeviceData deviceData) Overrides org.eclipse.swt.graphics.Device.create. Creates the printer handle. This method is called internally by the instance creation mechanism of the `Device` class. Parameters deviceData:DeviceData the device data Annotations @Override

protected void create(DeviceData deviceData)

Overrides org.eclipse.swt.graphics.Device.create.

Creates the printer handle. This method is called internally by the instance creation mechanism of the Device class.

Parameters

deviceData:DeviceData: the device data

Annotations

@Override

destroy back to summary

destroy	back to summary
protected void destroy() Overrides org.eclipse.swt.graphics.Device.destroy. Destroys the printer handle. This method is called internally by the dispose mechanism of the `Device` class. Annotations @Override

protected void destroy()

Overrides org.eclipse.swt.graphics.Device.destroy.

Destroys the printer handle. This method is called internally by the dispose mechanism of the Device class.

Annotations

@Override

endJob back to summary

endJob	back to summary
public void endJob() Ends the current print job. Exceptions SWTException: ERROR_DEVICE_DISPOSED - if the receiver has been disposed See Also `startJob`, `startPage`, `endPage`

public void endJob()

Ends the current print job.

Exceptions

SWTException:

ERROR_DEVICE_DISPOSED - if the receiver has been disposed

See Also

startJob, startPage, endPage

endPage back to summary

endPage	back to summary
public void endPage() Ends the current page. Exceptions SWTException: ERROR_DEVICE_DISPOSED - if the receiver has been disposed See Also `startPage`, `startJob`, `endJob`

public void endPage()

Ends the current page.

Exceptions

SWTException:

ERROR_DEVICE_DISPOSED - if the receiver has been disposed

See Also

startPage, startJob, endJob

getBounds back to summary

getBounds	back to summary
public Rectangle getBounds() Overrides org.eclipse.swt.graphics.Device.getBounds. Returns a rectangle describing the receiver's size and location. For a printer, this is the size of the physical page, in pixels. Returns:Rectangle the bounding rectangle Annotations @Override Exceptions SWTException: ERROR_DEVICE_DISPOSED - if the receiver has been disposed See Also `getClientArea`, `computeTrim`

public Rectangle getBounds()

Overrides org.eclipse.swt.graphics.Device.getBounds.

Returns a rectangle describing the receiver's size and location.

For a printer, this is the size of the physical page, in pixels.

Returns:Rectangle

the bounding rectangle

Annotations

@Override

Exceptions

SWTException:

ERROR_DEVICE_DISPOSED - if the receiver has been disposed

See Also

getClientArea, computeTrim

getClientArea back to summary

getClientArea	back to summary
public Rectangle getClientArea() Overrides org.eclipse.swt.graphics.Device.getClientArea. Returns a rectangle which describes the area of the receiver which is capable of displaying data. For a printer, this is the size of the printable area of the page, in pixels. Returns:Rectangle the client area Annotations @Override Exceptions SWTException: ERROR_DEVICE_DISPOSED - if the receiver has been disposed See Also `getBounds`, `computeTrim`

public Rectangle getClientArea()

Overrides org.eclipse.swt.graphics.Device.getClientArea.

Returns a rectangle which describes the area of the receiver which is capable of displaying data.

For a printer, this is the size of the printable area of the page, in pixels.

Returns:Rectangle

the client area

Annotations

@Override

Exceptions

SWTException:

ERROR_DEVICE_DISPOSED - if the receiver has been disposed

See Also

getBounds, computeTrim

getDefaultPrinterData back to summary

getDefaultPrinterData	back to summary
public static PrinterData getDefaultPrinterData() Returns a `PrinterData` object representing the default printer or `null` if there is no default printer. Returns:PrinterData the default printer data or null Since 2.1

public static PrinterData getDefaultPrinterData()

Returns a PrinterData object representing the default printer or null if there is no default printer.

Returns:PrinterData: the default printer data or null
Since: 2.1

getDPI	back to summary
public Point getDPI() Overrides org.eclipse.swt.graphics.Device.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. Returns:Point the horizontal and vertical DPI Annotations @Override Exceptions SWTException: ERROR_DEVICE_DISPOSED - if the receiver has been disposed

getDPI

back to summary

public Point getDPI()

Overrides org.eclipse.swt.graphics.Device.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.

Returns:Point

the horizontal and vertical DPI

Annotations

@Override

Exceptions

SWTException:

ERROR_DEVICE_DISPOSED - if the receiver has been disposed

getIndependentDPI	back to summary
pack-priv Point getIndependentDPI()

getPrinterData back to summary

getPrinterData	back to summary
public PrinterData getPrinterData() Returns a `PrinterData` object representing the target printer for this print job. Returns:PrinterData a PrinterData object describing the receiver

public PrinterData getPrinterData()

Returns a PrinterData object representing the target printer for this print job.

Returns:PrinterData: a PrinterData object describing the receiver

getPrinterList back to summary

getPrinterList	back to summary
public static PrinterData[] getPrinterList() Returns an array of `PrinterData` objects representing all available printers. If there are no printers, the array will be empty. Returns:PrinterData[] an array of PrinterData objects representing the available printers

public static PrinterData[] getPrinterList()

Returns an array of PrinterData objects representing all available printers. If there are no printers, the array will be empty.

Returns:PrinterData[]: an array of PrinterData objects representing the available printers

gtk_init	back to summary
pack-priv static void gtk_init()

gtkPrinterFromPrinterData	back to summary
pack-priv static long gtkPrinterFromPrinterData(PrinterData data)

GtkPrinterFunc_Default	back to summary
pack-priv static long GtkPrinterFunc_Default(long printer, long user_data)

GtkPrinterFunc_FindNamedPrinter	back to summary
pack-priv static long GtkPrinterFunc_FindNamedPrinter(long printer, long user_data)

GtkPrinterFunc_List	back to summary
pack-priv static long GtkPrinterFunc_List(long printer, long user_data)

init back to summary

init	back to summary
protected void init() Overrides org.eclipse.swt.graphics.Device.init. Initializes any internal resources needed by the device. This method is called after `create`. If subclasses reimplement this method, they must call the `super` implementation. Annotations @Override See Also `create`

protected void init()

Overrides org.eclipse.swt.graphics.Device.init.

Initializes any internal resources needed by the device.

This method is called after create.

If subclasses reimplement this method, they must call the super implementation.

Annotations

@Override

See Also

create

internal_dispose_GC back to summary

internal_dispose_GC	back to summary
public void internal_dispose_GC(long hDC, GCData data) Implements abstract org.eclipse.swt.graphics.Device.internal_dispose_GC. Implements org.eclipse.swt.graphics.Drawable.internal_dispose_GC. Invokes platform specific functionality to dispose a GC handle. Important Note 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. Parameters hDC:long the platform specific GC handle data:GCData the platform specific GC data Annotations @Override

public void internal_dispose_GC(long hDC, GCData data)

Implements abstract org.eclipse.swt.graphics.Device.internal_dispose_GC.

Implements org.eclipse.swt.graphics.Drawable.internal_dispose_GC.

Invokes platform specific functionality to dispose a GC handle.

Important Note

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.

Parameters

hDC:long: the platform specific GC handle
data:GCData: the platform specific GC data

Annotations

@Override

internal_new_GC back to summary

internal_new_GC	back to summary
public long internal_new_GC(GCData data) Implements abstract org.eclipse.swt.graphics.Device.internal_new_GC. Implements org.eclipse.swt.graphics.Drawable.internal_new_GC. Invokes platform specific functionality to allocate a new GC handle. Important Note 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. Parameters data:GCData the platform specific GC data Returns:long the platform specific GC handle Annotations @Override

public long internal_new_GC(GCData data)

Implements abstract org.eclipse.swt.graphics.Device.internal_new_GC.

Implements org.eclipse.swt.graphics.Drawable.internal_new_GC.

Invokes platform specific functionality to allocate a new GC handle.

Important Note

Parameters

data:GCData: the platform specific GC data

Returns:long

the platform specific GC handle

Annotations

@Override

isAutoScalable back to summary

isAutoScalable	back to summary
public boolean isAutoScalable() Overrides default org.eclipse.swt.graphics.Drawable.isAutoScalable. Doc from org.eclipse.swt.graphics.Drawable.isAutoScalable. Returns `true` iff coordinates can be auto-scaled on this drawable and `false` if not. E.g. a `GC` method should not auto-scale the bounds of a figure drawn on a Printer device, but it may have to auto-scale when drawing on a high-DPI Display monitor. Returns:boolean `true` if auto-scaling is enabled for this drawable Annotations @Override

public boolean isAutoScalable()

Overrides default org.eclipse.swt.graphics.Drawable.isAutoScalable.

Doc from org.eclipse.swt.graphics.Drawable.isAutoScalable.

Returns true iff coordinates can be auto-scaled on this drawable and false if not. E.g. a GC method should not auto-scale the bounds of a figure drawn on a Printer device, but it may have to auto-scale when drawing on a high-DPI Display monitor.

Returns:boolean

true if auto-scaling is enabled for this drawable

Annotations

@Override

printerDataFromGtkPrinter	back to summary
pack-priv static PrinterData printerDataFromGtkPrinter(long printer)

restore	back to summary
pack-priv static void restore(byte[] data, long settings, long page_setup)

restoreBoolean	back to summary
pack-priv static boolean restoreBoolean(String key)

restoreBytes	back to summary
pack-priv static byte[] restoreBytes(String key, boolean nullTerminate)

restoreDouble	back to summary
pack-priv static double restoreDouble(String key)

restoreInt	back to summary
pack-priv static int restoreInt(String key)

startJob back to summary

public boolean startJob(String jobName)

Starts a print job and returns true if the job started successfully and false otherwise.

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.

Parameters

jobName:String: the name of the print job to start

Returns:boolean

true if the job started successfully and false otherwise.

Exceptions

SWTException:

ERROR_DEVICE_DISPOSED - if the receiver has been disposed

See Also

startPage, endPage, endJob

startPage back to summary

public boolean startPage()

Starts a page and returns true if the page started successfully and false otherwise.

After calling startJob, this method may be called any number of times along with a matching endPage.

Returns:boolean

true if the page started successfully and false otherwise.

Exceptions

SWTException:

ERROR_DEVICE_DISPOSED - if the receiver has been disposed

See Also

endPage, startJob, endJob

uriFromFilename	back to summary
pack-priv static byte[] uriFromFilename(String filename)

public final Class Printer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail