org.rococoa.cocoa.appkit
Class NSDocumentController
java.lang.Object
org.rococoa.cocoa.foundation.NSObject
org.rococoa.cocoa.appkit.NSDocumentController
- All Implemented Interfaces:
- NSDeprecated, NSUserInterfaceValidations, ABActionDelegate, AMWorkflowControllerDelegate, IMVideoDataSource, NSAccessibility, NSAccessibilityAdditions, NSAnimationDelegate, NSApplicationScriptingDelegation, NSArchiverCallback, NSBrowserDelegate, NSClassDescriptionPrimitives, NSCoderMethods, NSColorPanelResponderMethod, NSComboBoxCellDataSource, NSComboBoxDataSource, NSComboBoxNotifications, NSComparisonMethods, NSConnectionDelegateMethods, NSControlSubclassDelegate, NSControlSubclassNotifications, NSCopyLinkMoveHandler, NSDatePickerCellDelegate, NSDelayedPerforming, NSDeprecatedKeyValueCoding, NSDeprecatedKeyValueObservingCustomization, NSDeprecatedMethods, NSDictionaryControllerKeyValuePair, NSDistantObjectRequestMethods, NSDistributedObjects, NSDraggingDestination, NSDraggingSource, NSDrawerDelegate, NSDrawerNotifications, NSEditor, NSEditorRegistration, NSErrorRecoveryAttempting, NSExceptionHandlerDelegate, NSFileManagerFileOperationAdditions, NSFontManagerDelegate, NSFontManagerResponderMethod, NSFontPanelValidationAdditions, NSImageDelegate, NSKeyedArchiverDelegate, NSKeyedArchiverObjectSubstitution, NSKeyedUnarchiverDelegate, NSKeyedUnarchiverObjectSubstitution, NSKeyValueBindingCreation, NSKeyValueCoding, NSKeyValueObserverNotification, NSKeyValueObserverRegistration, NSKeyValueObserving, NSKeyValueObservingCustomization, NSLayoutManagerDelegate, NSMenuDelegate, NSMenuValidation, NSMetadataQueryDelegate, NSNetServiceBrowserDelegateMethods, NSNetServiceDelegateMethods, NSNibAwaking, NSOutlineViewDataSource, NSOutlineViewDelegate, NSOutlineViewNotifications, NSPasteboardOwner, NSPlaceholders, NSPortDelegateMethods, NSRuleEditorDelegateMethods, NSSavePanelDelegate, NSScriptClassDescription, NSScripting, NSScriptingComparisonMethods, NSScriptKeyValueCoding, NSScriptObjectSpecifiers, NSSoundDelegateMethods, NSSpeechRecognizerDelegate, NSSpeechSynthesizerDelegate, NSSpellServerDelegate, NSSplitViewDelegate, NSStreamDelegateEventExtensions, NSTabViewDelegate, NSTextDelegate, NSTextViewDelegate, NSThreadPerformAdditions, NSTokenFieldCellDelegate, NSTokenFieldDelegate, NSToolbarDelegate, NSToolbarNotifications, NSURLClient, NSURLConnectionDelegate, NSURLDownloadDelegate, NSWindowDelegate, NSWindowNotifications, NSXMLParserDelegateEventAdditions, QTCaptureDecompressedVideoOutputDelegate, QTCaptureFileOutputDelegate, QTCaptureVideoPreviewOutputDelegate, QTCaptureViewDelegate, QTMovieDelegate, QTMovieViewDelegate, SFAuthorizationViewDelegate, SFCertificatePanelDelegate, SFChooseIdentityPanelDelegate, WebDownloadDelegate, WebFrameLoadDelegate, WebJavaPlugIn, WebPlugIn, WebPlugInContainer, WebPolicyDelegate, WebResourceLoadDelegate, WebScripting, WebUIDelegate, WebViewEditingDelegate, NSCoding, NSObject
public abstract class NSDocumentController
- extends NSObject
- implements NSDeprecated, NSCoding, NSUserInterfaceValidations
This file was autogenerated by JNAerator,
a tool written by Olivier Chafik that uses a few opensource projects..
For help, please visit NativeLibs4Java, Rococoa, or JNA.
|
Method Summary |
abstract void |
addDocument(NSDocument document)
Add or remove a document from the list of open documents. |
static NSDocumentController |
alloc()
|
abstract NSObject |
autosavingDelay()
|
abstract void |
clearRecentDocuments(org.rococoa.ID sender)
The action of the Open Recent menu's Clear Menu item. |
abstract void |
closeAllDocumentsWithDelegate_didCloseAllSelector_contextInfo(org.rococoa.ID delegate,
org.rococoa.Selector didCloseAllSelector,
Pointer contextInfo)
For each open, modified, document present a document-modal alert panel asking whether the document should be saved and giving the option of canceling, not saving the document, or saving the document. |
static NSDocumentController |
create()
Factory method
|
abstract NSString |
currentDirectory()
Return the path of the directory containing the active document's file or file package, if there is an active document and it has a file or file package. |
abstract NSObject |
currentDocument()
Return the active document, or nil if there is no active document. |
abstract NSString |
defaultType()
Return the name of the document type that should be used when creating new documents. |
abstract NSString |
displayNameForType(NSString typeName)
Given a document type name, return a string describing the document type that is fit to present to the user, or nil for failure. |
abstract Pointer |
documentClassForType(NSString typeName)
Given a document type name, return the subclass of NSDocument that should be instantiated when opening a document of that type, or nil for failure. |
abstract NSArray |
documentClassNames()
Return the names of NSDocument subclasses supported by this application. |
abstract NSObject |
documentForURL(NSURL absoluteURL)
Given a URL, return the open document whose file or file package is located by the URL, or nil if there is no such open document. |
abstract NSObject |
documentForWindow(NSWindow window)
Given a window, return the document corresponding to the window, nil if no document corrresponds to the window. |
abstract NSArray |
documents()
Return an array of all open documents. |
abstract boolean |
hasEditedDocuments()
Return YES if any open document is modified, NO otherwise. |
abstract NSDocumentController |
init()
The designated initializer. |
abstract NSObject |
makeDocumentForURL_withContentsOfURL_ofType_error(NSURL absoluteDocumentURL,
NSURL absoluteDocumentContentsURL,
NSString typeName,
PointerByReference outError)
Instantiate a document located by a URL, of a specified type, but by reading the contents for the document from another URL, and return it if successful. |
abstract NSObject |
makeDocumentWithContentsOfURL_ofType_error(NSURL absoluteURL,
NSString typeName,
PointerByReference outError)
Instantiate a document located by a URL, of a specified type, and return it if successful. |
abstract NSObject |
makeUntitledDocumentOfType_error(NSString typeName,
PointerByReference outError)
Instantiate a new untitled document of the specified type and return it if successful. |
abstract int |
maximumRecentDocumentCount()
Return the maximum number of items that may be presented in the standard Open Recent menu. |
abstract void |
newDocument(org.rococoa.ID sender)
The action of the File menu's New item in a document-based application. |
abstract void |
noteNewRecentDocument(NSDocument document)
Add an item corresponding to a document to the Open Recent menu, or replace an existing item for the same document. |
abstract void |
noteNewRecentDocumentURL(NSURL absoluteURL)
Add an item corresponding to the data located by a URL to the Open Recent menu, or replace an existing item with the same URL. |
abstract void |
openDocument(org.rococoa.ID sender)
The action of the File menu's Open... item in a document-based application. |
abstract NSObject |
openDocumentWithContentsOfURL_display_error(NSURL absoluteURL,
boolean displayDocument,
PointerByReference outError)
Open a document located by a URL, present its user interface if displayDocuments is YES, and return the document if successful. |
abstract NSObject |
openUntitledDocumentAndDisplay_error(boolean displayDocument,
PointerByReference outError)
Create a new untitled document, present its user interface if displayDocument is YES, and return the document if successful. |
abstract void |
presentError_modalForWindow_delegate_didPresentSelector_contextInfo(NSError error,
NSWindow window,
org.rococoa.ID delegate,
org.rococoa.Selector didPresentSelector,
Pointer contextInfo)
Methods that are declared by NSResponder and also implemented by NSDocumentController, even though for historical reasons NSDocumentController is not a subclass of NSResponder. |
abstract boolean |
presentError(NSError error)
|
abstract NSArray |
recentDocumentURLs()
Return an array of URLs for the entries currently appearing in the Open Recent menu. |
abstract void |
removeDocument(NSDocument document)
|
abstract boolean |
reopenDocumentForURL_withContentsOfURL_error(NSURL absoluteDocumentURL,
NSURL absoluteDocumentContentsURL,
PointerByReference outError)
Reopen a document located by a URL by reading the contents for the document from another URL, present its user interface, and return YES if successful. |
abstract void |
reviewUnsavedDocumentsWithAlertTitle_cancellable_delegate_didReviewAllSelector_contextInfo(NSString title,
boolean cancellable,
org.rococoa.ID delegate,
org.rococoa.Selector didReviewAllSelector,
Pointer contextInfo)
If there is more than one modified document, present an application-modal alert panel telling the user that there are unsaved documents and giving the option of canceling, not saving the documents, or saving the documents. |
abstract int |
runModalOpenPanel_forTypes(NSOpenPanel openPanel,
NSArray types)
Present the application-modal open panel to the user, specifying a list of UTIs (in Mac OS 10.5), file name extensions, and encoded HFS file types for openable files. |
abstract void |
saveAllDocuments(org.rococoa.ID sender)
The action of the File menu's Save All item in a document-based application. |
static NSDocumentController |
sharedDocumentController()
Return the application's shared document controller. |
abstract NSString |
typeForContentsOfURL_error(NSURL inAbsoluteURL,
PointerByReference outError)
Given a URL, return the name of the document type that should be used when opening the document at that location, if successful. |
abstract NSArray |
URLsFromRunningOpenPanel()
Present an application-modal open panel to the user and, if the user selects one or more files and indicates that they are to be opened, return an array of those files' URLs. |
abstract boolean |
validateUserInterfaceItem(org.rococoa.ID anItem)
Deprecated. use the safer method validateUserInterfaceItem(org.rococoa.cocoa.appkit.protocols.NSValidatedUserInterfaceItem) instead |
abstract boolean |
validateUserInterfaceItem(NSValidatedUserInterfaceItem anItem)
Conformance to the NSUserInterfaceValidations protocol. |
abstract NSError |
willPresentError(NSError error)
|
| Methods inherited from class org.rococoa.cocoa.foundation.NSObject |
copy, dealloc, description, doesNotRecognizeSelector, finalize, forwardInvocation, id, isKindOfClass, isKindOfClass, methodSignatureForSelector, mutableCopy, release, retain, retainCount |
| Methods inherited from interface org.rococoa.cocoa.foundation.protocols.NSObject |
autorelease, class_, conformsToProtocol, hash, isEqual, isKindOfClass, isMemberOfClass, isProxy, performSelector_withObject_withObject, performSelector_withObject, performSelector, respondsToSelector, self, superclass, zone |
| Methods inherited from interface org.rococoa.cocoa.foundation.categories.WebUIDelegate |
webView_contextMenuItemsForElement_defaultMenuItems, webView_createWebViewModalDialogWithRequest, webView_createWebViewWithRequest, webView_dragDestinationActionMaskForDraggingInfo, webView_dragDestinationActionMaskForDraggingInfo, webView_makeFirstResponder, webView_mouseDidMoveOverElement_modifierFlags, webView_printFrameView, webView_runBeforeUnloadConfirmPanelWithMessage_initiatedByFrame, webView_runJavaScriptAlertPanelWithMessage_initiatedByFrame, webView_runJavaScriptAlertPanelWithMessage, webView_runJavaScriptConfirmPanelWithMessage_initiatedByFrame, webView_runJavaScriptConfirmPanelWithMessage, webView_runJavaScriptTextInputPanelWithPrompt_defaultText_initiatedByFrame, webView_runJavaScriptTextInputPanelWithPrompt_defaultText, webView_runOpenPanelForFileButtonWithResultListener, webView_runOpenPanelForFileButtonWithResultListener, webView_setResizable, webView_setStatusBarVisible, webView_setStatusText, webView_setToolbarsVisible, webView_shouldPerformAction_fromSender, webView_validateUserInterfaceItem_defaultValidation, webView_validateUserInterfaceItem_defaultValidation, webView_willPerformDragDestinationAction_forDraggingInfo, webView_willPerformDragDestinationAction_forDraggingInfo, webViewAreToolbarsVisible, webViewClose, webViewContentRect, webViewFirstResponder, webViewFocus, webViewFooterHeight, webViewFrame, webViewHeaderHeight, webViewIsResizable, webViewIsStatusBarVisible, webViewRunModal, webViewShow, webViewStatusText, webViewUnfocus |
| Methods inherited from interface org.rococoa.cocoa.foundation.categories.NSBrowserDelegate |
browser_acceptDrop_atRow_column_dropOperation, browser_acceptDrop_atRow_column_dropOperation, browser_canDragRowsWithIndexes_inColumn_withEvent, browser_createRowsForColumn_inMatrix, browser_isColumnValid, browser_namesOfPromisedFilesDroppedAtDestination_forDraggedRowsWithIndexes_inColumn, browser_nextTypeSelectMatchFromRow_toRow_inColumn_forString, browser_numberOfRowsInColumn, browser_selectCellWithString_inColumn, browser_selectRow_inColumn, browser_shouldShowCellExpansionForRow_column, browser_shouldSizeColumn_forUserResize_toWidth, browser_shouldTypeSelectForEvent_withCurrentSearchString, browser_sizeToFitWidthOfColumn, browser_titleOfColumn, browser_typeSelectStringForRow_inColumn, browser_validateDrop_proposedRow_column_dropOperation, browser_validateDrop_proposedRow_column_dropOperation, browser_willDisplayCell_atRow_column, browser_writeRowsWithIndexes_inColumn_toPasteboard, browserColumnConfigurationDidChange, browserDidScroll, browserWillScroll |
| Methods inherited from interface org.rococoa.cocoa.foundation.categories.NSKeyValueCoding |
dictionaryWithValuesForKeys, mutableArrayValueForKey, mutableArrayValueForKeyPath, mutableSetValueForKey, mutableSetValueForKeyPath, setNilValueForKey, setValue_forKey, setValue_forKeyPath, setValue_forUndefinedKey, setValuesForKeysWithDictionary, validateValue_forKey_error, validateValue_forKeyPath_error, valueForKey, valueForKeyPath, valueForUndefinedKey |
| Methods inherited from interface org.rococoa.cocoa.foundation.categories.NSOutlineViewDelegate |
outlineView_dataCellForTableColumn_item, outlineView_didClickTableColumn, outlineView_didDragTableColumn, outlineView_heightOfRowByItem, outlineView_isGroupItem, outlineView_mouseDownInHeaderOfTableColumn, outlineView_nextTypeSelectMatchFromItem_toItem_forString, outlineView_selectionIndexesForProposedSelection, outlineView_shouldCollapseItem, outlineView_shouldEditTableColumn_item, outlineView_shouldExpandItem, outlineView_shouldSelectItem, outlineView_shouldSelectTableColumn, outlineView_shouldShowCellExpansionForTableColumn_item, outlineView_shouldTrackCell_forTableColumn_item, outlineView_shouldTypeSelectForEvent_withCurrentSearchString, outlineView_typeSelectStringForTableColumn_item, outlineView_willDisplayCell_forTableColumn_item, outlineView_willDisplayOutlineCell_forTableColumn_item, selectionShouldChangeInOutlineView |
| Methods inherited from interface org.rococoa.cocoa.foundation.categories.WebViewEditingDelegate |
undoManagerForWebView, webView_doCommandBySelector, webView_shouldApplyStyle_toElementsInDOMRange, webView_shouldBeginEditingInDOMRange, webView_shouldChangeTypingStyle_toStyle, webView_shouldDeleteDOMRange, webView_shouldEndEditingInDOMRange, webView_shouldInsertNode_replacingDOMRange_givenAction, webView_shouldInsertText_replacingDOMRange_givenAction, webViewDidBeginEditing, webViewDidChange, webViewDidChangeSelection, webViewDidChangeTypingStyle, webViewDidEndEditing |
| Methods inherited from interface org.rococoa.cocoa.foundation.categories.WebFrameLoadDelegate |
webView_didCancelClientRedirectForFrame, webView_didChangeLocationWithinPageForFrame, webView_didClearWindowObject_forFrame, webView_didCommitLoadForFrame, webView_didFailLoadWithError_forFrame, webView_didFailProvisionalLoadWithError_forFrame, webView_didFinishLoadForFrame, webView_didReceiveIcon_forFrame, webView_didReceiveServerRedirectForProvisionalLoadForFrame, webView_didReceiveTitle_forFrame, webView_didStartProvisionalLoadForFrame, webView_willCloseFrame, webView_windowScriptObjectAvailable |
| Methods inherited from interface org.rococoa.cocoa.foundation.categories.NSTokenFieldDelegate |
tokenField_completionsForSubstring_indexOfToken_indexOfSelectedItem, tokenField_completionsForSubstring_indexOfToken_indexOfSelectedItem, tokenField_displayStringForRepresentedObject, tokenField_editingStringForRepresentedObject, tokenField_hasMenuForRepresentedObject, tokenField_menuForRepresentedObject, tokenField_readFromPasteboard, tokenField_representedObjectForEditingString, tokenField_shouldAddObjects_atIndex, tokenField_styleForRepresentedObject, tokenField_writeRepresentedObjects_toPasteboard |
| Methods inherited from interface org.rococoa.cocoa.foundation.categories.NSXMLParserDelegateEventAdditions |
parser_didEndElement_namespaceURI_qualifiedName, parser_didEndMappingPrefix, parser_didStartElement_namespaceURI_qualifiedName_attributes, parser_didStartMappingPrefix_toURI, parser_foundAttributeDeclarationWithName_forElement_type_defaultValue, parser_foundCDATA, parser_foundCharacters, parser_foundComment, parser_foundElementDeclarationWithName_model, parser_foundExternalEntityDeclarationWithName_publicID_systemID, parser_foundIgnorableWhitespace, parser_foundInternalEntityDeclarationWithName_value, parser_foundNotationDeclarationWithName_publicID_systemID, parser_foundProcessingInstructionWithTarget_data, parser_foundUnparsedEntityDeclarationWithName_publicID_systemID_notationName, parser_parseErrorOccurred, parser_resolveExternalEntityName_systemID, parser_validationErrorOccurred, parserDidEndDocument, parserDidStartDocument |
| Methods inherited from interface org.rococoa.cocoa.foundation.categories.NSDraggingDestination |
concludeDragOperation, concludeDragOperation, draggingEnded, draggingEnded, draggingEntered, draggingEntered, draggingExited, draggingExited, draggingUpdated, draggingUpdated, performDragOperation, performDragOperation, prepareForDragOperation, prepareForDragOperation, wantsPeriodicDraggingUpdates |
| Methods inherited from interface org.rococoa.cocoa.foundation.categories.NSOutlineViewDataSource |
outlineView_acceptDrop_item_childIndex, outlineView_acceptDrop_item_childIndex, outlineView_child_ofItem, outlineView_isItemExpandable, outlineView_itemForPersistentObject, outlineView_namesOfPromisedFilesDroppedAtDestination_forDraggedItems, outlineView_numberOfChildrenOfItem, outlineView_objectValueForTableColumn_byItem, outlineView_persistentObjectForItem, outlineView_setObjectValue_forTableColumn_byItem, outlineView_sortDescriptorsDidChange, outlineView_validateDrop_proposedItem_proposedChildIndex, outlineView_validateDrop_proposedItem_proposedChildIndex, outlineView_writeItems_toPasteboard |
| Methods inherited from interface org.rococoa.cocoa.foundation.categories.NSURLDownloadDelegate |
download_decideDestinationWithSuggestedFilename, download_didCancelAuthenticationChallenge, download_didCreateDestination, download_didFailWithError, download_didReceiveAuthenticationChallenge, download_didReceiveDataOfLength, download_didReceiveResponse, download_shouldDecodeSourceDataOfMIMEType, download_willResumeWithResponse_fromByte, download_willSendRequest_redirectResponse, downloadDidBegin, downloadDidFinish |
| Methods inherited from interface org.rococoa.cocoa.foundation.categories.NSAccessibility |
accessibilityActionDescription, accessibilityActionNames, accessibilityAttributeNames, accessibilityAttributeValue_forParameter, accessibilityAttributeValue, accessibilityFocusedUIElement, accessibilityIsAttributeSettable, accessibilityIsIgnored, accessibilityParameterizedAttributeNames, accessibilityPerformAction, accessibilitySetValue_forAttribute |
| Methods inherited from interface org.rococoa.cocoa.foundation.categories.NSTextViewDelegate |
textView_clickedOnLink_atIndex, textView_clickedOnLink, textView_doCommandBySelector, textView_menu_forEvent_atIndex, textView_shouldChangeTextInRanges_replacementStrings, textView_shouldChangeTypingAttributes_toAttributes, textView_willChangeSelectionFromCharacterRanges_toCharacterRanges, textView_willDisplayToolTip_forCharacterAtIndex, textView_writablePasteboardTypesForCell_atIndex, textView_writablePasteboardTypesForCell_atIndex, textView_writeCell_atIndex_toPasteboard_type, textView_writeCell_atIndex_toPasteboard_type, textViewDidChangeSelection, textViewDidChangeTypingAttributes, undoManagerForTextView |
| Methods inherited from interface org.rococoa.cocoa.foundation.categories.NSTokenFieldCellDelegate |
tokenFieldCell_completionsForSubstring_indexOfToken_indexOfSelectedItem, tokenFieldCell_completionsForSubstring_indexOfToken_indexOfSelectedItem, tokenFieldCell_displayStringForRepresentedObject, tokenFieldCell_editingStringForRepresentedObject, tokenFieldCell_hasMenuForRepresentedObject, tokenFieldCell_menuForRepresentedObject, tokenFieldCell_readFromPasteboard, tokenFieldCell_representedObjectForEditingString, tokenFieldCell_shouldAddObjects_atIndex, tokenFieldCell_styleForRepresentedObject, tokenFieldCell_writeRepresentedObjects_toPasteboard |
| Methods inherited from interface org.rococoa.cocoa.foundation.categories.NSWindowNotifications |
windowDidBecomeKey, windowDidBecomeMain, windowDidChangeScreen, windowDidChangeScreenProfile, windowDidDeminiaturize, windowDidEndSheet, windowDidExpose, windowDidMiniaturize, windowDidMove, windowDidResignKey, windowDidResignMain, windowDidResize, windowDidUpdate, windowWillBeginSheet, windowWillClose, windowWillMiniaturize, windowWillMove |
NSDocumentController
public NSDocumentController()
sharedDocumentController
public static NSDocumentController sharedDocumentController()
- Return the application's shared document controller. This method will create an instance of NSDocumentController if there is no shared document controller yet. Because the first instance of NSDocumentController to be allocate and initialized during application launch is used as the shared document controller, you have two options for installing an instance of a custom subclass of NSDocumentController as the shared document controller:
1) Instantiate your NSDocumentController subclass in the application's main nib, or
2) Allocate and initialize an instance of your subclass in your application delegate's applicationWillFinishLaunching: method.
Original signature : +(id)sharedDocumentController
init
public abstract NSDocumentController init()
- The designated initializer. The first instance of NSDocumentController to be allocate and initialized during application launch is used as the shared document controller.
Original signature : -(id)init
- Specified by:
init in class NSObject
create
public static NSDocumentController create()
- Factory method
- See Also:
init()
documents
public abstract NSArray documents()
- Return an array of all open documents.
Original signature : -(NSArray*)documents
currentDocument
public abstract NSObject currentDocument()
- Return the active document, or nil if there is no active document. The "active" document is the one corresponding to the key window, or the one corresponding to the main window if the key window has no document.
Original signature : -(id)currentDocument
currentDirectory
public abstract NSString currentDirectory()
- Return the path of the directory containing the active document's file or file package, if there is an active document and it has a file or file package. Return nil otherwise. The default implementation of -URLsFromRunningOpenPanel invokes this to find the current directory to set in the open panel before presenting it.
Original signature : -(NSString*)currentDirectory
documentForURL
public abstract NSObject documentForURL(NSURL absoluteURL)
- Given a URL, return the open document whose file or file package is located by the URL, or nil if there is no such open document. The default implementation of this method queries each open document to find one whose URL matches, and returns the first one whose URL does match.
For backward binary compatibility with Mac OS 10.3 and earlier, the default implementation of this method instead invokes [self documentForFileName:[url path]] if -documentForFileName: is overridden and the URL uses the "file:" scheme.
Original signature : -(id)documentForURL:(NSURL*)
documentForWindow
public abstract NSObject documentForWindow(NSWindow window)
- Given a window, return the document corresponding to the window, nil if no document corrresponds to the window.
Original signature : -(id)documentForWindow:(NSWindow*)
addDocument
public abstract void addDocument(NSDocument document)
- Add or remove a document from the list of open documents. You can override these methods if your application needs to customize what is done when documents are opened and closed. -addDocument is invoked by the default implementations of all NSDocumentController methods whose names start with "open." Your application can invoke -addDocument: manually if it creates a document using something other than one of NSDocument's "open" methods. -removeDocument is invoked by the default implementation of -[NSDocument close].
Original signature : -(void)addDocument:(NSDocument*)
removeDocument
public abstract void removeDocument(NSDocument document)
newDocument
public abstract void newDocument(org.rococoa.ID sender)
- The action of the File menu's New item in a document-based application. The default implementation of this method invokes -openUntitledDocumentAndDisplay:error: and, if nil is returned, presents the error in an application-modal panel.
Original signature : -(void)newDocument:(id)
openUntitledDocumentAndDisplay_error
public abstract NSObject openUntitledDocumentAndDisplay_error(boolean displayDocument,
PointerByReference outError)
- Create a new untitled document, present its user interface if displayDocument is YES, and return the document if successful. If not successful, return nil after setting *outError to an NSError that encapsulates the reason why a new untitled document could not be created. The default implementation of this method invokes [self defaultType] to determine the type of new document to create, invokes -makeUntitledDocumentOfType:error: to create it, then invokes -addDocument: to record its opening. If displayDocument is YES, it then sends the new document -makeWindowControllers and -showWindows messages.
For backward binary compatibility with Mac OS 10.3 and earlier, the default implementation of this method instead invokes [self openUntitledDocumentOfType:[self defaultType] display:displayDocument] if -openUntitledDocumentOfType:display: is overridden.
Original signature : -(id)openUntitledDocumentAndDisplay:(BOOL) error:(NSError**)
makeUntitledDocumentOfType_error
public abstract NSObject makeUntitledDocumentOfType_error(NSString typeName,
PointerByReference outError)
- Instantiate a new untitled document of the specified type and return it if successful. If not successful, return nil after setting *outError to an NSError that encapsulates the reason why a new untitled document could not be instantiated. The default implementation of this method invokes -documentClassForType: to find out the class of document to instantiate, allocates a document object, and initializes it by sending it an -initWithType:error: message.
For backward binary compatibility with Mac OS 10.3 and earlier, the default implementation of this method instead invokes [self makeUntitledDocumentOfType:typeName] if -makeUntitledDocumentOfType: is overridden.
Original signature : -(id)makeUntitledDocumentOfType:(NSString*) error:(NSError**)
openDocument
public abstract void openDocument(org.rococoa.ID sender)
- The action of the File menu's Open... item in a document-based application. The default implementation of this method invokes -URLsFromRunningOpenPanel, unless -fileNamesFromRunningOpenPanel is overridden, in which case that method is invoked instead for backward binary compatibility with Mac OS 10.3 and earlier. If something other than nil is returned, it invokes -openDocumentWithContentsOfURL:display:error: for each URL and, if nil is returned for any of them, presents the error in an application-modal panel and stops trying to open documents.
Original signature : -(void)openDocument:(id)
URLsFromRunningOpenPanel
public abstract NSArray URLsFromRunningOpenPanel()
- Present an application-modal open panel to the user and, if the user selects one or more files and indicates that they are to be opened, return an array of those files' URLs. Return nil otherwise. The default implementation of this method invokes -runModalOpenPanel:forTypes: after it has set up an open panel.
Original signature : -(NSArray*)URLsFromRunningOpenPanel
runModalOpenPanel_forTypes
public abstract int runModalOpenPanel_forTypes(NSOpenPanel openPanel,
NSArray types)
- Present the application-modal open panel to the user, specifying a list of UTIs (in Mac OS 10.5), file name extensions, and encoded HFS file types for openable files. Return NSOKButton or NSCancelButton depending on how the user dismisses the panel.
Original signature : -(NSInteger)runModalOpenPanel:(NSOpenPanel*) forTypes:(NSArray*)
openDocumentWithContentsOfURL_display_error
public abstract NSObject openDocumentWithContentsOfURL_display_error(NSURL absoluteURL,
boolean displayDocument,
PointerByReference outError)
- Open a document located by a URL, present its user interface if displayDocuments is YES, and return the document if successful. If not successful, return nil after setting *outError to an NSError that encapsulates the reason why the document could not be opened. The default implementation of this method checks to see if the document is already open according to -documentForURL:, and if it is not open determines the type of the document, invokes -makeDocumentWithContentsOfURL:ofType:error: to instantiate it, then invokes -addDocument: to record its opening, and sends the document -makeWindowControllers and -showWindows messages if displayDocument is YES. If the document is already open it is just sent a -showWindows message if displayDocument is YES.
For backward binary compatibility with Mac OS 10.3 and earlier, the default implementation of this method instead invokes [self openDocumentWithContentsOfFile:[absoluteURL path] display:displayDocuments], if -openDocumentWithContentsOfFile:display: is overridden and the URL uses the "file:" scheme.
Original signature : -(id)openDocumentWithContentsOfURL:(NSURL*) display:(BOOL) error:(NSError**)
makeDocumentWithContentsOfURL_ofType_error
public abstract NSObject makeDocumentWithContentsOfURL_ofType_error(NSURL absoluteURL,
NSString typeName,
PointerByReference outError)
- Instantiate a document located by a URL, of a specified type, and return it if successful. If not successful, return nil after setting *outError to an NSError that encapsulates the reason why the document could not be instantiated. The default implementation of this method invokes -documentClassForType: to find out the class of document to instantiate, allocates a document object, and initializes it by sending it an -initWithContentsOfURL:ofType:error: message.
For backward binary compatibility with Mac OS 10.3 and earlier, the default implementation of this method instead invokes [self makeDocumentWithContentsOfFile:[absoluteURL path] ofType:typeName] if -makeDocumentWithContentsOfFile:ofType: is overridden and the URL uses the "file:" scheme.
Original signature : -(id)makeDocumentWithContentsOfURL:(NSURL*) ofType:(NSString*) error:(NSError**)
reopenDocumentForURL_withContentsOfURL_error
public abstract boolean reopenDocumentForURL_withContentsOfURL_error(NSURL absoluteDocumentURL,
NSURL absoluteDocumentContentsURL,
PointerByReference outError)
- Reopen a document located by a URL by reading the contents for the document from another URL, present its user interface, and return YES if successful. If not successful, return NO after setting *outError to an NSError that encapsulates the reason why the document could not be reopened. The default implementation of this method determines the type of document being reopened, sends a -makeDocumentForURL:withContentsOfURL:ofType:error: to instantiate it, then invokes -addDocument: to record its opening. It then sends the document -makeWindowControllers and -showWindows messages.
Original signature : -(BOOL)reopenDocumentForURL:(NSURL*) withContentsOfURL:(NSURL*) error:(NSError**)
makeDocumentForURL_withContentsOfURL_ofType_error
public abstract NSObject makeDocumentForURL_withContentsOfURL_ofType_error(NSURL absoluteDocumentURL,
NSURL absoluteDocumentContentsURL,
NSString typeName,
PointerByReference outError)
- Instantiate a document located by a URL, of a specified type, but by reading the contents for the document from another URL, and return it if successful. If not successful, return nil after setting *outError to an NSError that encapsulates the reason why the document could not be instantiated. The default implementation of this method invokes -documentClassForType: to find out the class of document to instantiate, allocates a document object, and initializes it by sending it an -initForURL:withContentsOfURL:ofType:error: message.
Original signature : -(id)makeDocumentForURL:(NSURL*) withContentsOfURL:(NSURL*) ofType:(NSString*) error:(NSError**)
autosavingDelay
public abstract NSObject autosavingDelay()
saveAllDocuments
public abstract void saveAllDocuments(org.rococoa.ID sender)
- The action of the File menu's Save All item in a document-based application. The default implementation of this method sends each modified document a -saveDocumentWithDelegate:didSaveSelector:contextInfo: message.
Original signature : -(void)saveAllDocuments:(id)
hasEditedDocuments
public abstract boolean hasEditedDocuments()
- Return YES if any open document is modified, NO otherwise. This method is invoked at application quitting time, to determine whether -reviewUnsavedDocumentsWithAlertTitle:cancellable:delegate:didReviewAllSelector:contextInfo: should be invoked.
Original signature : -(BOOL)hasEditedDocuments
reviewUnsavedDocumentsWithAlertTitle_cancellable_delegate_didReviewAllSelector_contextInfo
public abstract void reviewUnsavedDocumentsWithAlertTitle_cancellable_delegate_didReviewAllSelector_contextInfo(NSString title,
boolean cancellable,
org.rococoa.ID delegate,
org.rococoa.Selector didReviewAllSelector,
Pointer contextInfo)
- If there is more than one modified document, present an application-modal alert panel telling the user that there are unsaved documents and giving the option of canceling, not saving the documents, or saving the documents. If the user indicates that saving should be done, or if there was only one modified document in the first place, invoke -closeAllDocumentsWithDelegate:didCloseAllSelector:didReviewAll:contextInfo: to attempt to close all modified documents, doing whatever saving is necessary to not lose data. Finally, send the message selected by didReviewAllSelector to the delegate, with the contextInfo as the last argument. The default implementation of this method ignores the passed-in title string (which is passed in only as the result of a historical quirk). The method selected by didReviewAllSelector must have the same signature as:
- (void)documentController:(NSDocumentController *)documentController didReviewAll:(BOOL)didReviewAll contextInfo:(void *)contextInfo;
Original signature : -(void)reviewUnsavedDocumentsWithAlertTitle:(NSString*) cancellable:(BOOL) delegate:(id) didReviewAllSelector:(SEL) contextInfo:(void*)
closeAllDocumentsWithDelegate_didCloseAllSelector_contextInfo
public abstract void closeAllDocumentsWithDelegate_didCloseAllSelector_contextInfo(org.rococoa.ID delegate,
org.rococoa.Selector didCloseAllSelector,
Pointer contextInfo)
- For each open, modified, document present a document-modal alert panel asking whether the document should be saved and giving the option of canceling, not saving the document, or saving the document. Stop presenting alert panels if the user indicates cancellation in any one of them. The default implementation of this merely sends each open document -canCloseDocumentWithDelegate:shouldCloseSelector:contextInfo: and -close messages until one of them cannot be closed. The method selected by didCloseAllSelector must have the same signature as:
- (void)documentController:(NSDocumentController *)documentController didCloseAll:(BOOL)didCloseAll contextInfo:(void *)contextInfo;
Original signature : -(void)closeAllDocumentsWithDelegate:(id) didCloseAllSelector:(SEL) contextInfo:(void*)
presentError_modalForWindow_delegate_didPresentSelector_contextInfo
public abstract void presentError_modalForWindow_delegate_didPresentSelector_contextInfo(NSError error,
NSWindow window,
org.rococoa.ID delegate,
org.rococoa.Selector didPresentSelector,
Pointer contextInfo)
- Methods that are declared by NSResponder and also implemented by NSDocumentController, even though for historical reasons NSDocumentController is not a subclass of NSResponder. NSDocumentController's default implementations are equivalent to NSResponder's while treating the application object as the "next responder" and forwarding error presentation messages to it.
NSDocument has overrides of -presentError:modalForWindow:delegate:didPresentSelector:contextInfo: and -presentError: that treat the shared document controller as the "next responder" and forward these messages it.
The default implementations of several NSDocumentController methods invoke -presentError:.
You can customize the presentation of errors for all kinds of documents by overriding -willPresentError:. Your override should follow the advice given for overriding of -[NSResponder willPresentError:].
Original signature : -(void)presentError:(NSError*) modalForWindow:(NSWindow*) delegate:(id) didPresentSelector:(SEL) contextInfo:(void*)
presentError
public abstract boolean presentError(NSError error)
willPresentError
public abstract NSError willPresentError(NSError error)
maximumRecentDocumentCount
public abstract int maximumRecentDocumentCount()
- Return the maximum number of items that may be presented in the standard Open Recent menu. A value of 0 indicates that NSDocumentController will not attempt to add an Open Recent menu to your application's File menu, though NSDocumentController will not attempt to remove any Open Recent menu item if there is one already there. The default implementation returns a value that is subject to change and may or may not be derived from a setting made by the user in a System Preferences panel.
Original signature : -(NSUInteger)maximumRecentDocumentCount
clearRecentDocuments
public abstract void clearRecentDocuments(org.rococoa.ID sender)
- The action of the Open Recent menu's Clear Menu item.
Original signature : -(void)clearRecentDocuments:(id)
noteNewRecentDocument
public abstract void noteNewRecentDocument(NSDocument document)
- Add an item corresponding to a document to the Open Recent menu, or replace an existing item for the same document.
Original signature : -(void)noteNewRecentDocument:(NSDocument*)
noteNewRecentDocumentURL
public abstract void noteNewRecentDocumentURL(NSURL absoluteURL)
- Add an item corresponding to the data located by a URL to the Open Recent menu, or replace an existing item with the same URL. You can use this even in non-NSDocument-based applications.
Original signature : -(void)noteNewRecentDocumentURL:(NSURL*)
recentDocumentURLs
public abstract NSArray recentDocumentURLs()
- Return an array of URLs for the entries currently appearing in the Open Recent menu.
Original signature : -(NSArray*)recentDocumentURLs
defaultType
public abstract NSString defaultType()
- Return the name of the document type that should be used when creating new documents. The default implementation of this method returns the first Editor type declared in the application's Info.plist, or returns nil if no Editor type is declared. You can override it to customize the type of document that is created when, for instance, the user chooses New in the File menu.
Original signature : -(NSString*)defaultType
typeForContentsOfURL_error
public abstract NSString typeForContentsOfURL_error(NSURL inAbsoluteURL,
PointerByReference outError)
- Given a URL, return the name of the document type that should be used when opening the document at that location, if successful. If not successful, return nil after setting *outError to an NSError that encapsulates the reason why the document's type could not be determined, or the fact that the document's type is just unrecognized. The default implementation of this method merely invokes -[NSWorkspace typeOfFile:error:]. You can override this to customize type determination for documents being opened.
For backward binary compatibility with Mac OS 10.4 and earlier, the default implementation of this method actually first does the same thing that it did in Mac OS 10.4 (invoke -typeFromFileExtension:, possibly twice, passing an HFS file type string for the second invocation) if there are any CFBundleDocumentTypes Info.plist entries that don't have LSItemContentTypes subentries, and only invokes -[NSWorkspace typeOfFile:error:] if that does not succeed.
Original signature : -(NSString*)typeForContentsOfURL:(NSURL*) error:(NSError**)
documentClassNames
public abstract NSArray documentClassNames()
- Return the names of NSDocument subclasses supported by this application. The default implementation of this method returns information derived from the application's Info.plist. You can override it to return the names of document classes that are dynamically loaded from plugins.
Original signature : -(NSArray*)documentClassNames
documentClassForType
public abstract Pointer documentClassForType(NSString typeName)
- Given a document type name, return the subclass of NSDocument that should be instantiated when opening a document of that type, or nil for failure.
Original signature : -(Class)documentClassForType:(NSString*)
displayNameForType
public abstract NSString displayNameForType(NSString typeName)
- Given a document type name, return a string describing the document type that is fit to present to the user, or nil for failure.
Original signature : -(NSString*)displayNameForType:(NSString*)
validateUserInterfaceItem
@Deprecated
public abstract boolean validateUserInterfaceItem(org.rococoa.ID anItem)
- Deprecated. use the safer method
validateUserInterfaceItem(org.rococoa.cocoa.appkit.protocols.NSValidatedUserInterfaceItem) instead
- Conformance to the NSUserInterfaceValidations protocol. NSDocumentController's implementation of this method conditionally enables menu items for all of the action methods listed in this header file, as well as the private action method for Open Recent menu items.
Original signature : -(BOOL)validateUserInterfaceItem:(id)
- Specified by:
validateUserInterfaceItem in interface NSUserInterfaceValidations
validateUserInterfaceItem
public abstract boolean validateUserInterfaceItem(NSValidatedUserInterfaceItem anItem)
- Conformance to the NSUserInterfaceValidations protocol. NSDocumentController's implementation of this method conditionally enables menu items for all of the action methods listed in this header file, as well as the private action method for Open Recent menu items.
Original signature : -(BOOL)validateUserInterfaceItem:(id)
- Specified by:
validateUserInterfaceItem in interface NSUserInterfaceValidations
alloc
public static NSDocumentController alloc()