CPDocument Class Reference

List of all members.

Public Member Functions

(id) - init [implementation]
(id) - initWithType:error: [implementation]
(id) - initWithContentsOfURL:ofType:delegate:didReadSelector:contextInfo: [implementation]
(id) - initForURL:withContentsOfURL:ofType:delegate:didReadSelector:contextInfo: [implementation]
(CPData- dataOfType:error: [implementation]
(void) - readFromData:ofType:error: [implementation]
(void) - makeWindowControllers [implementation]
(CPArray- windowControllers [implementation]
(void) - addWindowController: [implementation]
(void) - showWindows [implementation]
(CPString- displayName [implementation]
(CPString- windowCibName [implementation]
(void) - windowControllerDidLoadNib: [implementation]
(void) - windowControllerWillLoadNib: [implementation]
(void) - readFromURL:ofType:delegate:didReadSelector:contextInfo: [implementation]
(CPURL) - fileURL [implementation]
(void) - setFileURL: [implementation]
(void) - saveToURL:ofType:forSaveOperation:delegate:didSaveSelector:contextInfo: [implementation]
(void) - connection:didReceiveResponse: [implementation]
(void) - connection:didReceiveData: [implementation]
(void) - connection:didFailWithError: [implementation]
(void) - connectionDidFinishLoading: [implementation]
(BOOL) - isDocumentEdited [implementation]
(void) - updateChangeCount: [implementation]
(void) - setFileType: [implementation]
(CPString- fileType [implementation]
(BOOL) - hasUndoManager [implementation]
(void) - setHasUndoManager: [implementation]
(void) - setUndoManager: [implementation]
(CPUndoManager- undoManager [implementation]
(CPUndoManager- windowWillReturnUndoManager: [implementation]
(void) - saveDocument: [implementation]
(void) - saveDocumentAs: [implementation]
(void) - document:didSave:contextInfo: [implementation]


Detailed Description

CPDocument is used to represent a document/file in a Cappuccino application. In a document-based application, generally multiple documents are open simutaneously (multiple text documents, slide presentations, spreadsheets, etc.), and multiple CPDocuments should be used to represent this.

Definition at line 90 of file CPDocument.j.


Member Function Documentation

- (void) addWindowController: (CPWindowController aWindowController   [implementation]

Add a controller to the document's list of controllers. This should be called after making a new window controller.

Parameters:
aWindowController the controller to add

Definition at line 247 of file CPDocument.j.

- (void) connection: (CPURLConnection aConnection
didFailWithError: (CPError)  anError 
[implementation]

Definition at line 464 of file CPDocument.j.

- (void) connection: (CPURLConnection aConnection
didReceiveData: (CPString aData 
[implementation]

Definition at line 438 of file CPDocument.j.

- (void) connection: (CPURLConnection aConnection
didReceiveResponse: (CPURLResponse aResponse 
[implementation]

Definition at line 387 of file CPDocument.j.

- (void) connectionDidFinishLoading: (CPURLConnection aConnection   [implementation]

Definition at line 491 of file CPDocument.j.

- (CPData) dataOfType: (CPString aType
error: ({CPError})  anError 
[implementation]

Returns the receiver's data in a specified type. The default implementation just throws an exception.

Parameters:
aType the format of the data
anError not used
Exceptions:
CPUnsupportedMethodException if this method hasn't been overriden by the subclass
Returns:
the document data

Definition at line 202 of file CPDocument.j.

- (CPString) displayName   [implementation]

Returns the name of the document as displayed in the title bar.

Definition at line 270 of file CPDocument.j.

- (void) document: (id)  aDocument
didSave: (BOOL)  didSave
contextInfo: (id)  aContextInfo 
[implementation]

Definition at line 702 of file CPDocument.j.

- (CPString) fileType   [implementation]

Returns the document's file type

Definition at line 538 of file CPDocument.j.

- (CPURL) fileURL   [implementation]

Returns the path to the document's file.

Definition at line 330 of file CPDocument.j.

- (BOOL) hasUndoManager   [implementation]

Returns YES if the document has a CPUndoManager.

Definition at line 548 of file CPDocument.j.

- (id) init   [implementation]

Initializes an empty document.

Returns:
the initialized document

Definition at line 110 of file CPDocument.j.

- (id) initForURL: (CPURL)  anAbsoluteURL
withContentsOfURL: (CPURL)  absoluteContentsURL
ofType: (CPString aType
delegate: (id)  aDelegate
didReadSelector: (SEL)  aDidReadSelector
contextInfo: (id)  aContextInfo 
[implementation]

Initializes the document from a URL.

Parameters:
anAbsoluteURL the document location
absoluteContentsURL the location of the document's contents
aType the type of the contents
aDelegate this object will receive a callback after the document's contents are loaded
aDidReadSelector the message selector that will be sent to aDelegate
aContextInfo passed as the argument to the message sent to the aDelegate
Returns:
the initialized document

Definition at line 179 of file CPDocument.j.

- (id) initWithContentsOfURL: (CPURL)  anAbsoluteURL
ofType: (CPString aType
delegate: (id)  aDelegate
didReadSelector: (SEL)  aDidReadSelector
contextInfo: (id)  aContextInfo 
[implementation]

Initializes a document of a specific type located at a URL. Notifies the provided delegate after initialization.

Parameters:
anAbsoluteURL the url of the document content
aType the type of document located at the URL
aDelegate the delegate to notify
aDidReadSelector the selector used to notify the delegate
aContextInfo context information passed to the delegate after initialization
Returns:
the initialized document

Definition at line 154 of file CPDocument.j.

- (id) initWithType: (CPString aType
error: ({CPError})  anError 
[implementation]

Initializes the document with a specific data type.

Parameters:
aType the type of document to initialize
anError not used
Returns:
the initialized document

Definition at line 133 of file CPDocument.j.

- (BOOL) isDocumentEdited   [implementation]

Returns YES if there are any unsaved changes.

Definition at line 501 of file CPDocument.j.

- (void) makeWindowControllers   [implementation]

Creates the window controller for this document.

Definition at line 227 of file CPDocument.j.

- (void) readFromData: (CPData aData
ofType: (CPString aType
error: (CPError)  anError 
[implementation]

Sets the content of the document by reading the provided data. The default implementation just throws an exception.

Parameters:
aData the document's data
aType the document type
anError not used
Exceptions:
CPUnsupportedMethodException if this method hasn't been overridden by the subclass

Definition at line 217 of file CPDocument.j.

- (void) readFromURL: (CPURL)  anAbsoluteURL
ofType: (CPString aType
delegate: (id)  aDelegate
didReadSelector: (SEL)  aDidReadSelector
contextInfo: (id)  aContextInfo 
[implementation]

Set the document's data from a URL. Notifies the provided delegate afterwards.

Parameters:
anAbsoluteURL the URL to the document's content
aType the document type
aDelegate delegate to notify after reading the data
aDidReadSelector message that will be sent to the delegate
aContextInfo context information that gets sent to the delegate

Definition at line 317 of file CPDocument.j.

- (void) saveDocument: (id)  aSender   [implementation]

Saves the document. If the document does not have a file path to save to (fileURL) then saveDocumentAs: will be called.

Parameters:
aSender the object requesting the save

Definition at line 667 of file CPDocument.j.

- (void) saveDocumentAs: (id)  aSender   [implementation]

Saves the document to a user specified path.

Parameters:
aSender the object requesting the operation

Definition at line 685 of file CPDocument.j.

- (void) saveToURL: (CPURL)  anAbsoluteURL
ofType: (CPString aTypeName
forSaveOperation: (CPSaveOperationType)  aSaveOperation
delegate: (id)  aDelegate
didSaveSelector: (SEL)  aDidSaveSelector
contextInfo: (id)  aContextInfo 
[implementation]

Saves the document to the specified URL. Notifies the provided delegate with the provided selector and context info afterwards.

Parameters:
anAbsoluteURL the url to write the document data to
aTypeName the document type
aSaveOperation the type of save operation
aDelegate the delegate to notify after saving
aDidSaveSelector the selector to send the delegate
aContextInfo context info that gets passed to the delegate

Definition at line 359 of file CPDocument.j.

- (void) setFileType: (CPString aType   [implementation]

Sets the document's file type

Parameters:
aType the document's type

Definition at line 530 of file CPDocument.j.

- (void) setFileURL: (CPURL)  aFileURL   [implementation]

Sets the path to the document's file.

Parameters:
aFileURL the path to the document's file

Definition at line 339 of file CPDocument.j.

- (void) setHasUndoManager: (BOOL)  aFlag   [implementation]

Sets whether the document should have a CPUndoManager.

Parameters:
aFlag YES makes the document have an undo manager

Definition at line 557 of file CPDocument.j.

- (void) setUndoManager: (CPUndoManager anUndoManager   [implementation]

Definition at line 596 of file CPDocument.j.

- (void) showWindows   [implementation]

Shows all the document's windows.

Definition at line 262 of file CPDocument.j.

- (CPUndoManager) undoManager   [implementation]

Returns the document's undo manager. If the document should have one, but the manager is nil, it will be created and then returned.

Returns:
the document's undo manager

Definition at line 643 of file CPDocument.j.

- (void) updateChangeCount: (CPDocumentChangeType)  aChangeType   [implementation]

Updates the number of unsaved changes to the document.

Parameters:
aChangeType a new document change to apply

Definition at line 510 of file CPDocument.j.

- (CPString) windowCibName   [implementation]

Returns the document's Cib name

Definition at line 287 of file CPDocument.j.

- (void) windowControllerDidLoadNib: (CPWindowController aWindowController   [implementation]

Called after aWindowController loads the document's Nib file.

Parameters:
aWindowController the controller that loaded the Nib file

Definition at line 296 of file CPDocument.j.

- (CPArray) windowControllers   [implementation]

Returns the document's window controllers

Definition at line 237 of file CPDocument.j.

- (void) windowControllerWillLoadNib: (CPWindowController aWindowController   [implementation]

Called before aWindowController will load the document's Nib file.

Parameters:
aWindowController the controller that will load the Nib file

Definition at line 304 of file CPDocument.j.

- (CPUndoManager) windowWillReturnUndoManager: (CPWindow aWindow   [implementation]

Definition at line 655 of file CPDocument.j.


The documentation for this class was generated from the following file:

Generated on Thu Dec 11 01:55:50 2008 for Cappuccino by  doxygen 1.5.7.1