Package apple.pdfkit

Class PDFPage

    • Constructor Detail

      • PDFPage

        protected PDFPage​(org.moe.natj.general.Pointer peer)

    • Method Detail

      • accessInstanceVariablesDirectly

        public static boolean accessInstanceVariablesDirectly()

      • addAnnotation

        public void addAnnotation​(@NotNull
                          @NotNull PDFAnnotation annotation)
        Methods allowing annotations to be added or removed.

      • alloc

        public static PDFPage alloc()

      • allocWithZone

        public static PDFPage allocWithZone​(org.moe.natj.general.ptr.VoidPtr zone)

      • annotationAtPoint

        @Nullable
public @Nullable PDFAnnotation annotationAtPoint​(CGPoint point)
        Hit-testing method returns the annotation at point (or NULL if none). The point is in page-space.

      • annotations

        @NotNull
public @NotNull NSArray<? extends PDFAnnotation> annotations()
        Array of all PDFAnnotation objects on this page.

      • automaticallyNotifiesObserversForKey

        public static boolean automaticallyNotifiesObserversForKey​(@NotNull
                                                           @NotNull java.lang.String key)

      • boundsForBox

        public CGRect boundsForBox​(long box)
        The bounds for the specified box (see defines above). Only the media box is required for a PDF. If the crop box is requested and not present in the PDF, the media box is returned. If other boxes are requested and not present, the value for the crop box is returned. Throws a range exception if box is not in range. Coordinates for the box are in page space - you may need to transform the points if the page has a rotation on it. Also, note that the bounds returned are intersected with the page's media box.

      • cancelPreviousPerformRequestsWithTarget

        public static void cancelPreviousPerformRequestsWithTarget​(@NotNull
                                                           @NotNull java.lang.Object aTarget)

      • cancelPreviousPerformRequestsWithTargetSelectorObject

        public static void cancelPreviousPerformRequestsWithTargetSelectorObject​(@NotNull
                                                                         @NotNull java.lang.Object aTarget,
                                                                         @NotNull
                                                                         @NotNull org.moe.natj.objc.SEL aSelector,
                                                                         @Nullable
                                                                         @Nullable java.lang.Object anArgument)

      • characterBoundsAtIndex

        public CGRect characterBoundsAtIndex​(long index)
        Returns the bounds in page-space, of the character at index.

      • characterIndexAtPoint

        public long characterIndexAtPoint​(CGPoint point)
        Returns the index of the character at point (in page space). Returns the index of the first character if multiple characters are at this point. Returns NSNotFound if no character at point. Earlier version of PDFKit (prior to Lion) returned -1 if no character at point.

      • classFallbacksForKeyedArchiver

        @NotNull
public static @NotNull NSArray<java.lang.String> classFallbacksForKeyedArchiver()

      • classForKeyedUnarchiver

        @NotNull
public static @NotNull org.moe.natj.objc.Class classForKeyedUnarchiver()

      • copyWithZone

        @NotNull
public @NotNull java.lang.Object copyWithZone​(@Nullable
                                              @Nullable org.moe.natj.general.ptr.VoidPtr zone)
        Specified by:
        copyWithZone in interface NSCopying

      • dataRepresentation

        @Nullable
public @Nullable NSData dataRepresentation()
        Returns PDF data (a proper PDF document) consisting of a single page (this page). NOTE: External page links are not preserved. NOTE: Versions of PDFKit before SnowLeopard did not return autorelease data for -[dataRepresentation]. You had to release the data yourself. Beginning with apps compiled on SnowLeopard the data returned is autoreleased.

      • debugDescription_static

        public static java.lang.String debugDescription_static()

      • description_static

        public static java.lang.String description_static()

      • displaysAnnotations

        public boolean displaysAnnotations()
        Method to turn on or off the display of annotations when the page is drawn.

      • document

        @Nullable
public @Nullable PDFDocument document()
        The PDFDocument the page is associated with.

      • drawWithBoxToContext

        public void drawWithBoxToContext​(long box,
                                 @NotNull
                                 @NotNull CGContextRef context)
        Drawing method takes into account page rotation, draws in page space relative to and clipped to the box bounds. If -[displaysAnnotations] is true, also draws any page annotations. Does not clear the background (page white). API-Since: 11.0

      • hash_static

        public static long hash_static()

      • init

        public PDFPage init()
        For subclassers, just call the standard -(id) init. Note: -[PDFPage init] creates a new empty page with a media box set to (0.0, 0.0), [612.0, 792.0].
        Overrides:
        init in class NSObject

      • initWithImage

        public PDFPage initWithImage​(@NotNull
                             @NotNull UIImage image)
        Returns a PDFPage for the given image. Equivalent to initWithImage:options: with empty options API-Since: 11.0

      • instanceMethodSignatureForSelector

        public static NSMethodSignature instanceMethodSignatureForSelector​(org.moe.natj.objc.SEL aSelector)

      • instancesRespondToSelector

        public static boolean instancesRespondToSelector​(org.moe.natj.objc.SEL aSelector)

      • isSubclassOfClass

        public static boolean isSubclassOfClass​(org.moe.natj.objc.Class aClass)

      • keyPathsForValuesAffectingValueForKey

        @NotNull
