com.xmlmind.xmleditext.profiling

Class ProfilingHook

java.lang.Object

com.xmlmind.xmleditext.profiling.ProfilingHook

All Implemented Interfaces:

Traversal.Handler, OpenedDocumentHook, OpenedDocumentHook2

public final class ProfilingHook
extends Object
implements OpenedDocumentHook2, Traversal.Handler

Constructor Summary

Constructors

Constructor and Description
ProfilingHook()

Method Summary

Modifier and Type	Method and Description
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''.
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.
Object	enterElement(Element element) Invoked to signal that an element is being entered.
Object	leaveElement(Element element) Invoked to signal that an element is being leaved.
boolean	openingDocument(OpenedDocument openedDoc, URL openURL, boolean readOnly) Invoked before a specified OpenedDocument is ``opened''.
Object	processComment(Comment comment) Invoked to signal the traversal of a Comment node.
Object	processPI(ProcessingInstruction pi) Invoked to signal the traversal of a ProcessingInstruction node.
Object	processText(Text text) Invoked to signal the traversal of a Text node.
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProfilingHook

public ProfilingHook()

Method Detail

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)

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)

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)

enterElement

public Object enterElement(Element element)

Description copied from interface: Traversal.Handler

Invoked to signal that an element is being entered.

Specified by:

enterElement in interface Traversal.Handler

Parameters:

element - Element being entered

Returns:

Traversal.LEAVE_ELEMENT to skip this element or a value other than null to stop the traversal or null to continue the traversal

processText

public Object processText(Text text)

Description copied from interface: Traversal.Handler

Invoked to signal the traversal of a Text node.

Specified by:

processText in interface Traversal.Handler

Parameters:

text - Text node being traversed

Returns:

a value other than null to stop the traversal or null to continue the traversal

processPI

public Object processPI(ProcessingInstruction pi)

Description copied from interface: Traversal.Handler

Invoked to signal the traversal of a ProcessingInstruction node.

Specified by:

processPI in interface Traversal.Handler

Parameters:

pi - ProcessingInstruction node being traversed

Returns:

a value other than null to stop the traversal or null to continue the traversal

processComment

public Object processComment(Comment comment)

Description copied from interface: Traversal.Handler

Invoked to signal the traversal of a Comment node.

Specified by:

processComment in interface Traversal.Handler

Parameters:

comment - Comment node being traversed

Returns:

a value other than null to stop the traversal or null to continue the traversal

leaveElement

public Object leaveElement(Element element)

Description copied from interface: Traversal.Handler

Invoked to signal that an element is being leaved.

Specified by:

leaveElement in interface Traversal.Handler

Parameters:

element - Element being leaved

Returns:

a value other than null to stop the traversal or null to continue the traversal

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()

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)

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()

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()

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()

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