PDFView Class Reference

Instance Methods

allowsDragging

Determines whether the view can accept new PDF documents dragged into it by the user.

- (BOOL)allowsDragging

See Also

• – setAllowsDragging:

annotationsChangedOnPage:

Tells the PDF view that an annotation on the specified page has changed.

- (void)annotationsChangedOnPage:(PDFPage *)page

Discussion

When the PDFView object receives this message, it rescans for tool tips and pop-ups and informs the PDFThumbailView objects so the thumbnail images can be redrawn.

areaOfInterestForMouse:

Returns the type of area the mouse cursor is over.

- (PDFAreaOfInterest)areaOfInterestForMouse:(NSEvent *)theEvent

Discussion

The PDFAreaOfInterest enumeration defines the various area types. This method is for custom subclasses of the PDFView class. Use it if you override the NSResponder class’s mouseMoved: method or related methods.

Refer to “Constants” for the various values of the area-of-interest constants. Each of these constants contributes to the value of the PDFAreaOfInterest bit field.

See Also

• – setCursorForAreaOfInterest:

autoScales

Returns a Boolean value indicating whether autoscaling is set.

- (BOOL)autoScales

See Also

• – setAutoScales:

backgroundColor

Returns the view’s background color.

- (NSColor *)backgroundColor

Discussion

A view’s background is the area displayed to either side of a PDF document’s pages. The background also appears between pages when page breaks are enabled. The default color is a 50% gray.

See Also

• – takeBackgroundColorFrom:
• – setBackgroundColor:

canGoBack

Returns a Boolean value indicating whether the user can navigate to the previous page in the page history.

- (BOOL)canGoBack

Discussion

The page history gets built as your application calls navigation methods such as goToDestination: and goToLastPage:.

See Also

• – goBack:

Related Sample Code

• PDFKitLinker2

canGoForward

Returns a Boolean value indicating whether the user can navigate to the next page in the page history.

- (BOOL)canGoForward

Discussion

The page history gets built as your application calls navigation methods such as goToDestination: and goToLastPage:.

See Also

• – goForward:

Related Sample Code

• PDFKitLinker2

canGoToFirstPage

Returns a Boolean value indicating whether the user can navigate to the first page of the document.

- (BOOL)canGoToFirstPage

Discussion

The return value will be YES unless the view is already displaying the first page.

See Also

• – goToFirstPage:

canGoToLastPage

Returns a Boolean value indicating whether the user can navigate to the last page of the document.

- (BOOL)canGoToLastPage

Discussion

The return value will be YES unless the view is already displaying the last page.

See Also

• – goToLastPage:

canGoToNextPage

Returns a Boolean value indicating whether the user can navigate to the next page of the document.

- (BOOL)canGoToNextPage

Discussion

The return value will be YES unless the view is displaying the last page.

See Also

• – goToNextPage:

canGoToPreviousPage

Returns a Boolean value indicating whether the user can navigate to the previous page of the document.

- (BOOL)canGoToPreviousPage

Discussion

The return value will be YES unless the view is displaying the first page.

See Also

• – canGoToPreviousPage

canZoomIn

Returns a Boolean value indicating whether the user can magnify the view—that is, zoom in.

- (BOOL)canZoomIn

See Also

• – zoomIn:
• – zoomOut:
• – canZoomOut

canZoomOut

Returns a Boolean value indicating whether the user can view an expanded area—that is, zoom out.

- (BOOL)canZoomOut

See Also

• – zoomIn:
• – canZoomIn
• – zoomOut:

clearSelection

Clears the selection.

- (void)clearSelection

Discussion

The view redraws as necessary but does not scroll. This call is equivalent to calling [PDFView setCurrentSelection:NULL].

See Also

• – currentSelection,
• – setCurrentSelection:

convertPoint:fromPage:

Converts a point from page space to view space.

- (NSPoint)convertPoint:(NSPoint)point fromPage:(PDFPage *)page

Discussion

Page space is a 72 dpi coordinate system with the origin at the lower-left corner of the current page. View space is a coordinate system with the origin at the lower-left corner of the current PDF view.

See Also

• – convertPoint:toPage:
• – convertRect:toPage:
• – convertRect:fromPage:
• – pageForPoint:nearest:

