Oxygen XML Editor 12.2 Author API

ro.sync.exml.workspace.api.listeners
Class WSEditorChangeListener

java.lang.Object
  extended by ro.sync.exml.workspace.api.listeners.WSEditorChangeListener

public class WSEditorChangeListener
extends java.lang.Object

Notified when an editor is added, removed or the editor page is changed

Since:
11.2

Constructor Summary
WSEditorChangeListener()
           
 
Method Summary
 boolean editorAboutToBeClosed(java.net.URL editorLocation)
          An editor will be closed.
 void editorAboutToBeOpened(java.net.URL editorLocation)
          An editor will be opened.
 boolean editorAboutToBeOpenedVeto(java.net.URL editorLocation)
          An editor will be opened.
 void editorActivated(java.net.URL editorLocation)
          An editor was activated.
 void editorClosed(java.net.URL editorLocation)
          An editor was closed.
 void editorDeactivated(java.net.URL editorLocation)
          An editor was de-activated.
 void editorOpened(java.net.URL editorLocation)
          An editor was opened.
 void editorPageChanged(java.net.URL editorLocation)
          The current page for an editor has changed.
 void editorRelocated(java.net.URL previousEditorLocation, java.net.URL newEditorLocation)
          An editor was relocated to a new location.
 void editorSelected(java.net.URL editorLocation)
          An editor was selected in the tabbed pane.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WSEditorChangeListener

public WSEditorChangeListener()
Method Detail

editorAboutToBeOpenedVeto

public boolean editorAboutToBeOpenedVeto(java.net.URL editorLocation)
An editor will be opened. You can reject the close of the editor by returning false. If the open is not rejected then the editorAboutToBeOpened(URL) and then editorOpened(URL) methods will be called.

Parameters:
editorLocation - The editor's location.
Returns:
true to proceed with the close, false to reject the close of the editor.
Since:
12.2

*********************************
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.


editorAboutToBeOpened

public void editorAboutToBeOpened(java.net.URL editorLocation)
An editor will be opened. If the open does not fail, then the editorOpened(URL) method will be called.

Parameters:
editorLocation - The editor's location
Since:
12.1

*********************************
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.


editorOpened

public void editorOpened(java.net.URL editorLocation)
An editor was opened.

Parameters:
editorLocation - The editor's location

editorClosed

public void editorClosed(java.net.URL editorLocation)
An editor was closed.

Parameters:
editorLocation - The editor's location

editorSelected

public void editorSelected(java.net.URL editorLocation)
An editor was selected in the tabbed pane.

Parameters:
editorLocation - The editor's location

editorPageChanged

public void editorPageChanged(java.net.URL editorLocation)
The current page for an editor has changed. This means the user switched for example from the Text to the Author page. An XML Editor usually has 3 pages: Text, Grid and Author.

Parameters:
editorLocation - The editor's location

editorActivated

public void editorActivated(java.net.URL editorLocation)
An editor was activated. It is the selected editor but also the editor in which the focus is present.

Parameters:
editorLocation - The editor's location
Since:
12.2

*********************************
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.


editorDeactivated

public void editorDeactivated(java.net.URL editorLocation)
An editor was de-activated. Focus is no longer present in it. Maybe the editor was already closed.

Parameters:
editorLocation - The editor's location
Since:
12.2

*********************************
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.


editorAboutToBeClosed

public boolean editorAboutToBeClosed(java.net.URL editorLocation)
An editor will be closed. You can reject the close of the editor by returning false.

Parameters:
editorLocation - The editor's location
Returns:
true to proceed with the close, false to reject the close of the editor.
Since:
12.2

*********************************
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.


editorRelocated

public void editorRelocated(java.net.URL previousEditorLocation,
                            java.net.URL newEditorLocation)
An editor was relocated to a new location. Probably Save As was called on the opened editor.

Parameters:
previousEditorLocation - The previous editor's location
newEditorLocation - The current editor's location
Since:
12.2

*********************************
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.


Oxygen XML Editor 12.2 Author API

© Copyright SyncRO Soft SRL 2002 - 2010.