public static @NotNull NSSet<java.lang.String> keyPathsForValuesAffectingValueForKey​(@NotNull
                                                                                     @NotNull java.lang.String key)

      • label

        @Nullable
public @Nullable java.lang.String label()
        The page label. Usually "1" for the first page, "2" for the second, etc.

      • new_objc

        public static PDFPage new_objc()

      • numberOfCharacters

        public long numberOfCharacters()
        Number of characters on the page (including linefeeds and spaces inserted).

      • pageRef

        @Nullable
public @Nullable CGPDFPageRef pageRef()
        This is the CGPDFPage associated with the PDFPage object. With this object you can call many CoreGraphics API methods. May return NULL if the owning document was not created from an existing PDF file or data or if the page itself was created independently.

      • removeAnnotation

        public void removeAnnotation​(@NotNull
                             @NotNull PDFAnnotation annotation)

      • resolveClassMethod

        public static boolean resolveClassMethod​(org.moe.natj.objc.SEL sel)

      • resolveInstanceMethod

        public static boolean resolveInstanceMethod​(org.moe.natj.objc.SEL sel)

      • rotation

        public long rotation()
        Rotation on a page. Must be 0, 90, 180 or 270 (negative rotations will be "normalized" to one of 0, 90, 180 or 270). Some PDF's have an inherent rotation and so -[rotation] may be non-zero when a PDF is first opened.

      • selectionForLineAtPoint

        @Nullable
public @Nullable PDFSelection selectionForLineAtPoint​(CGPoint point)
        Given a point in page-space, returns a selection representing a whole line at that point. May return NULL if no character (and by extension no line) under point.

      • selectionForRange

        @Nullable
public @Nullable PDFSelection selectionForRange​(NSRange range)
        Given a range, returns a selection representing text within that range. Will clamp any range that goes out of bounds. Will return NULL for an empty selection.

      • selectionForRect

        @Nullable
public @Nullable PDFSelection selectionForRect​(CGRect rect)
        Given a rect in page-space, returns a selection representing enclosed text on page.

      • selectionForWordAtPoint

        @Nullable
public @Nullable PDFSelection selectionForWordAtPoint​(CGPoint point)
        Given a point in page-space, returns a selection representing a whole word at that point. May return NULL if no character (and by extension no word) under point. If data dectors are enabled (-[PDFView enableDataDetectors]), this return the smart-selection for the content at the given point.

      • selectionFromPointToPoint

        @Nullable
public @Nullable PDFSelection selectionFromPointToPoint​(CGPoint startPoint,
                                                        CGPoint endPoint)
        Returns a selection representing text between startPt and endPt. Points are sorted first top to bottom, left to right.

      • setBoundsForBox

        public void setBoundsForBox​(CGRect bounds,
                            long box)
        Set bounds for the specified box. If the specified box did not previously exist, it will now. To remove a box pass NSZeroRect for the bounds (you cannot however remove the media box). Throws a range exception if box is not in range.

      • setDisplaysAnnotations

        public void setDisplaysAnnotations​(boolean value)
        Method to turn on or off the display of annotations when the page is drawn.

      • setRotation

        public void setRotation​(long value)
        Rotation on a page. Must be 0, 90, 180 or 270 (negative rotations will be "normalized" to one of 0, 90, 180 or 270). Some PDF's have an inherent rotation and so -[rotation] may be non-zero when a PDF is first opened.

      • setVersion_static

        public static void setVersion_static​(long aVersion)

      • string

        @Nullable
public @Nullable java.lang.String string()
        String (with linefeeds and in some cases spaces inserted) representing the text on the page.

      • superclass_static

        public static org.moe.natj.objc.Class superclass_static()

      • thumbnailOfSizeForBox

        @NotNull
public @NotNull UIImage thumbnailOfSizeForBox​(CGSize size,
                                              long box)
        Convenience function that returns an image of this page, with annotations, that fits the given size. Note that the produced image is "size to fit": it retains the original page aspect-ratio. The size you give may not match the size of the returned image, but the returned image is guaranteed to be equal or less. API-Since: 11.0

      • transformContextForBox

        public void transformContextForBox​(@NotNull
                                   @NotNull CGContextRef context,
                                   long box)
        Given a display box, will transform the given context to take into account the rotation of the page as well as the origin of the box with respect to the page's base coordinates system. This is a convenience method to call from within -[PDFView drawPage:toContext:] or -[PDFAnnotation drawWithBox:inContext:]. API-Since: 11.0

      • transformForBox

        public CGAffineTransform transformForBox​(long box)
        This transform correctly rotates and offsets based on the given page's rotation property and the display box type. API-Since: 11.0

      • version_static

        public static long version_static()

      • initWithImageOptions

        public PDFPage initWithImageOptions​(@NotNull
                                    @NotNull UIImage image,
                                    @NotNull
                                    @NotNull NSDictionary<java.lang.String,​?> options)
        Returns a PDFPage for the given image, using the given options API-Since: 16.0

      • useStoredAccessor

        @Deprecated
public static boolean useStoredAccessor()
        Deprecated.