ro.sync.exml.workspace.api.listeners

Class WSEditorListener

java.lang.Object

ro.sync.exml.workspace.api.listeners.WSEditorPageChangedListener

ro.sync.exml.workspace.api.listeners.WSEditorListener

@API(type=EXTENDABLE,
     src=PUBLIC)
public class WSEditorListener
extends WSEditorPageChangedListener

WS Editor listener. The listener is added to a WSEditor and receives different callbacks.

Since:

13

Field Summary

Fields

Modifier and Type	Field and Description
static int	SAVE_AS_OPERATION Operation type used to signal that an editor was saved as another resource.
static int	SAVE_OPERATION Operation type used to signal that an editor was saved.

Constructor Summary

Constructors

Constructor and Description
WSEditorListener()

Method Summary

Modifier and Type	Method and Description
void	documentTypeExtensionsReconfigured() The editor document type-specific functionality was refreshed.
boolean	editorAboutToBeClosedVeto(java.net.URL editorLocation) The editor is about to be closed.
boolean	editorAboutToBeSavedVeto(int operationType) The editor is about to be saved.
void	editorReloaded(java.net.URL editorURL) The content of the document has been reloaded.
void	editorSaved(int operationType) The editor was saved.

Methods inherited from class ro.sync.exml.workspace.api.listeners.WSEditorPageChangedListener

editorPageAboutToBeChangedVeto, editorPageChanged

Methods inherited from class java.lang.Object

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

Field Detail

SAVE_OPERATION

public static final int SAVE_OPERATION

Operation type used to signal that an editor was saved.

See Also:

Constant Field Values

SAVE_AS_OPERATION

public static final int SAVE_AS_OPERATION

Operation type used to signal that an editor was saved as another resource.

See Also:

Constant Field Values

Constructor Detail

WSEditorListener

public WSEditorListener()

Method Detail

editorAboutToBeSavedVeto

public boolean editorAboutToBeSavedVeto(int operationType)

The editor is about to be saved.

Parameters:

operationType - The operation type. One of the constants SAVE_AS_OPERATION or SAVE_OPERATION.

Returns:

true to continue saving it, false to cancel the save operation.

editorSaved

public void editorSaved(int operationType)

The editor was saved.

Parameters:

operationType - The operation type. One of the constants SAVE_AS_OPERATION or SAVE_OPERATION.

documentTypeExtensionsReconfigured

public void documentTypeExtensionsReconfigured()

The editor document type-specific functionality was refreshed. For example after a document is opened, the application will re-configure the framework-specific toolbar. After this, the callback will be received. So if you are using code which for example tries to add a listener to one of the actions on the framework-specific toolbar, the code should re-add the listener when the callback is received.

Since:

18

editorAboutToBeClosedVeto

public boolean editorAboutToBeClosedVeto(java.net.URL editorLocation)

The editor is about to be closed. Decide if the closing should proceed or not.

This method is not called from the Eclipse plug-in. It works only with the stand-alone application.

Parameters:

editorLocation - The URL of the editor.

Returns:

true to continue closing it, false to cancel the closing of the editor.

Since:

19.1

editorReloaded

public void editorReloaded(java.net.URL editorURL)

The content of the document has been reloaded. Probably F5 was pressed.

Parameters:

editorURL - The URL for which the content has been reloaded.

Since:

22
*********************************
EXPERIMENTAL - Subject to change
********************************

Please note that this API is not marked as final and it can change in one of the next versions of the application. If you have suggestions, comments about it, please let us know.