ro.sync.exml.workspace.api
Interface PluginWorkspace

All Superinterfaces:

Workspace

All Known Subinterfaces:

StandalonePluginWorkspace

public interface PluginWorkspace
extends Workspace

Access the entire workspace of Oxygen.

Since:

11.2

Field Summary

static int	DITA_MAPS_EDITING_AREA The DITA Maps editing area
static int	MAIN_EDITING_AREA The main editing area in Oxygen

Method Summary

void	addEditorChangeListener(WSEditorChangeListener editorListener, int editingArea) Add listener for editor related events(for example editor opened, closed, page changed).
java.net.URL[]	getAllEditorLocations(int editingArea) Get all the editor locations.
WSEditor	getCurrentEditorAccess(int editingArea) Get access to the current selected editor.
WSEditor	getEditorAccess(java.net.URL location, int editingArea) Find an editor access by location
WSOptionsStorage	getOptionsStorage() This interface can be used to save and persist in the Oxygen preferences user-defined keys and values.
UtilAccess	getUtilAccess() Get access to utility methods.
XMLUtilAccess	getXMLUtilAccess() Access to XML utilities.
void	removeEditorChangeListener(WSEditorChangeListener editorListener, int editingArea) Remove listener for editor related events.

Methods inherited from interface ro.sync.exml.workspace.api.Workspace

chooseFile, chooseFile, chooseURL, close, closeAll, createJavaProcess, createNewEditor, delete, getLicenseInformationProvider, getParentFrame, getPreferencesDirectory, getUserInterfaceLanguage, getVersion, isStandalone, open, openInExternalApplication, refreshInProject, saveAll, setParentFrameTitle, showConfirmDialog, showErrorMessage, showInformationMessage, showStatusMessage

Field Detail

MAIN_EDITING_AREA

static final int MAIN_EDITING_AREA

The main editing area in Oxygen

See Also:

Constant Field Values

DITA_MAPS_EDITING_AREA

static final int DITA_MAPS_EDITING_AREA

The DITA Maps editing area

See Also:

Constant Field Values

Method Detail

getAllEditorLocations

java.net.URL[] getAllEditorLocations(int editingArea)

Get all the editor locations.

Parameters:

editingArea - One of the constants in this class:
MAIN_EDITING_AREA - for the editors in the main Oxygen workspace area.
DITA_MAPS_EDITING_AREA - for the editors in the DITA Maps Manager view workspace area.

Returns:

All the editor locations or empty array if no editor is opened

getEditorAccess

WSEditor getEditorAccess(java.net.URL location,
                         int editingArea)

Find an editor access by location

Parameters:

location - The editor location

editingArea - One of the constants in this class:
MAIN_EDITING_AREA - for the editors in the main Oxygen workspace area.
DITA_MAPS_EDITING_AREA - for the editors in the DITA Maps Manager view workspace area.

Returns:

access to the found editor or null if no editor found with that location URL.

getCurrentEditorAccess

WSEditor getCurrentEditorAccess(int editingArea)

Get access to the current selected editor.

Parameters:

editingArea - One of the constants in this class:
MAIN_EDITING_AREA - for the editors in the main Oxygen workspace area.
DITA_MAPS_EDITING_AREA - for the editors in the DITA Maps Manager view workspace area.

Returns:

access to the current editor or null if no editor is opened.

getXMLUtilAccess

XMLUtilAccess getXMLUtilAccess()

Access to XML utilities.

Returns:

Access to XML utilities.

getUtilAccess

UtilAccess getUtilAccess()

Get access to utility methods.

Returns:

access to utility methods.

addEditorChangeListener

void addEditorChangeListener(WSEditorChangeListener editorListener,
                             int editingArea)

Add listener for editor related events(for example editor opened, closed, page changed).

Parameters:

editingArea - One of the constants in this class:
MAIN_EDITING_AREA - for the editors in the main Oxygen workspace area.
DITA_MAPS_EDITING_AREA - for the editors in the DITA Maps Manager view workspace area.

editorListener - The listener notified when an editor is added, removed or the editor page is changed.

removeEditorChangeListener

void removeEditorChangeListener(WSEditorChangeListener editorListener,
                                int editingArea)

Remove listener for editor related events.

Parameters:

editingArea - One of the constants in this class:
MAIN_EDITING_AREA - for the editors in the main Oxygen workspace area.
DITA_MAPS_EDITING_AREA - for the editors in the DITA Maps Manager view workspace area.

editorListener - The listener notified when an editor is added, removed or the editor page is changed.

getOptionsStorage

WSOptionsStorage getOptionsStorage()

This interface can be used to save and persist in the Oxygen preferences user-defined keys and values. It is also responsible for adding and removing listeners that are notified about the option changes. These keys are common to all plugin implementations.

Returns:

The object that manages the custom user options stored in the Oxygen preferences from the plugin implementations.

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.