---

PDFAnnotationText Class Reference

Overview

A PDFAnnotationText object displays as an icon (such as a “sticky note”) attached to a specified point in the PDF document.

Each PDFAnnotationText object has a PDFAnnotationPopup object associated with it. In its closed state, the annotation appears as an icon. In its open state, it displays as a pop-up window containing the text of the note. Note that your application must do the work to put up a window containing the text in response to a PDFViewAnnotationHitNotification. Currently, text annotations do not scale and rotate with the page.

Tasks

Managing the Annotation’s State

• – windowIsOpen
• – setWindowIsOpen:

Managing the Annotation Icon’s Type

• – iconType
• – setIconType:

Instance Methods

iconType

Returns the icon type for the annotation.

- (PDFTextAnnotationIconType)iconType

Return Value

The icon type of the annotation. See “Constants” for a list of possible return values.

Availability

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

See Also

• – setIconType:

Declared In

PDFAnnotationText.h

setIconType:

Sets the icon type for the annotation.

- (void)setIconType:(PDFTextAnnotationIconType)type

Parameters

type

The icon type for the annotation. See “Constants” for a list of the available icon types.

Availability

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

See Also

• – iconType

Declared In

PDFAnnotationText.h

setWindowIsOpen:

Sets the open/closed state of the annotation to the specified value. (Deprecated. Call setIsOpen: on the annotation’s pop-up instead.)

- (void)setWindowIsOpen:(BOOL)isOpen

Discussion

This method does not actually open or close the annotation. Use it to record annotation state.

Availability

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

See Also

• – windowIsOpen

Declared In

PDFAnnotationText.h

windowIsOpen

Returns a Boolean value indicating whether the annotation’s note window is open. (Deprecated. Call isOpen on the annotation’s pop-up instead.)

- (BOOL)windowIsOpen

Availability

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

See Also

• – setWindowIsOpen:

Declared In

PDFAnnotationText.h

Constants

Text annotations can use the following icon types:

---