convertPoint:toPage:

Converts a point from view space to page space.

- (NSPoint)convertPoint:(NSPoint)point toPage:(PDFPage *)page

Discussion

Page space is a 72 dpi coordinate system with the origin at the lower-left corner of the current page. View space is a coordinate system with the origin at the lower-left corner of the current PDF view.

See Also

• – convertRect:toPage:
• – convertPoint:fromPage:
• – convertRect:fromPage:

Related Sample Code

• PDFKitLinker2

convertRect:fromPage:

Converts a rectangle from page space to view space.

- (NSRect)convertRect:(NSRect)rect fromPage:(PDFPage *)page

Discussion

Page space is a 72 dpi coordinate system with the origin at the lower-left corner of the current page. View space is a coordinate system with the origin at the lower-left corner of the current PDF view.

See Also

• – convertPoint:toPage:
• – convertRect:toPage:
• – convertPoint:fromPage:

Related Sample Code

• PDF Annotation Editor
• PDFKitLinker2

convertRect:toPage:

Converts a rectangle from view space to page space.

- (NSRect)convertRect:(NSRect)rect toPage:(PDFPage *)page

Discussion

Page space is a 72 dpi coordinate system with the origin at the lower-left corner of the current page. View space is a coordinate system with the origin at the lower-left corner of the current PDF view.

See Also

• – convertPoint:toPage:
• – convertPoint:fromPage:
• – convertRect:fromPage:

copy:

Copies the text in the selection, if any, to the Pasteboard.

- (void)copy:(id)sender

See Also

• – currentSelection

currentDestination

Returns a PDFDestination object representing the current page and the current point in the view specified in page space.

- (PDFDestination *)currentDestination

Discussion

Page space is a 72 dpi coordinate system with the origin at the lower-left corner of the current page.

See Also

• – currentPage
• – goToDestination: (PDFDestination)

currentPage

Returns the current page.

- (PDFPage *)currentPage

Discussion

When there are two pages in the view in a two-up mode, “current page” is the left page. For continuous modes, returns the page crossing a horizontal line halfway between the view’s top and bottom bounds.

See Also

• – currentDestination
• – goToDestination:

Related Sample Code

• PDFKitLinker2

currentSelection

Returns the current selection.

- (PDFSelection *)currentSelection

Discussion

Returns NULL if no selection exists.

Note that this method returns the actual instance of the current PDFSelection object. Therefore, if you want to modify it, you should make a copy of the returned selection and modify that, instead.

See Also

• – setCurrentSelection:
• – clearSelection

Related Sample Code

• PDFKitLinker2

delegate

Returns the view’s delegate.

- (id)delegate

See Also

• – setDelegate:

displayBox

Returns the current style of display box.

- (PDFDisplayBox)displayBox

Discussion

The available values for display boxes are defined in the Constants section in the PDFPage class.

See Also

• – setDisplayBox:

Related Sample Code

• Link Snoop
• PDF Annotation Editor
• PDFKitLinker2

displayMode

Returns the current display mode.

- (PDFDisplayMode)displayMode

Discussion

See “Constants” for possible values.

See Also

• – setDisplayMode:

displaysAsBook

Returns a Boolean value indicating whether the view will display the first page as a book cover (meaningful only when the document is in two-up or two-up continuous display mode).

- (BOOL)displaysAsBook

See Also

• – setDisplaysAsBook:

displaysPageBreaks

Returns a Boolean value indicating whether the view is displaying page breaks.

- (BOOL)displaysPageBreaks

See Also

• – setDisplaysPageBreaks:

document

Returns the document associated with a PDFView object.

- (PDFDocument *)document

See Also

• – setDocument:

Related Sample Code

• PDF Annotation Editor
• PDFKitLinker2

documentView

Returns the innermost view used by PDFView or by your PDFView subclass.

- (NSView *)documentView

Discussion

The innermost view is the one displaying the visible document pages. This method is useful when converting coordinates from one view to another.

See Also

• – layoutDocumentView

drawPage:

For use by subclasses of PDFView for custom rendering of pages.

- (void)drawPage:(PDFPage *)page

Discussion

Do not invoke this method, except by invoking it on super from a subclass.

