Package org.robovm.apple.uikit

Class UIDocument

java.lang.Object

org.robovm.rt.bro.NativeObject

org.robovm.objc.ObjCObject

org.robovm.apple.foundation.NSObject

org.robovm.apple.uikit.UIDocument

All Implemented Interfaces:

NSFilePresenter, NSObjectProtocol, NSProgressReporting, UIUserActivityRestoring, ObjCProtocol

Direct Known Subclasses:

UIManagedDocument

public class UIDocument
extends NSObject
implements NSFilePresenter, NSProgressReporting, UIUserActivityRestoring

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UIDocument.Notifications
static class	UIDocument.UIDocumentPtr

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
	UIDocument()
protected	UIDocument(NSObject.Handle h, long handle)
protected	UIDocument(NSObject.SkipInit skipInit)
	UIDocument(NSURL url)

Method Summary

Modifier and Type	Method	Description
void	accommodatePresentedItemDeletion(VoidBlock1<NSError> completionHandler)
void	accommodatePresentedSubitemDeletionAtURL(NSURL url, VoidBlock1<NSError> completionHandler)
void	autoSave(VoidBooleanBlock completionHandler)
void	close(VoidBooleanBlock completionHandler)
void	disableEditing()
void	enableEditing()
void	finishedHandlingError(NSError error, boolean recovered)
NSObject	getChangeCountToken(UIDocumentSaveOperation saveOperation)
NSObject	getContentsForType(String typeName)
UIDocumentState	getDocumentState()
NSFileAttributes	getFileAttributesToWrite(NSURL url, UIDocumentSaveOperation saveOperation)
NSDate	getFileModificationDate()
String	getFileNameExtension(String typeName, UIDocumentSaveOperation saveOperation)
String	getFileType()
NSURL	getFileURL()
String	getLocalizedName()
NSSet<NSString>	getObservedPresentedItemUbiquityAttributes()
NSOperationQueue	getPresentedItemOperationQueue()
NSURL	getPresentedItemURL()
NSProgress	getProgress()
String	getSavingFileType()
NSUndoManager	getUndoManager()
NSUserActivity	getUserActivity()
void	handleError(NSError error, boolean userInteractionPermitted)
boolean	hasUnsavedChanges()
protected long	init(NSURL url)
boolean	loadFromContents(NSObject contents, String typeName)
void	open(VoidBooleanBlock completionHandler)
void	performAsynchronousFileAccess(Runnable block)
void	presentedItemDidChange()
void	presentedItemDidChangeUbiquityAttributes(NSSet<NSString> attributes)
void	presentedItemDidGainVersion(NSFileVersion version)
void	presentedItemDidLoseVersion(NSFileVersion version)
void	presentedItemDidMoveToURL(NSURL newURL)
void	presentedItemDidResolveConflictVersion(NSFileVersion version)
void	presentedSubitemAtURLDidGainVersion(NSURL url, NSFileVersion version)
void	presentedSubitemAtURLDidLoseVersion(NSURL url, NSFileVersion version)
void	presentedSubitemAtURLDidMoveToURL(NSURL oldURL, NSURL newURL)
void	presentedSubitemAtURLDidResolveConflictVersion(NSURL url, NSFileVersion version)
void	presentedSubitemDidAppearAtURL(NSURL url)
void	presentedSubitemDidChangeAtURL(NSURL url)
boolean	read(NSURL url)
void	relinquishPresentedItemToReader(VoidBlock1<Runnable> reader)
void	relinquishPresentedItemToWriter(VoidBlock1<Runnable> writer)
void	restoreUserActivityState(NSUserActivity userActivity)
void	revert(NSURL url, VoidBooleanBlock completionHandler)
void	save(NSURL url, UIDocumentSaveOperation saveOperation, VoidBooleanBlock completionHandler)
void	savePresentedItemChanges(VoidBlock1<NSError> completionHandler)
void	setFileModificationDate(NSDate v)
void	setUndoManager(NSUndoManager v)
void	setUserActivity(NSUserActivity v)
static NSString	StateChangedNotification()
void	updateChangeCount(NSObject changeCountToken, UIDocumentSaveOperation saveOperation)
void	updateChangeCount(UIDocumentChangeKind change)
void	updateUserActivityState(NSUserActivity userActivity)
static String	UserActivityDocumentURLKey()
void	userInteractionNoLongerPermitted(NSError error)
boolean	writeContents(NSObject contents, NSFileAttributes additionalFileAttributes, NSURL url, UIDocumentSaveOperation saveOperation)
boolean	writeContents(NSObject contents, NSURL url, UIDocumentSaveOperation saveOperation, NSURL originalContentsURL)

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

