Package org.robovm.apple.pdfkit

Class PDFDocument

java.lang.Object

org.robovm.rt.bro.NativeObject

org.robovm.objc.ObjCObject

org.robovm.apple.foundation.NSObject

org.robovm.apple.pdfkit.PDFDocument

All Implemented Interfaces:

NSObjectProtocol, ObjCProtocol

public class PDFDocument
extends NSObject

Since:

Available in iOS 11.0 and later.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PDFDocument.PDFDocumentPtr

Nested classes/interfaces inherited from class org.robovm.apple.foundation.NSObject

NSObject.Handle, NSObject.Marshaler, NSObject.NoRetainMarshaler, NSObject.NSKeyValueObserver, NSObject.NSObjectPtr, NSObject.SkipInit

Nested classes/interfaces inherited from class org.robovm.objc.ObjCObject

ObjCObject.ObjCObjectPtr, ObjCObject.Super

Field Summary

Fields inherited from class org.robovm.apple.foundation.NSObject

FLAG_NO_RETAIN

Fields inherited from class org.robovm.objc.ObjCObject

customClass

Constructor Summary

Constructors

Modifier	Constructor	Description
	PDFDocument()
	PDFDocument(NSData data)
protected	PDFDocument(NSObject.Handle h, long handle)
protected	PDFDocument(NSObject.SkipInit skipInit)
	PDFDocument(NSURL url)

Method Summary

Modifier and Type	Method	Description
boolean	allowsCommenting()
boolean	allowsContentAccessibility()
boolean	allowsCopying()
boolean	allowsDocumentAssembly()
boolean	allowsDocumentChanges()
boolean	allowsFormFieldEntry()
boolean	allowsPrinting()
void	beginFindString(String string, NSStringCompareOptions options)
void	beginFindStrings(NSArray<NSString> strings, NSStringCompareOptions options)
void	cancelFindString()
NSData	dataRepresentation()
NSData	dataRepresentation(NSDictionary<?,?> options)
void	exchangePage(long indexA, long indexB)
NSArray<PDFSelection>	findString(String string, NSStringCompareOptions options)
PDFSelection	findString(String string, PDFSelection selection, NSStringCompareOptions options)
PDFAccessPermissions	getAccessPermissions()
PDFDocumentDelegate	getDelegate()
NSDictionary<?,?>	getDocumentAttributes()
CGPDFDocument	getDocumentRef()
NSURL	getDocumentURL()
long	getMajorVersion()
long	getMinorVersion()
PDFOutline	getOutlineRoot()
Class<?>	getPageClass()
long	getPageCount()
PDFDocumentPermissions	getPermissionsStatus()
PDFSelection	getSelectionForEntireDocument()
String	getString()
long	indexForPage(PDFPage page)
protected long	init(NSData data)
protected long	init(NSURL url)
void	insertPage(PDFPage page, long index)
boolean	isEncrypted()
boolean	isFinding()
boolean	isLocked()
PDFOutline	outlineItemForSelection(PDFSelection selection)
PDFPage	pageAtIndex(long index)
void	removePageAtIndex(long index)
PDFSelection	selection(PDFPage startPage, long startCharacter, PDFPage endPage, long endCharacter)
PDFSelection	selection(PDFPage startPage, CGPoint startPoint, PDFPage endPage, CGPoint endPoint)
void	setDelegate(PDFDocumentDelegate v)
void	setDocumentAttributes(NSDictionary<?,?> v)
void	setOutlineRoot(PDFOutline v)
boolean	unlock(String password)
boolean	writeToFile(String path)
boolean	writeToFile(String path, NSDictionary<NSString,?> options)
boolean	writeToURL(NSURL url)
boolean	writeToURL(NSURL url, NSDictionary<NSString,?> options)

Methods inherited from class org.robovm.apple.foundation.NSObject

addKeyValueObserver, addKeyValueObserver, afterMarshaled, alloc, autorelease, autorelease, awakeFromNib, conformsToProtocol, copy, description, didChangeValue, didChangeValue, didChangeValues, doDispose, equals, forceSkipInit, getAutoContentAccessingProxy, getClassForCoder, getClassForKeyedArchiver, getKeyValueCoder, getObservationInfo, hash, hashCode, init, isEqual, isKindOfClass, isMemberOfClass, mutableCopy, performSelector, performSelector, performSelector, performSelector, performSelector, performSelector, performSelector, performSelectorInBackground, performSelectorOnMainThread, performSelectorOnMainThread, performSelectorV, performSelectorV, performSelectorV, release, release, removeKeyValueObserver, removeKeyValueObservers, respondsToSelector, retain, retain, retainCount, setObservationInfo, toString, willChangeValue, willChangeValue, willChangeValues

