---

NSPrintInfo

Overview

An NSPrintInfo object stores information that’s used to generate output. A shared NSPrintInfo object is automatically created for an application and is used by default for all printing jobs for that application.

Tasks

Constructors

• NSPrintInfo

Managing the Shared NSPrintInfo

• setSharedPrintInfo
• sharedPrintInfo

Managing the Printing Rectangle

• bottomMargin
• imageablePageBounds
• leftMargin
• orientation
• paperName
• localizedPaperName
• paperSize
• rightMargin
• setBottomMargin
• setLeftMargin
• setOrientation
• setPaperName
• setPaperSize
• setRightMargin
• setTopMargin
• topMargin

Pagination

• horizontalPagination
• setHorizontalPagination
• setVerticalPagination
• verticalPagination

Positioning the Image on the Page

• isHorizontallyCentered
• isVerticallyCentered
• setHorizontallyCentered
• setVerticallyCentered

Specifying the Printer

• printer
• setPrinter

Controlling Printing

• jobDisposition
• setJobDisposition
• setUpPrintOperationDefaultValues

Accessing the Dictionary

• dictionary

Deprecated Methods

• defaultPrinter
• setDefaultPrinter
• sizeForPaperName

Static Methods

defaultPrinter

Deprecated.

public static NSPrinter defaultPrinter()

setDefaultPrinter

Deprecated.

public static void setDefaultPrinter(NSPrinter aPrinter)

setSharedPrintInfo

Sets the shared NSPrintInfo object to printInfo.

public static void setSharedPrintInfo(NSPrintInfo printInfo)

Discussion

The shared NSPrintInfo object defines the settings for the NSPageLayout panel and print operations that will be used if no NSPrintInfo object is specified for those operations. printInfo should never be null.

See Also

• sharedPrintInfo

sharedPrintInfo

Returns the shared NSPrintInfo object.

public static NSPrintInfo sharedPrintInfo()

See Also

• setSharedPrintInfo

sizeForPaperName

Deprecated.

public static NSSize sizeForPaperName(String name)

Discussion

Use NSPrinter’s method pageSizeForPaper instead.

Instance Methods

bottomMargin

Returns the height of the bottom margin in points.

public float bottomMargin()

See Also

• setBottomMargin

dictionary

Returns the receiver’s dictionary that stores its attribute settings

public NSMutableDictionary dictionary()

Discussion

. The key-value pairs contained in the dictionary are described in “Constants.” Modifying the returned dictionary changes the receiver’s attributes.

horizontalPagination

Returns the horizontal pagination mode.

public int horizontalPagination()

Discussion

It can return one of the pagination modes described in “Constants.”

See Also

• setVerticalPagination
• verticalPagination

imageablePageBounds

Returns the imageable area of a sheet of paper specified by the receiver, taking into account the current printer, paper size, and orientation settings, but not scaling.

public NSRect imageablePageBounds()

Discussion

“Imageable area” is the maximum area that can possibly be marked on by the printer hardware, not the area defined by the current margin settings. The rectangle is in a coordinate space measured by points, with (0, 0) being the lower-left corner of the oriented sheet and (paperWidth, paperHeight) being the upper-right corner of the oriented sheet. The imageable bounds may extend past the edges of the sheet when, for example, a printer driver specifies it so that borderless printing can be done reliably.

Availability

• Available in Mac OS X v10.2 and later.

isHorizontallyCentered

Returns true if the image is centered horizontally, false otherwise.

public boolean isHorizontallyCentered()

See Also

• isVerticallyCentered
• setHorizontallyCentered

isVerticallyCentered

Returns true if the image is centered vertically, false otherwise.

public boolean isVerticallyCentered()

See Also

• isHorizontallyCentered
• setVerticallyCentered

jobDisposition

Returns the action specified for the job.

public String jobDisposition()

Discussion

See setJobDisposition for a description of return values.

leftMargin

Returns the width of the left margin in points.

public float leftMargin()

See Also

• setLeftMargin

localizedPaperName

Returns the human-readable name of the currently selected paper size, suitable for presentation in user interfaces.

public String localizedPaperName()

Discussion

This is typically different from the name returned by paperName, which is almost never suitable for presentation to the user.

Availability

• Available in Mac OS X v10.3 and later.

orientation

Returns the orientation attribute.

public int orientation()

Discussion

See setOrientation for a description of return values.

paperName

Returns the paper name, such as Letter or Legal.