UIDocument

public UIDocument()

UIDocument

protected UIDocument(NSObject.Handle h,
long handle)

UIDocument

protected UIDocument(NSObject.SkipInit skipInit)

UIDocument

public UIDocument(NSURL url)

Method Details

getFileURL

public NSURL getFileURL()

getLocalizedName

public String getLocalizedName()

getFileType

public String getFileType()

getFileModificationDate

public NSDate getFileModificationDate()

setFileModificationDate

public void setFileModificationDate(NSDate v)

getDocumentState

public UIDocumentState getDocumentState()

getProgress

public NSProgress getProgress()

Specified by:

getProgress in interface NSProgressReporting

Since:

Available in iOS 9.0 and later.

getUndoManager

public NSUndoManager getUndoManager()

setUndoManager

public void setUndoManager(NSUndoManager v)

hasUnsavedChanges

public boolean hasUnsavedChanges()

getSavingFileType

public String getSavingFileType()

getUserActivity

public NSUserActivity getUserActivity()

setUserActivity

public void setUserActivity(NSUserActivity v)

getPresentedItemURL

public NSURL getPresentedItemURL()

Specified by:

getPresentedItemURL in interface NSFilePresenter

getPresentedItemOperationQueue

public NSOperationQueue getPresentedItemOperationQueue()

Specified by:

getPresentedItemOperationQueue in interface NSFilePresenter

getObservedPresentedItemUbiquityAttributes

public NSSet<NSString> getObservedPresentedItemUbiquityAttributes()

Specified by:

getObservedPresentedItemUbiquityAttributes in interface NSFilePresenter

Since:

Available in iOS 11.0 and later.

StateChangedNotification

public static NSString StateChangedNotification()

UserActivityDocumentURLKey

public static String UserActivityDocumentURLKey()

init

protected long init(NSURL url)

open

public void open(VoidBooleanBlock completionHandler)

close

public void close(VoidBooleanBlock completionHandler)

loadFromContents

public boolean loadFromContents(NSObject contents,
String typeName)
                         throws NSErrorException

Throws:

NSErrorException

getContentsForType

public NSObject getContentsForType(String typeName)
                            throws NSErrorException

Throws:

NSErrorException

disableEditing

public void disableEditing()

enableEditing

public void enableEditing()

updateChangeCount

public void updateChangeCount(UIDocumentChangeKind change)

getChangeCountToken

public NSObject getChangeCountToken(UIDocumentSaveOperation saveOperation)

updateChangeCount

public void updateChangeCount(NSObject changeCountToken,
UIDocumentSaveOperation saveOperation)

save

public void save(NSURL url,
UIDocumentSaveOperation saveOperation,
VoidBooleanBlock completionHandler)

autoSave

public void autoSave(VoidBooleanBlock completionHandler)

getFileNameExtension

public String getFileNameExtension(String typeName,
UIDocumentSaveOperation saveOperation)

writeContents

public boolean writeContents(NSObject contents,
NSFileAttributes additionalFileAttributes,
NSURL url,
UIDocumentSaveOperation saveOperation)
                      throws NSErrorException

Throws:

NSErrorException

writeContents

public boolean writeContents(NSObject contents,
NSURL url,
UIDocumentSaveOperation saveOperation,
NSURL originalContentsURL)
                      throws NSErrorException

Throws:

NSErrorException

getFileAttributesToWrite

public NSFileAttributes getFileAttributesToWrite(NSURL url,
UIDocumentSaveOperation saveOperation)
                                          throws NSErrorException

Throws:

NSErrorException

read

public boolean read(NSURL url)
             throws NSErrorException

Throws:

NSErrorException

performAsynchronousFileAccess