The PDFView class calls drawPage: as necessary for each visible page that requires rendering. In the PDFView class, this method erases page to white, calls [page drawInRect: pageRect withBox: [self displayBox]] , and then draws the selection, if any.

You can override this method to draw on top of a PDF page or to control how pages are drawn. In these cases, invoke this method on super and then perform custom drawing on top of the PDF page.

drawPagePost:

For use by subclasses of PDFView for post-page rendering.

- (void)drawPagePost:(PDFPage *)page

Discussion

The default implementation of this method draws the text highlighting (if any) for the page. This method does not apply scaling or rotating to the current context to map to page space; instead, the context is in view-space coordinates (in which the origin is at the lower-left corner of the current PDF view).

goBack:

Navigates back one step in the page history.

- (IBAction)goBack:(id)sender

Discussion

The page history gets built as your application calls navigation methods such as goToDestination: and goToLastPage:.

See Also

• – canGoBack

Related Sample Code

• PDFKitLinker2

goForward:

Navigates forward one step in the page history.

- (IBAction)goForward:(id)sender

Discussion

The page history gets built as your application calls navigation methods such as goToDestination: and goToLastPage:.

See Also

• – canGoForward

Related Sample Code

• PDFKitLinker2

goToDestination:

Navigates to the specified destination.

- (void)goToDestination:(PDFDestination *)destination

Discussion

Destinations include a page and a point on the page specified in page space.

Page space is a 72 dpi coordinate system with the origin at the lower-left corner of the current page.

See Also

• – currentDestination (PDFDestination)
• – currentPage

goToFirstPage:

Navigates to the first page of the document.

- (IBAction)goToFirstPage:(id)sender

Discussion

PDF Kit records the move in its page history.

See Also

• – canGoToFirstPage

goToLastPage:

Navigates to the last page of the document.

- (IBAction)goToLastPage:(id)sender

Discussion

PDF Kit records the move in its page history.

See Also

• – canGoToLastPage

goToNextPage:

Navigates to the next page of the document.

- (IBAction)goToNextPage:(id)sender

Discussion

PDF Kit records the move in its page history.

See Also

• – canGoToNextPage

Related Sample Code

• PDFKitLinker2

goToPage:

Scrolls to the specified page.

- (void)goToPage:(PDFPage *)page

Discussion

PDF Kit records the move in its page history.

Related Sample Code

• PDFKitLinker2

goToPreviousPage:

Navigates to the previous page of the document.

- (IBAction)goToPreviousPage:(id)sender

Discussion

PDF Kit records the move in its page history.

See Also

• – canGoToPreviousPage

Related Sample Code

• PDFKitLinker2

goToRect:onPage:

Navigates to the specified rectangle on the specified page.

- (void)goToRect:(NSRect)rect onPage:(PDFPage *)page

Discussion

If the specified rectangle is already visible, this method does nothing. This allows you to scroll the PDFView object to a specific PDFAnnotation or PDFSelection object, because both of these objects have bounds methods that return an annotation or selection position in page space.

Note that rect is specified in page-space coordinates. Page space is a 72 dpi coordinate system with the origin at the lower-left corner of the current page.

goToSelection:

Scrolls to the first character of the specified selection.

- (void)goToSelection:(PDFSelection *)selection

Discussion

PDF Kit records the move in its page history.

greekingThreshold

Returns the current greeking threshold for the view.

- (float)greekingThreshold

See Also

• – setGreekingThreshold:

highlightedSelections

Returns the array of selections that are highlighted using setHighlightedSelections.

- (NSArray *)highlightedSelections

See Also

• – setHighlightedSelections:

layoutDocumentView

Performs layout of the inner views.

- (void)layoutDocumentView

Discussion

The PDFView actually contains several subviews, such as the document view (where the PDF is actually drawn) and a “matte view” (which may appear as a gray area around the PDF content, depending on the scaling). Changes to the PDF content may require changes to these inner views, so you must call this method explicitly if you use PDF Kit utility classes to add or remove a page, rotate a page, or perform other operations affecting visible layout.

This method is called automatically from PDFView methods that affect the visible layout (such as setDocument:, setDisplayBox: or zoomIn:).

See Also

• – documentView

pageForPoint:nearest:

Returns the page containing a point specified in view coordinates.