public String paperName()

Discussion

Paper names are implementation specific.

See Also

• setPaperName
• localizedPaperName

paperSize

Returns the size of the paper in points.

public NSSize paperSize()

See Also

• setPaperSize

printer

Returns the NSPrinter to be used for printing.

public NSPrinter printer()

See Also

• setPrinter

rightMargin

Returns the width of the right margin in points.

public float rightMargin()

See Also

• setRightMargin

setBottomMargin

Sets the bottom margin to margin specified in points.

public void setBottomMargin(float margin)

See Also

• bottomMargin

setHorizontallyCentered

public void setHorizontallyCentered(boolean flag)

Discussion

If flag is true the image will be centered horizontally.

See Also

• isHorizontallyCentered
• isVerticallyCentered
• setVerticallyCentered

setHorizontalPagination

Sets the horizontal pagination to mode.

public void setHorizontalPagination(int mode)

Discussion

mode can be one of the pagination modes described in “Constants.”

See Also

• horizontalPagination
• setVerticalPagination
• verticalPagination

setJobDisposition

Sets the action specified for the job to disposition.

public void setJobDisposition(String disposition)

Discussion

disposition can be one of the following:

• PrintSpoolJob is a normal print job.

• PrintPreviewJob sends the print job to the Preview application.

• PrintSaveJob saves the print job to a file.

• PrintCancelJob aborts the print job.

See Also

• jobDisposition

setLeftMargin

Sets the left margin to margin specified in points.

public void setLeftMargin(float margin)

See Also

• leftMargin

setOrientation

Sets the page orientation to orientation where orientation is either PortraitOrientation or LandscapeOrientation.

public void setOrientation(int orientation)

Discussion

This method may change either the paper name or size for consistency. To avoid this side effect set the values in the dictionary directly.

See Also

• dictionary
• orientation

setPaperName

Sets the paper name to name (for example, Letter or Legal).

public void setPaperName(String name)

Discussion

Paper names are implementation specific. This method may change either the size or orientation for consistency. To avoid this side effect set the values in the dictionary directly.

See Also

• dictionary
• paperName

setPaperSize

Sets the width and height of the paper to aSize specified in points.

public void setPaperSize(NSSize aSize)

Discussion

This method may change either the paper name or orientation for consistency. To avoid this side effect set the values in the dictionary directly.

See Also

• dictionary
• paperSize

setPrinter

Sets the printer used in subsequent printing jobs to printer.

public void setPrinter(NSPrinter printer)

Discussion

This method iterates through the dictionary. If a feature in the dictionary is not supported by the new printer (as determined by a query to the PPD file), that feature is removed from the dictionary.

See Also

• printer

setRightMargin

Sets the right margin to margin specified in points.

public void setRightMargin(float margin)

See Also

• rightMargin

setTopMargin

Sets the top margin to margin specified in points.

public void setTopMargin(float margin)

See Also

• topMargin

setUpPrintOperationDefaultValues

Validates the attributes encapsulated by the receiver.

public void setUpPrintOperationDefaultValues()

Discussion

Invoked when the print operation is about to start. Subclasses may override this method to set default values for any attributes that are not set.

setVerticallyCentered

public void setVerticallyCentered(boolean flag)

Discussion

If flag is true, the image will be vertically centered.

See Also

• isHorizontallyCentered
• isVerticallyCentered
• setHorizontallyCentered

setVerticalPagination

Sets the vertical pagination to mode.

public void setVerticalPagination(int mode)

Discussion

mode can be one of the pagination modes described in “Constants.”

See Also

• horizontalPagination
• setHorizontalPagination
• verticalPagination

topMargin

Returns the top margin in points.

public float topMargin()

See Also

• setTopMargin

verticalPagination

Returns the vertical pagination mode.

public int verticalPagination()

Discussion

It can return one of the pagination modes described in “Constants.”

See Also

• horizontalPagination
• setHorizontalPagination

Constants

These constants specify the different ways in which an image is divided into pages. They’re used by horizontalPagination, setHorizontalPagination, verticalPagination, and setVerticalPagination.

These constants specify page orientations. They’re used by orientation and setOrientation.

These constants specify job dispositions. They’re used by jobDisposition, and setJobDisposition.

The following sets of constants specify the keys in the dictionary returned by dictionary or used to create an instance.

The following dictionary keys access page setup attributes.

The following dictionary keys access pagination attributes.

The following dictionary keys access print job attributes.

---