Mac OS X Reference Library Apple Developer Connection spyglass button

PDFAnnotationLine Class Reference

Inherits from
Conforms to
Framework
Library/Frameworks/Quartz.framework/Frameworks/PDFKit.framework
Availability
Available in Mac OS X v10.4 and later.
Declared in
PDFAnnotationLine.h
Related sample code

Overview

A PDFAnnotationLine object displays a single line on a page.

The setLineWidth: and setStyle: methods of the annotation’s associated PDFBorder object determines the stroke thickness and style. The setColor: method of the PDFAnnotation class determines the stroke color.

Tasks

Specifying the Starting and Ending Points

Specifying the Line Ending Styles

Specifying the Color of Line-end Ornaments

Instance Methods

endLineStyle

Returns the line ending style for the ending point of the line.

- (PDFLineStyle)endLineStyle

Return Value

The line ending style for the ending point of the line.

Availability
  • Available in Mac OS X v10.4 and later.
See Also
Declared In
PDFAnnotationLine.h

endPoint

Returns the ending point for the line in page space.

- (NSPoint)endPoint

Return Value

The ending point for the line, in page space.

Discussion

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

Availability
  • Available in Mac OS X v10.4 and later.
See Also
Declared In
PDFAnnotationLine.h

interiorColor

Returns the color used to fill the ornament at the ends of the line.

- (NSColor *) interiorColor

Return Value

The color used in the line-end ornament at the ends of the line.

Availability
  • Available in Mac OS X v10.5 and later.
Declared In
PDFAnnotationLine.h

setEndLineStyle:

Sets the line ending style for the ending point of the line.

- (void)setEndLineStyle:(PDFLineStyle)style

Parameters
style

The line ending style for the ending point of the line.

Availability
  • Available in Mac OS X v10.4 and later.
See Also
Declared In
PDFAnnotationLine.h

setEndPoint:

Sets the ending point for the line.

- (void)setEndPoint:(NSPoint)point

Parameters
point

The ending point for the line, in page space.

Discussion

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

Availability
  • Available in Mac OS X v10.4 and later.
See Also
Declared In
PDFAnnotationLine.h

setInteriorColor:

Sets the color used to fill the ornament at the ends of the line.

- (void)setInteriorColor:(NSColor *)color

Parameters
color

The color to be used to fill in the ornament at the ends of the line.

Discussion

The ornament at the end of a line is optional (for more information, see the Adobe PDF Specification 1.4).

Availability
  • Available in Mac OS X v10.5 and later.
Declared In
PDFAnnotationLine.h

setStartLineStyle:

Sets the line ending style for the starting point of the line.

- (void)setStartLineStyle:(PDFLineStyle)style

Parameters
style

Availability
  • Available in Mac OS X v10.4 and later.
See Also
Declared In
PDFAnnotationLine.h

setStartPoint:

Sets the starting point for the line.

- (void)setStartPoint:(NSPoint)point

Parameters
point

The starting point for the line, in page space.

Discussion

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

Availability
  • Available in Mac OS X v10.4 and later.
See Also
Declared In
PDFAnnotationLine.h

startLineStyle

Returns the line ending style for the starting point of the line.

- (PDFLineStyle)startLineStyle

Return Value

The line ending style for the starting point of the line.

Availability
  • Available in Mac OS X v10.4 and later.
See Also
Declared In
PDFAnnotationLine.h

startPoint

Returns the starting point for the line.

- (NSPoint)startPoint

Return Value

The starting point for the line, in page space.

Discussion

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

Availability
  • Available in Mac OS X v10.4 and later.
See Also
Declared In
PDFAnnotationLine.h

Constants

The following constants specify the available line ending styles:

Constant

Description

kPDFLineStyleNone

No line ending.

Available in Mac OS X v10.4 and later.

Declared in PDFAnnotationLine.h.

kPDFLineStyleSquare

A square line ending filled with the annotation’s interior color, if any.

Available in Mac OS X v10.4 and later.

Declared in PDFAnnotationLine.h.

kPDFLineStyleCircle

A circular line ending filled with the annotation’s interior color, if any.

Available in Mac OS X v10.4 and later.

Declared in PDFAnnotationLine.h.

kPDFLineStyleDiamond

A diamond-shaped line ending filled with the annotation’s interior color, if any.

Available in Mac OS X v10.4 and later.

Declared in PDFAnnotationLine.h.

kPDFLineStyleOpenArrow

An open arrowhead line ending, composed from two short lines meeting in an acute angle at the line end.

Available in Mac OS X v10.4 and later.

Declared in PDFAnnotationLine.h.

kPDFLineStyleClosedArrow

A closed arrowhead line ending, consisting of a triangle with the acute vertex at the line end and filled with the annotation’s interior color, if any.

Available in Mac OS X v10.4 and later.

Declared in PDFAnnotationLine.h.



Last updated: 2007-12-11

Did this document help you? Yes It's good, but... Not helpful...