- (PDFPage *)pageForPoint:(NSPoint)point nearest:(BOOL)nearest

Discussion

Returns NULL if there’s no page at the specified point and nearest is set to NO.

Related Sample Code

• PDFKitLinker2

performAction:

Performs the specified action.

- (void)performAction:(PDFAction *)action

printWithInfo:autoRotate:

Prints the document with the specified printer information.

- (void)printWithInfo:(NSPrintInfo *)printInfo autoRotate:(BOOL)doRotate

Discussion

If autoRotate is set to YES, then ths method ignores the orientation attribute in the NSPrintInfo object and instead chooses the orientation that best fits the page to the paper size. This orientation occurs on a page-by-page basis.

See Also

• – printWithInfo:autoRotate:pageScaling:

Related Sample Code

• PDFKitLinker2

printWithInfo:autoRotate:pageScaling:

Prints the document with the specified printer and page-scaling information.

- (void)printWithInfo:(NSPrintInfo *)printInfo autoRotate:(BOOL)doRotate pageScaling:(PDFPrintScalingMode)scale

Discussion

If pageScaling is set to kPDFPrintPageScaleToFit, each page is scaled up or down to best fit the paper size. If pageScaling is set to kPDFPrintPageScaleDownToFit, only large pages are scaled down to fit; small pages are not scaled up to fit. Specifying kPDFPrintPageScaleNone for pageScaling is equivalent to calling printWithInfo:autoRotate:. See PDFDocument for more information on page-scaling types.

See Also

• – printWithInfo:autoRotate:

rowSizeForPage:

Returns the size needed to display a row of the current document page.

- (NSSize)rowSizeForPage:(PDFPage *)page

Discussion

The size is dependent on the current scale factor and display attributes.

scaleFactor

Returns the current scale factor for the view.

- (float)scaleFactor

See Also

• – setScaleFactor:

Related Sample Code

• PDF Annotation Editor
• PDFKitLinker2

scrollSelectionToVisible:

Scrolls the view until the selection is visible.

- (void)scrollSelectionToVisible:(id)sender

Related Sample Code

• PDFKitLinker2

selectAll:

Selects all text in the document.

- (IBAction)selectAll:(id)sender

setAllowsDragging:

Specifies whether the view can accept drags.

- (void)setAllowsDragging:(BOOL)allow

Discussion

If set to YES, the user can drag a new PDF document into the view. The new document is then displayed in the view, and the old document is released.

See Also

• – allowsDragging

setAutoScales:

Toggles whether the scaling factor applied to a view automatically responds to resizing.

- (void)setAutoScales:(BOOL)newAuto

Discussion

When set to autoscaling, the document scales to fill the PDFView object as the user resizes it.

For the single-page and two-up continuous modes, autoscaling fits the page to the width of the view. For single-page and two-up noncontinuous modes, autoscaling provides best fit, in which the viewed pages are as large as possible while displaying in their entirety within the view.

See Also

• – autoScales

setBackgroundColor:

Sets the view’s background color.

- (void)setBackgroundColor:(NSColor *)newColor

Discussion

A view’s background is the area displayed to either side of a PDF document’s pages. The background also appears between pages when page breaks are enabled. The default color is a 50% gray.

See Also

• – takeBackgroundColorFrom:
• – backgroundColor

setCurrentSelection:

Sets the selection.

- (void)setCurrentSelection:(PDFSelection *)selection

Discussion

The view redraws as necessary but does not scroll. If you need to scroll to the current selection, use scrollSelectionToVisible:. If you pass nil for the selection, this call is equivalent to calling clearSelection.

See Also

• – setCurrentSelection:animate:
• – currentSelection
• – clearSelection

Related Sample Code

• PDFKitLinker2

setCurrentSelection:animate:

Sets the selection, in an animated way, if desired.

- (void)setCurrentSelection:(PDFSelection *)selection animate:(BOOL)animate

Discussion

This method behaves as setCurrentSelection:, but with the addition of animation, if animate is YES. The animation serves to draw the user’s attention to the new selection, which can be useful when implementing search.

See Also

• – setCurrentSelection:
• – clearSelection

setCursorForAreaOfInterest:

Sets the type of mouse cursor according to the type of area the mouse cursor is over.

- (void)setCursorForAreaOfInterest:(PDFAreaOfInterest)area