public void performAsynchronousFileAccess(Runnable block)

handleError

public void handleError(NSError error,
boolean userInteractionPermitted)

finishedHandlingError

public void finishedHandlingError(NSError error,
boolean recovered)

userInteractionNoLongerPermitted

public void userInteractionNoLongerPermitted(NSError error)

revert

public void revert(NSURL url,
VoidBooleanBlock completionHandler)

updateUserActivityState

public void updateUserActivityState(NSUserActivity userActivity)

restoreUserActivityState

public void restoreUserActivityState(NSUserActivity userActivity)

Specified by:

restoreUserActivityState in interface UIUserActivityRestoring

relinquishPresentedItemToReader

public void relinquishPresentedItemToReader(VoidBlock1<Runnable> reader)

Specified by:

relinquishPresentedItemToReader in interface NSFilePresenter

relinquishPresentedItemToWriter

public void relinquishPresentedItemToWriter(VoidBlock1<Runnable> writer)

Specified by:

relinquishPresentedItemToWriter in interface NSFilePresenter

savePresentedItemChanges

public void savePresentedItemChanges(VoidBlock1<NSError> completionHandler)

Specified by:

savePresentedItemChanges in interface NSFilePresenter

accommodatePresentedItemDeletion

public void accommodatePresentedItemDeletion(VoidBlock1<NSError> completionHandler)

Specified by:

accommodatePresentedItemDeletion in interface NSFilePresenter

presentedItemDidMoveToURL

public void presentedItemDidMoveToURL(NSURL newURL)

Specified by:

presentedItemDidMoveToURL in interface NSFilePresenter

presentedItemDidChange

public void presentedItemDidChange()

Specified by:

presentedItemDidChange in interface NSFilePresenter

presentedItemDidChangeUbiquityAttributes

public void presentedItemDidChangeUbiquityAttributes(NSSet<NSString> attributes)

Specified by:

presentedItemDidChangeUbiquityAttributes in interface NSFilePresenter

Since:

Available in iOS 11.0 and later.

presentedItemDidGainVersion

public void presentedItemDidGainVersion(NSFileVersion version)

Specified by:

presentedItemDidGainVersion in interface NSFilePresenter

presentedItemDidLoseVersion

public void presentedItemDidLoseVersion(NSFileVersion version)

Specified by:

presentedItemDidLoseVersion in interface NSFilePresenter

presentedItemDidResolveConflictVersion

public void presentedItemDidResolveConflictVersion(NSFileVersion version)

Specified by:

presentedItemDidResolveConflictVersion in interface NSFilePresenter

accommodatePresentedSubitemDeletionAtURL

public void accommodatePresentedSubitemDeletionAtURL(NSURL url,
VoidBlock1<NSError> completionHandler)

Specified by:

accommodatePresentedSubitemDeletionAtURL in interface NSFilePresenter

presentedSubitemDidAppearAtURL

public void presentedSubitemDidAppearAtURL(NSURL url)

Specified by:

presentedSubitemDidAppearAtURL in interface NSFilePresenter

presentedSubitemAtURLDidMoveToURL

public void presentedSubitemAtURLDidMoveToURL(NSURL oldURL,
NSURL newURL)

Specified by:

presentedSubitemAtURLDidMoveToURL in interface NSFilePresenter

presentedSubitemDidChangeAtURL

public void presentedSubitemDidChangeAtURL(NSURL url)

Specified by:

presentedSubitemDidChangeAtURL in interface NSFilePresenter

presentedSubitemAtURLDidGainVersion

public void presentedSubitemAtURLDidGainVersion(NSURL url,
NSFileVersion version)

Specified by:

presentedSubitemAtURLDidGainVersion in interface NSFilePresenter

presentedSubitemAtURLDidLoseVersion

public void presentedSubitemAtURLDidLoseVersion(NSURL url,
NSFileVersion version)

Specified by:

presentedSubitemAtURLDidLoseVersion in interface NSFilePresenter

presentedSubitemAtURLDidResolveConflictVersion

public void presentedSubitemAtURLDidResolveConflictVersion(NSURL url,
NSFileVersion version)

Specified by:

presentedSubitemAtURLDidResolveConflictVersion in interface NSFilePresenter