com.xmlmind.xmleditapp.desktop.part

Class MasterDocumentManager

java.lang.Object

com.xmlmind.xmleditapp.desktop.AppPartBase

com.xmlmind.xmleditapp.desktop.part.MasterDocumentManager

All Implemented Interfaces:

AppDocumentTypeDetector.Listener, AppPart, OpenedDocumentHook, OpenedDocumentHook2

public final class MasterDocumentManager
extends AppPartBase
implements OpenedDocumentHook2, AppDocumentTypeDetector.Listener

Field Summary

Fields inherited from class com.xmlmind.xmleditapp.desktop.AppPartBase

app, id

Constructor Summary

Constructors

Constructor and Description
MasterDocumentManager()

Method Summary

Modifier and Type	Method and Description
static DocumentSet	addDocumentSet(App app, OpenedDocument openedDoc)
boolean	checkingDocument(OpenedDocument openedDoc) Invoked before specified OpenedDocument is checked for validity.
boolean	closingDocument(OpenedDocument openedDoc) Invoked before specified OpenedDocument is being closed.
boolean	creatingDocument(OpenedDocument openedDoc, URL templateURL) Invoked before a specified OpenedDocument is ``created''.
void	detectedDocumentType(Element rootElement, DTDSpec dtdSpec, Configuration configuration, DocumentTypeSpec documentTypeSpec)
Diagnostic[]	documentChecked(OpenedDocument openedDoc, HookStatus status, Diagnostic[] diagnostics) Invoked after specified OpenedDocument has been checked for validity.
void	documentClosed(OpenedDocument openedDoc, HookStatus status) Invoked after specified OpenedDocument has been closed.
void	documentCreated(OpenedDocument openedDoc, HookStatus status) Invoked after specified OpenedDocument has been ``created''.
void	documentDisposed(OpenedDocument openedDoc) Invoked after specified OpenedDocument has been disposed.
void	documentEvent(OpenedDocument openedDoc, DocumentEvent event) A DocumentEvent has been received by openedDoc which then forwards it to this hook.
void	documentOpened(OpenedDocument openedDoc, HookStatus status) Invoked after specified OpenedDocument has been ``opened''.
void	documentSaved(OpenedDocument openedDoc, HookStatus status) Invoked after specified OpenedDocument has been saved.
void	documentSavedAs(OpenedDocument openedDoc, HookStatus status) Invoked after specified OpenedDocument has been saved to a different location.
static DocumentSet	getDocumentSet(OpenedDocument openedDoc)
static DocumentSetFactory	getDocumentSetFactory(OpenedDocument openedDoc)
void	initApp(App app, String id) Specifies the App containing this part and the unique ID of this part within the App.
static Boolean	isAutoCreateDocumentSetFactory(App app, OpenedDocument openedDoc)
boolean	openingDocument(OpenedDocument openedDoc, URL openURL, boolean readOnly) Invoked before a specified OpenedDocument is ``opened''.
static void	reloadDocumentSet(App app, DocumentSet docSet, OpenedDocument masterDoc)
static void	removeDocumentSet(App app, DocumentSet docSet, OpenedDocument masterDoc)
boolean	savingDocument(OpenedDocument openedDoc) Invoked before specified OpenedDocument is being saved.
boolean	savingDocumentAs(OpenedDocument openedDoc, URL saveURL) Invoked before specified OpenedDocument is being saved to a different location.
static void	updateDocumentSet(App app, DocumentSet docSet, OpenedDocument masterDoc)

Methods inherited from class com.xmlmind.xmleditapp.desktop.AppPartBase

activeEditorChanged, applyPreferences, destroyApp, editingContextChanged, flushPreferences, getApp, getId, isEditingContextSensitive, namespacePrefixesChanged, saveStateChanged, undoStateChanged, validityStateChanged

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MasterDocumentManager

public MasterDocumentManager()

Method Detail

initApp

public void initApp(App app,
                    String id)

Description copied from class: AppPartBase

Specifies the App containing this part and the unique ID of this part within the App. Invoked when the component is attached to the App.

Default implementation simply stores its arguments in AppPartBase.app and AppPartBase.id.

Specified by:

initApp in interface AppPart

Overrides:

initApp in class AppPartBase

See Also:

AppPart.getApp(), AppPart.getId(), App.getPart(java.lang.String)

detectedDocumentType

public void detectedDocumentType(Element rootElement,
                                 DTDSpec dtdSpec,
                                 Configuration configuration,
                                 DocumentTypeSpec documentTypeSpec)

Specified by:

detectedDocumentType in interface AppDocumentTypeDetector.Listener

openingDocument

public boolean openingDocument(OpenedDocument openedDoc,
                               URL openURL,
                               boolean readOnly)

Description copied from interface: OpenedDocumentHook