Methods inherited from class org.robovm.objc.ObjCObject

addStrongRef, dispose, dispose, finalize, getAssociatedObject, getObjCClass, getPeerObject, getSuper, initObject, logRetainRelease, removeStrongRef, retainCustomObjectFromCb, setAssociatedObject, toObjCObject, toObjCObject, updateStrongRef

Methods inherited from class org.robovm.rt.bro.NativeObject

as, getHandle, setHandle

Methods inherited from class java.lang.Object

clone, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

PDFDocument

public PDFDocument()

PDFDocument

protected PDFDocument(NSObject.Handle h,
long handle)

PDFDocument

protected PDFDocument(NSObject.SkipInit skipInit)

PDFDocument

public PDFDocument(NSURL url)

PDFDocument

public PDFDocument(NSData data)

Method Details

getDocumentURL

public NSURL getDocumentURL()

getDocumentRef

public CGPDFDocument getDocumentRef()

getDocumentAttributes

public NSDictionary<?,?> getDocumentAttributes()

setDocumentAttributes

public void setDocumentAttributes(NSDictionary<?,?> v)

getMajorVersion

public long getMajorVersion()

getMinorVersion

public long getMinorVersion()

isEncrypted

public boolean isEncrypted()

isLocked

public boolean isLocked()

allowsPrinting

public boolean allowsPrinting()

Since:

Available in iOS 11.0 and later.

allowsCopying

public boolean allowsCopying()

Since:

Available in iOS 11.0 and later.

allowsDocumentChanges

public boolean allowsDocumentChanges()

Since:

Available in iOS 11.0 and later.

allowsDocumentAssembly

public boolean allowsDocumentAssembly()

Since:

Available in iOS 11.0 and later.

allowsContentAccessibility

public boolean allowsContentAccessibility()

Since:

Available in iOS 11.0 and later.

allowsCommenting

public boolean allowsCommenting()

Since:

Available in iOS 11.0 and later.

allowsFormFieldEntry

public boolean allowsFormFieldEntry()

Since:

Available in iOS 11.0 and later.

getAccessPermissions

public PDFAccessPermissions getAccessPermissions()

getPermissionsStatus

public PDFDocumentPermissions getPermissionsStatus()

Since:

Available in iOS 11.0 and later.

getString

public String getString()

getDelegate

public PDFDocumentDelegate getDelegate()

setDelegate

public void setDelegate(PDFDocumentDelegate v)

getOutlineRoot

public PDFOutline getOutlineRoot()

Since:

Available in iOS 11.0 and later.

setOutlineRoot

public void setOutlineRoot(PDFOutline v)

Since:

Available in iOS 11.0 and later.

getPageCount

public long getPageCount()

getPageClass

public Class<?> getPageClass()

isFinding

public boolean isFinding()

getSelectionForEntireDocument

public PDFSelection getSelectionForEntireDocument()

init

protected long init(NSURL url)

init

protected long init(NSData data)

unlock

public boolean unlock(String password)

dataRepresentation

public NSData dataRepresentation()

dataRepresentation

public NSData dataRepresentation(NSDictionary<?,?> options)

Since:

Available in iOS 11.0 and later.

writeToFile

public boolean writeToFile(String path)

writeToFile

public boolean writeToFile(String path,
NSDictionary<NSString,?> options)

writeToURL

public boolean writeToURL(NSURL url)

writeToURL

public boolean writeToURL(NSURL url,
NSDictionary<NSString,?> options)

outlineItemForSelection

public PDFOutline outlineItemForSelection(PDFSelection selection)

pageAtIndex

public PDFPage pageAtIndex(long index)

indexForPage

public long indexForPage(PDFPage page)

insertPage

public void insertPage(PDFPage page,
long index)

removePageAtIndex

public void removePageAtIndex(long index)

exchangePage

public void exchangePage(long indexA,
long indexB)

findString

public NSArray<PDFSelection> findString(String string,
NSStringCompareOptions options)

beginFindString

public void beginFindString(String string,
NSStringCompareOptions options)

beginFindStrings

public void beginFindStrings(NSArray<NSString> strings,
NSStringCompareOptions options)

Since:

Available in iOS 11.0 and later.

findString

public PDFSelection findString(String string,
PDFSelection selection,
NSStringCompareOptions options)

cancelFindString

public void cancelFindString()

selection

public PDFSelection selection(PDFPage startPage,
CGPoint startPoint,
PDFPage endPage,
CGPoint endPoint)

selection

public PDFSelection selection(PDFPage startPage,
long startCharacter,
PDFPage endPage,
long endCharacter)