Discussion

This method is especially useful for custom subclasses of the PDFView class.

See Also

• – areaOfInterestForMouse:

setDelegate:

Sets a delegate for the view.

- (void)setDelegate:(id)anObject

See Also

• – delegate

setDisplayBox:

Specifies the box to display and to clip to.

- (void)setDisplayBox:(PDFDisplayBox)box

Discussion

The values for box are defined in the PDFDisplayBox enumeration. The default value for this method is kPDFDisplayBoxCropBox.

The available values for display boxes are defined in the Constants section in the PDFPage class.

See Also

• – displayBox

setDisplayMode:

Sets the display mode for the view.

- (void)setDisplayMode:(PDFDisplayMode)mode

Discussion

Available display modes are single page, single-page continuous, two-up, and two-up continuous, as defined in “Constants.”

See Also

• – displayMode

Related Sample Code

• PDFKitLinker2

setDisplaysAsBook:

Specifies whether the view should treat the document’s first page as a book cover.

- (void)setDisplaysAsBook:(BOOL)asBook

Discussion

For two-up modes, a YES value for this method specifies that the first page should be displayed by itself.

See Also

• – displaysAsBook

setDisplaysPageBreaks:

Toggles the display of page breaks.

- (void)setDisplaysPageBreaks:(BOOL)breaks

See Also

• – displaysPageBreaks

setDocument:

Associates a document with a PDFView object.

- (void)setDocument:(PDFDocument *)document

Discussion

If a document was already associated with the view, it is released first and then document is associated with the view.

See Also

• – document

Related Sample Code

• PDF Annotation Editor
• PDF Calendar
• PDFKitLinker2

setGreekingThreshold:

Sets the greeking threshold to use for displaying text.

- (void)setGreekingThreshold:(float)threshold

Discussion

The default threshold is 3.0.

See Also

• – greekingThreshold

setHighlightedSelections:

Highlights the specified array of selections.

- (void)setHighlightedSelections:(NSArray *)selections

Discussion

Unlike the selections users set (using, for example, setCurrentSelection:), the selections you specify in this method do not go away (that is, appear deselected) when users click elsewhere in the view or document. Instead, to deselect the selections, you must call [setHighlightedSelections:NULL] to remove them.

You might use this method to highlight the set of matches from a text search. To prevent the user from confusing their own selections with selections you set using this method, it is recommended that you use a highlight color that is different from the user’s default text selection color.

See Also

• – highlightedSelections

setScaleFactor:

Sets the scale factor for the view.

- (void)setScaleFactor:(float)scale

Discussion

The default value is 1.0, corresponding to actual size.

See Also

• – scaleFactor

setShouldAntiAlias:

Specifies whether to use anti-aliasing in the view.

- (void)setShouldAntiAlias:(BOOL)aliasing

Discussion

The default value is YES.

See Also

• – shouldAntiAlias

shouldAntiAlias

Returns a Boolean value indicating whether the view is anti-aliased.

- (BOOL)shouldAntiAlias

See Also

• – setShouldAntiAlias:

takeBackgroundColorFrom:

Sets the view’s background color to the specified color.

- (IBAction)takeBackgroundColorFrom:(id)sender

Discussion

A view’s background is the area displayed to either side of a PDF document’s pages. The background also appears between pages when page breaks are enabled. The default color is a 50% gray.

See Also

• – setBackgroundColor:
• – backgroundColor

takePasswordFrom:

A convenience method that calls – [[self document] setpassword:] with the password from the specified sender.

- (void)takePasswordFrom:(id)sender

visiblePages

Returns an array of PDFPage objects that represent the currently visible pages.

- (NSArray *)visiblePages

zoomIn:

Zooms in by increasing the scaling factor.

- (IBAction)zoomIn:(id)sender

Discussion

Each invocation of zoomIn muliplies the scaling factor by the square root of 2.

See Also

• – canZoomIn
• – zoomOut:
• – canZoomOut

zoomOut:

Zooms out by decreasing the scaling factor.

- (IBAction)zoomOut:(id)sender

Discussion

Each invocation of zoomOut divides the scaling factor by the square root of 2.

See Also

• – zoomIn:
• – canZoomIn
• – canZoomOut