Invoked before a specified OpenedDocument is ``opened''.

Receiving this notification guarantees that OpenedDocumentHook.documentOpened(com.xmlmind.xmleditapp.desktop.OpenedDocument, com.xmlmind.xmleditapp.desktop.HookStatus) will also being invoked, even if the status passed to this method may be different from HookStatus.SUCCESS.

Specified by:

openingDocument in interface OpenedDocumentHook

Parameters:

openedDoc - OpenedDocument which is the subject of this event

openURL - URL of the document to be opened

readOnly - if true, the document is to be opened in read-only mode

Returns:

false if this operation is vetoed by this hook; true otherwise

See Also:

OpenedDocument.open(java.net.URL, boolean)

documentOpened

public void documentOpened(OpenedDocument openedDoc,
                           HookStatus status)

Description copied from interface: OpenedDocumentHook

Invoked after specified OpenedDocument has been ``opened''.

This method is invoked before an UndoManager is added to the newly opened Document. Therefore it's possible to modify the document in this method.

Specified by:

documentOpened in interface OpenedDocumentHook

Parameters:

openedDoc - OpenedDocument which is the subject of this event

status - status of this operation

See Also:

OpenedDocument.open(java.net.URL, boolean)

savingDocument

public boolean savingDocument(OpenedDocument openedDoc)

Description copied from interface: OpenedDocumentHook

Invoked before specified OpenedDocument is being saved.

Receiving this notification guarantees that OpenedDocumentHook.documentSaved(com.xmlmind.xmleditapp.desktop.OpenedDocument, com.xmlmind.xmleditapp.desktop.HookStatus) will also being invoked, even if the status passed to this method may be different from HookStatus.SUCCESS.

Specified by:

savingDocument in interface OpenedDocumentHook

Parameters:

openedDoc - OpenedDocument which is the subject of this event

Returns:

false if this operation is vetoed by this hook; true otherwise

See Also:

OpenedDocument.save()

documentSaved

public void documentSaved(OpenedDocument openedDoc,
                          HookStatus status)

Description copied from interface: OpenedDocumentHook

Invoked after specified OpenedDocument has been saved.

Specified by:

documentSaved in interface OpenedDocumentHook

Parameters:

openedDoc - OpenedDocument which is the subject of this event

status - status of this operation

See Also:

OpenedDocument.save()

savingDocumentAs

public boolean savingDocumentAs(OpenedDocument openedDoc,
                                URL saveURL)

Description copied from interface: OpenedDocumentHook

Invoked before specified OpenedDocument is being saved to a different location.

Receiving this notification guarantees that OpenedDocumentHook.documentSavedAs(com.xmlmind.xmleditapp.desktop.OpenedDocument, com.xmlmind.xmleditapp.desktop.HookStatus) will also being invoked, even if the status passed to this method may be different from HookStatus.SUCCESS.

Specified by:

savingDocumentAs in interface OpenedDocumentHook

Parameters:

openedDoc - OpenedDocument which is the subject of this event

saveURL - URL where the document is to be saved

Returns:

false if this operation is vetoed by this hook; true otherwise

See Also:

OpenedDocument.saveAs(java.net.URL)

documentSavedAs

public void documentSavedAs(OpenedDocument openedDoc,
                            HookStatus status)

Description copied from interface: OpenedDocumentHook

Invoked after specified OpenedDocument has been saved to a different location.

Specified by:

documentSavedAs in interface OpenedDocumentHook

Parameters:

openedDoc - OpenedDocument which is the subject of this event

status - status of this operation

See Also:

OpenedDocument.saveAs(java.net.URL)

closingDocument

public boolean closingDocument(OpenedDocument openedDoc)

Description copied from interface: OpenedDocumentHook

Invoked before specified OpenedDocument is being closed.

Receiving this notification guarantees that OpenedDocumentHook.documentClosed(com.xmlmind.xmleditapp.desktop.OpenedDocument, com.xmlmind.xmleditapp.desktop.HookStatus) will also being invoked, even if the status passed to this method may be different from HookStatus.SUCCESS.

Specified by:

closingDocument in interface OpenedDocumentHook

Parameters:

openedDoc - OpenedDocument which is the subject of this event

Returns:

false if this operation is vetoed by this hook; true otherwise

See Also:

OpenedDocument.close()

documentClosed

public void documentClosed(OpenedDocument openedDoc,
                           HookStatus status)

Description copied from interface: OpenedDocumentHook

Invoked after specified OpenedDocument has been closed.

Specified by:

documentClosed in interface OpenedDocumentHook

Parameters:

openedDoc - OpenedDocument which is the subject of this event

status - status of this operation

See Also:

OpenedDocument.close()

documentEvent

public void documentEvent(OpenedDocument openedDoc,
                          DocumentEvent event)

