PDFPage (moe.platform.ios API)

java.lang.Object
- org.moe.natj.general.NativeObject
- - org.moe.natj.objc.ObjCObject
  - - apple.NSObject
    - - apple.pdfkit.PDFPage

All Implemented Interfaces:: NSCopying, NSObject

public class PDFPage
extends NSObject
implements NSCopying

Nested Class Summary
- Nested classes/interfaces inherited from class apple.NSObject
  NSObject.Function_instanceMethodForSelector_ret, NSObject.Function_methodForSelector_ret

Constructor Summary

Constructors
Modifier Constructor and Description

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

Constructors
Modifier	Constructor and Description
`protected`	`PDFPage(org.moe.natj.general.Pointer peer)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static boolean`	`accessInstanceVariablesDirectly()`
`void`	`addAnnotation(PDFAnnotation annotation)` Methods allowing annotations to be added or removed.
`static PDFPage`	`alloc()`
`static PDFPage`	`allocWithZone(org.moe.natj.general.ptr.VoidPtr zone)`
`PDFAnnotation`	`annotationAtPoint(CGPoint point)` Hit-testing method returns the annotation at point (or NULL if none).
`NSArray<? extends PDFAnnotation>`	`annotations()` Array of all PDFAnnotation objects on this page.
`NSAttributedString`	`attributedString()`
`static boolean`	`automaticallyNotifiesObserversForKey(java.lang.String key)`
`CGRect`	`boundsForBox(long box)` The bounds for the specified box (see defines above).
`static void`	`cancelPreviousPerformRequestsWithTarget(java.lang.Object aTarget)`
`static void`	`cancelPreviousPerformRequestsWithTargetSelectorObject(java.lang.Object aTarget, org.moe.natj.objc.SEL aSelector, java.lang.Object anArgument)`
`CGRect`	`characterBoundsAtIndex(long index)` Returns the bounds in page-space, of the character at index.
`long`	`characterIndexAtPoint(CGPoint point)` Returns the index of the character at point (in page space).
`static NSArray<java.lang.String>`	`classFallbacksForKeyedArchiver()`
`static org.moe.natj.objc.Class`	`classForKeyedUnarchiver()`
`java.lang.Object`	`copyWithZone(org.moe.natj.general.ptr.VoidPtr zone)`
`NSData`	`dataRepresentation()` Returns PDF data (a proper PDF document) consisting of a single page (this page).
`static java.lang.String`	`debugDescription_static()`
`static java.lang.String`	`description_static()`
`boolean`	`displaysAnnotations()` Method to turn on or off the display of annotations when the page is drawn.
`PDFDocument`	`document()` The PDFDocument the page is associated with.
`void`	`drawWithBoxToContext(long box, CGContextRef context)` Drawing method takes into account page rotation, draws in page space relative to and clipped to the box bounds.
`static long`	`hash_static()`
`PDFPage`	`init()` For subclassers, just call the standard -(id) init.
`PDFPage`	`initWithImage(UIImage image)` Returns a PDFPage for the passed in image.
`static NSObject.Function_instanceMethodForSelector_ret`	`instanceMethodForSelector(org.moe.natj.objc.SEL aSelector)`
`static NSMethodSignature`	`instanceMethodSignatureForSelector(org.moe.natj.objc.SEL aSelector)`
`static boolean`	`instancesRespondToSelector(org.moe.natj.objc.SEL aSelector)`
`static boolean`	`isSubclassOfClass(org.moe.natj.objc.Class aClass)`
`static NSSet<java.lang.String>`	`keyPathsForValuesAffectingValueForKey(java.lang.String key)`
`java.lang.String`	`label()` The page label.
`static PDFPage`	`new_objc()`
`long`	`numberOfCharacters()` Number of characters on the page (including linefeeds and spaces inserted).
`CGPDFPageRef`	`pageRef()` This is the CGPDFPage associated with the PDFPage object.
`void`	`removeAnnotation(PDFAnnotation annotation)`
`static boolean`	`resolveClassMethod(org.moe.natj.objc.SEL sel)`
`static boolean`	`resolveInstanceMethod(org.moe.natj.objc.SEL sel)`
`long`	`rotation()` Rotation on a page.
`PDFSelection`	`selectionForLineAtPoint(CGPoint point)` Given a point in page-space, returns a selection representing a whole line at that point.
`PDFSelection`	`selectionForRange(NSRange range)` Given a range, returns a selection representing text within that range.
`PDFSelection`	`selectionForRect(CGRect rect)` Given a rect in page-space, returns a selection representing enclosed text on page.
`PDFSelection`	`selectionForWordAtPoint(CGPoint point)` Given a point in page-space, returns a selection representing a whole word at that point.
`PDFSelection`	`selectionFromPointToPoint(CGPoint startPoint, CGPoint endPoint)` Returns a selection representing text between startPt and endPt.
`void`	`setBoundsForBox(CGRect bounds, long box)` Set bounds for the specified box.
`void`	`setDisplaysAnnotations(boolean value)` Method to turn on or off the display of annotations when the page is drawn.
`void`	`setRotation(long value)` Rotation on a page.
`static void`	`setVersion_static(long aVersion)`
`java.lang.String`	`string()` String (with linefeeds and in some cases spaces inserted) representing the text on the page.
`static org.moe.natj.objc.Class`	`superclass_static()`
`UIImage`	`thumbnailOfSizeForBox(CGSize size, long box)` Convenience function that returns an image of this page, with annotations, that fits the given size.
`void`	`transformContextForBox(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.
`CGAffineTransform`	`transformForBox(long box)` This transform correctly rotates and offsets based on the given page's rotation property and the display box type.
`static long`	`version_static()`

Methods inherited from class apple.NSObject
accessibilityActivate, accessibilityActivationPoint, accessibilityAssistiveTechnologyFocusedIdentifiers, accessibilityAttributedHint, accessibilityAttributedLabel, accessibilityAttributedUserInputLabels, accessibilityAttributedValue, accessibilityContainerType, accessibilityCustomActions, accessibilityCustomRotors, accessibilityDecrement, accessibilityDragSourceDescriptors, accessibilityDropPointDescriptors, accessibilityElementAtIndex, accessibilityElementCount, accessibilityElementDidBecomeFocused, accessibilityElementDidLoseFocus, accessibilityElementIsFocused, accessibilityElements, accessibilityElementsHidden, accessibilityFrame, accessibilityHint, accessibilityIncrement, accessibilityLabel, accessibilityLanguage, accessibilityNavigationStyle, accessibilityPath, accessibilityPerformEscape, accessibilityPerformMagicTap, accessibilityRespondsToUserInteraction, accessibilityScroll, accessibilityTextualContext, accessibilityTraits, accessibilityUserInputLabels, accessibilityValue, accessibilityViewIsModal, addObserverForKeyPathOptionsContext, attemptRecoveryFromErrorOptionIndex, attemptRecoveryFromErrorOptionIndexDelegateDidRecoverSelectorContextInfo, autoContentAccessingProxy, awakeAfterUsingCoder, awakeFromNib, class_objc, classForCoder, classForKeyedArchiver, copy, dealloc, debugDescription, description, dictionaryWithValuesForKeys, didChangeValueForKey, didChangeValueForKeyWithSetMutationUsingObjects, didChangeValuesAtIndexesForKey, doesNotRecognizeSelector, fileManagerShouldProceedAfterError, fileManagerWillProcessPath, finalize_objc, forwardingTargetForSelector, forwardInvocation, hash, indexOfAccessibilityElement, isAccessibilityElement, isEqual, isKindOfClass, isMemberOfClass, isProxy, methodForSelector, methodSignatureForSelector, mutableArrayValueForKey, mutableArrayValueForKeyPath, mutableCopy, mutableOrderedSetValueForKey, mutableOrderedSetValueForKeyPath, mutableSetValueForKey, mutableSetValueForKeyPath, observationInfo, observeValueForKeyPathOfObjectChangeContext, performSelector, performSelectorInBackgroundWithObject, performSelectorOnMainThreadWithObjectWaitUntilDone, performSelectorOnMainThreadWithObjectWaitUntilDoneModes, performSelectorOnThreadWithObjectWaitUntilDone, performSelectorOnThreadWithObjectWaitUntilDoneModes, performSelectorWithObject, performSelectorWithObjectAfterDelay, performSelectorWithObjectAfterDelayInModes, performSelectorWithObjectWithObject, prepareForInterfaceBuilder, provideImageDataBytesPerRowOrigin_Size_UserInfo, removeObserverForKeyPath, removeObserverForKeyPathContext, replacementObjectForCoder, replacementObjectForKeyedArchiver, respondsToSelector, self, setAccessibilityActivationPoint, setAccessibilityAttributedHint, setAccessibilityAttributedLabel, setAccessibilityAttributedUserInputLabels, setAccessibilityAttributedValue, setAccessibilityContainerType, setAccessibilityCustomActions, setAccessibilityCustomRotors, setAccessibilityDragSourceDescriptors, setAccessibilityDropPointDescriptors, setAccessibilityElements, setAccessibilityElementsHidden, setAccessibilityFrame, setAccessibilityHint, setAccessibilityLabel, setAccessibilityLanguage, setAccessibilityNavigationStyle, setAccessibilityPath, setAccessibilityRespondsToUserInteraction, setAccessibilityTextualContext, setAccessibilityTraits, setAccessibilityUserInputLabels, setAccessibilityValue, setAccessibilityViewIsModal, setIsAccessibilityElement, setNilValueForKey, setObservationInfo, setShouldGroupAccessibilityChildren, setValueForKey, setValueForKeyPath, setValueForUndefinedKey, setValuesForKeysWithDictionary, shouldGroupAccessibilityChildren, superclass, validateValueForKeyError, validateValueForKeyPathError, valueForKey, valueForKeyPath, valueForUndefinedKey, willChangeValueForKey, willChangeValueForKeyWithSetMutationUsingObjects, willChangeValuesAtIndexesForKey

Methods inherited from class org.moe.natj.objc.ObjCObject
equals, toString

Methods inherited from class org.moe.natj.general.NativeObject
finalize, getPeer, getPeerPointer

Methods inherited from class java.lang.Object
clone, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - PDFPage
```
protected PDFPage(org.moe.natj.general.Pointer peer)
```
- Method Detail
  - accessInstanceVariablesDirectly
```
public static boolean accessInstanceVariablesDirectly()
```
  - addAnnotation
```
public void addAnnotation(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
```
public PDFAnnotation annotationAtPoint(CGPoint point)
```
    Hit-testing method returns the annotation at point (or NULL if none). The point is in page-space.
  - annotations
```
public NSArray<? extends PDFAnnotation> annotations()
```
    Array of all PDFAnnotation objects on this page.
  - attributedString
```
public NSAttributedString attributedString()
```
  - automaticallyNotifiesObserversForKey
```
public static boolean automaticallyNotifiesObserversForKey(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(java.lang.Object aTarget)
```
  - cancelPreviousPerformRequestsWithTargetSelectorObject
```
public static void cancelPreviousPerformRequestsWithTargetSelectorObject(java.lang.Object aTarget,
                                                                         org.moe.natj.objc.SEL aSelector,
                                                                         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
```
public static NSArray<java.lang.String> classFallbacksForKeyedArchiver()
```
  - classForKeyedUnarchiver
```
public static org.moe.natj.objc.Class classForKeyedUnarchiver()
```
  - copyWithZone
```
public java.lang.Object copyWithZone(org.moe.natj.general.ptr.VoidPtr zone)
```
    Specified by:
    
    copyWithZone in interface NSCopying
  - dataRepresentation
```
public 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
```
public PDFDocument document()
```
    The PDFDocument the page is associated with.
  - drawWithBoxToContext
```
public void drawWithBoxToContext(long box,
                                 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).
  - 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(UIImage image)
```
    Returns a PDFPage for the passed in image. An easy way to create a PDFPage from an image to add to a PDFDocument.
  - instanceMethodForSelector
```
public static NSObject.Function_instanceMethodForSelector_ret instanceMethodForSelector(org.moe.natj.objc.SEL aSelector)
```
  - 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
```
public static NSSet<java.lang.String> keyPathsForValuesAffectingValueForKey(java.lang.String key)
```
  - label
```
public 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
```
public 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(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
```
public 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
```
public 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
```
public PDFSelection selectionForRect(CGRect rect)
```
    Given a rect in page-space, returns a selection representing enclosed text on page.
  - selectionForWordAtPoint
```
public 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
```
public 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
```
public 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
```
public 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.
  - transformContextForBox
```
public void transformContextForBox(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:].
  - 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.
  - version_static
```
public static long version_static()
```

Class PDFPage

Nested Class Summary

Nested classes/interfaces inherited from class apple.NSObject

Constructor Summary

Method Summary

Methods inherited from class apple.NSObject

Methods inherited from class org.moe.natj.objc.ObjCObject

Methods inherited from class org.moe.natj.general.NativeObject

Methods inherited from class java.lang.Object

Constructor Detail

PDFPage

Method Detail

accessInstanceVariablesDirectly

addAnnotation

alloc

allocWithZone

annotationAtPoint

annotations

attributedString

automaticallyNotifiesObserversForKey

boundsForBox

cancelPreviousPerformRequestsWithTarget

cancelPreviousPerformRequestsWithTargetSelectorObject

characterBoundsAtIndex

characterIndexAtPoint

classFallbacksForKeyedArchiver

classForKeyedUnarchiver

copyWithZone

dataRepresentation

debugDescription_static

description_static

displaysAnnotations

document

drawWithBoxToContext

hash_static

init

initWithImage

instanceMethodForSelector

instanceMethodSignatureForSelector

instancesRespondToSelector

isSubclassOfClass

keyPathsForValuesAffectingValueForKey

label

new_objc

numberOfCharacters

pageRef

removeAnnotation

resolveClassMethod

resolveInstanceMethod

rotation

selectionForLineAtPoint

selectionForRange

selectionForRect

selectionForWordAtPoint

selectionFromPointToPoint

setBoundsForBox

setDisplaysAnnotations

setRotation

setVersion_static

string

superclass_static

thumbnailOfSizeForBox

transformContextForBox

transformForBox

version_static