PDFBorder Class Reference

Inherits from
NSObject
Conforms to
NSCopying
NSObject (NSObject)
Framework
Library/Frameworks/Quartz.framework/Frameworks/PDFKit.framework
Availability
Available in OS X v10.4 and later.
Declared in
PDFBorder.h
Related sample code

Overview

A PDFBorder object, when used, adds an optional border to an annotation. Borders are drawn completely within the annotation rectangle.

Tasks

Working with Border Styles and Characteristics

Drawing Borders

Instance Methods

dashPattern

Gets the dash pattern for the border as an array of NSNumber objects.

- (NSArray *)dashPattern
Discussion

Refer to the description for NSBezierPath for more information.

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

drawInRect:

Draws the border.

- (void)drawInRect:(NSRect)rect
Availability
  • Available in OS X v10.4 and later.
Declared In
PDFBorder.h

horizontalCornerRadius

Gets the horizontal corner radius (in points) used for a rounded-rectangle border.

- (float)horizontalCornerRadius
Availability
  • Available in OS X v10.4 and later.
See Also
Declared In
PDFBorder.h

lineWidth

Gets the line width for the border, in points.

- (float)lineWidth
Availability
  • Available in OS X v10.4 and later.
See Also
Related Sample Code
Declared In
PDFBorder.h

setDashPattern:

Sets the dash pattern for the border.

- (void)setDashPattern:(NSArray *)pattern
Discussion

Provide pattern as an array of NSNumber objects. Refer to the description for NSBezierPath for more information.

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

setHorizontalCornerRadius:

Sets the horizontal corner radius (in points) used for a rounded-rectangle border.

- (void)setHorizontalCornerRadius:(float)radius
Availability
  • Available in OS X v10.4 and later.
See Also
Declared In
PDFBorder.h

setLineWidth:

Sets the line width (in points) for the border.

- (void)setLineWidth:(float)width
Availability
  • Available in OS X v10.4 and later.
See Also
Related Sample Code
Declared In
PDFBorder.h

setStyle:

Sets the border style.

- (void)setStyle:(PDFBorderStyle)style
Discussion

Refer to “Constants” for the available border styles.

Availability
  • Available in OS X v10.4 and later.
See Also
Related Sample Code
Declared In
PDFBorder.h

setVerticalCornerRadius:

Sets the vertical corner radius (in points) used for a rounded-rectangle border.

- (void)setVerticalCornerRadius:(float)radius
Availability
  • Available in OS X v10.4 and later.
See Also
Declared In
PDFBorder.h

style

Gets the border style.

- (PDFBorderStyle)style
Discussion

See “Constants” for possible return values.

Availability
  • Available in OS X v10.4 and later.
See Also
Related Sample Code
Declared In
PDFBorder.h

verticalCornerRadius

Gets the vertical corner radius used for a rounded-rectangle border, in points.

- (float)verticalCornerRadius
Availability
  • Available in OS X v10.4 and later.
See Also
Declared In
PDFBorder.h

Constants

PDF Kit annotation borders may have the following styles:

Constant

Description

kPDFBorderStyleSolid

Solid border.

Available in OS X v10.4 and later.

Declared in PDFBorder.h.

kPDFBorderStyleDashed

Dashed border.

Available in OS X v10.4 and later.

Declared in PDFBorder.h.

kPDFBorderStyleBeveled

Beveled border.

Available in OS X v10.4 and later.

Declared in PDFBorder.h.

kPDFBorderStyleInset

Inset border.

Available in OS X v10.4 and later.

Declared in PDFBorder.h.

kPDFBorderStyleUnderline

Underline border.

Available in OS X v10.4 and later.

Declared in PDFBorder.h.



© 2006 Apple Computer, Inc. All Rights Reserved. (Last updated: 2006-05-23)

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