Description copied from interface: OpenedDocumentHook2

A DocumentEvent has been received by openedDoc which then forwards it to this hook.

Specified by:

documentEvent in interface OpenedDocumentHook2

Parameters:

openedDoc - the OpenedDocument forwarding the DocumentEvent

event - contains the ``message'' sent by the invoker

creatingDocument

public boolean creatingDocument(OpenedDocument openedDoc,
                                URL templateURL)

Description copied from interface: OpenedDocumentHook

Invoked before a specified OpenedDocument is ``created''.

Receiving this notification guarantees that OpenedDocumentHook.documentCreated(com.xmlmind.xmleditapp.desktop.OpenedDocument, com.xmlmind.xmleditapp.desktop.HookStatus) will also being invoked, even if the status passed to this method may be different from HookStatus.SUCCESS.

Specified by:

creatingDocument in interface OpenedDocumentHook

Parameters:

openedDoc - OpenedDocument which is the subject of this event

templateURL - URL of the document template

Returns:

false if this operation is vetoed by this hook; true otherwise

See Also:

OpenedDocument.newFromTemplate(java.net.URL)

documentCreated

public void documentCreated(OpenedDocument openedDoc,
                            HookStatus status)

Description copied from interface: OpenedDocumentHook

Invoked after specified OpenedDocument has been ``created''.

This method is invoked before an UndoManager is added to the newly created Document. Therefore it's possible to modify the document in this method.

Specified by:

documentCreated in interface OpenedDocumentHook

Parameters:

openedDoc - OpenedDocument which is the subject of this event

status - status of this operation

See Also:

OpenedDocument.newFromTemplate(java.net.URL)

checkingDocument

public boolean checkingDocument(OpenedDocument openedDoc)

Description copied from interface: OpenedDocumentHook

Invoked before specified OpenedDocument is checked for validity.

Receiving this notification guarantees that OpenedDocumentHook.documentChecked(com.xmlmind.xmleditapp.desktop.OpenedDocument, com.xmlmind.xmleditapp.desktop.HookStatus, com.xmlmind.xml.validate.Diagnostic[]) will also being invoked, even if the status passed to this method may be different from HookStatus.SUCCESS.

Specified by:

checkingDocument in interface OpenedDocumentHook

Parameters:

openedDoc - OpenedDocument which is the subject of this event

Returns:

false if this operation is vetoed by this hook; true otherwise

See Also:

OpenedDocument.checkValidity(com.xmlmind.xmleditapp.validatehook.Reason, java.net.URL)

documentChecked

public Diagnostic[] documentChecked(OpenedDocument openedDoc,
                                    HookStatus status,
                                    Diagnostic[] diagnostics)

Description copied from interface: OpenedDocumentHook

Invoked after specified OpenedDocument has been checked for validity.

This method can be used to implement semantic validation. Such validation method must append semantic warnings (Diagnostic.Severity#SEMANTIC_WARNING) and errors (Diagnostic.Severity#SEMANTIC_ERROR) to the list of validity warnings and errors passed as third argument.

Specified by:

documentChecked in interface OpenedDocumentHook

Parameters:

openedDoc - OpenedDocument which is the subject of this event

status - status of this operation

diagnostics - (possibly empty) list of warnings and errors found during validation

Returns:

possibly augmented list of diagnostics

See Also:

OpenedDocument.checkValidity(com.xmlmind.xmleditapp.validatehook.Reason, java.net.URL)

documentDisposed

public void documentDisposed(OpenedDocument openedDoc)

Description copied from interface: OpenedDocumentHook

Invoked after specified OpenedDocument has been disposed.

Specified by:

documentDisposed in interface OpenedDocumentHook

Parameters:

openedDoc - OpenedDocument which is the subject of this event.

The state of openedDoc has already been cleared. For example, openedDoc.getDocument() returns null.

See Also:

OpenedDocument.dispose()

addDocumentSet

public static DocumentSet addDocumentSet(App app,
                                         OpenedDocument openedDoc)

getDocumentSetFactory

public static DocumentSetFactory getDocumentSetFactory(OpenedDocument openedDoc)

isAutoCreateDocumentSetFactory

public static Boolean isAutoCreateDocumentSetFactory(App app,
                                                     OpenedDocument openedDoc)

updateDocumentSet

public static void updateDocumentSet(App app,
                                     DocumentSet docSet,
                                     OpenedDocument masterDoc)

reloadDocumentSet

public static void reloadDocumentSet(App app,
                                     DocumentSet docSet,
                                     OpenedDocument masterDoc)

removeDocumentSet

public static void removeDocumentSet(App app,
                                     DocumentSet docSet,
                                     OpenedDocument masterDoc)

getDocumentSet

public static DocumentSet getDocumentSet(OpenedDocument openedDoc)