Oxygen XML Editor 16.1 Author API

ro.sync.exml.workspace.api
Interface PluginWorkspace

All Superinterfaces:
ColorThemeUtilities, Workspace, WorkspaceUtilities
All Known Subinterfaces:
StandalonePluginWorkspace

@API(type=NOT_EXTENDABLE,
     src=PUBLIC)
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
 WSEditorChangeListener[] getEditorChangeListeners(int editingArea)
          Return a list with all registered editor changed listeners, never null.
 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 importGlobalOptions(java.io.File optionsFile)
          Sets global properties in the Oxygen common preferences.
 void removeEditorChangeListener(WSEditorChangeListener editorListener, int editingArea)
          Remove listener for editor related events.
 void saveGlobalOptions()
          Save the global application options to their default persistence location.
 void setDITAKeyDefinitionManager(KeyDefinitionManager keyDefitionManager)
          By default key definitions are gathered from DITA Maps opened in the DITA Maps Manager.
 void setGlobalObjectProperty(java.lang.String key, java.lang.Object value)
          Sets a global property in the Oxygen common preferences.
 
Methods inherited from interface ro.sync.exml.workspace.api.Workspace
close, closeAll, createNewEditor, delete, isStandalone, open, open, open, refreshInProject, saveAll, setParentFrameTitle
 
Methods inherited from interface ro.sync.exml.workspace.api.WorkspaceUtilities
chooseDirectory, chooseFile, chooseFile, chooseFile, chooseFiles, chooseURL, chooseURL, chooseURLPath, chooseURLPath, clearImageCache, createJavaProcess, getDataSourceAccess, getLicenseInformationProvider, getParentFrame, getPreferencesDirectory, getUserInterfaceLanguage, getVersion, getVersionBuildID, openInExternalApplication, showConfirmDialog, showConfirmDialog, showErrorMessage, showInformationMessage, showStatusMessage
 
Methods inherited from interface ro.sync.exml.workspace.api.util.ColorThemeUtilities
getColorTheme, getImageInverter
 

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.

getEditorChangeListeners

WSEditorChangeListener[] getEditorChangeListeners(int editingArea)
Return a list with all registered editor changed listeners, never null.

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:
a list with all registered editor changed listeners, never null.
Since:
16

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


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

setDITAKeyDefinitionManager

void setDITAKeyDefinitionManager(KeyDefinitionManager keyDefitionManager)
By default key definitions are gathered from DITA Maps opened in the DITA Maps Manager. This API can be used by the developer to take control over the key definitions which will be used to resolve keyrefs and conkeyrefs for topics opened in the Author page.

Parameters:
keyDefitionManager - The key definition manager
Since:
14

setGlobalObjectProperty

void setGlobalObjectProperty(java.lang.String key,
                             java.lang.Object value)
Sets a global property in the Oxygen common preferences. You can use such methods to overwrite some global preferences in Oxygen with your own values. To find the key and value types which needs to be overwritten you can export the application preferences to XML (Options->Export Global Options).

Parameters:
key - The key from the Oxygen options.
value - Value for the key.
Since:
15

importGlobalOptions

void importGlobalOptions(java.io.File optionsFile)
Sets global properties in the Oxygen common preferences. You can use such methods to overwrite some global preferences in Oxygen with your own values. Existing options with keys which are not present in the imported options file will be preserved.

Parameters:
optionsFile - The file containing the XML options exported from an Oxygen installation.
Since:
16

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


saveGlobalOptions

void saveGlobalOptions()
                       throws java.io.IOException
Save the global application options to their default persistence location.

Throws:
java.io.IOException - If the save operation fails.
Since:
15.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 16.1 Author API

© Copyright SyncRO Soft SRL 2002 - 2014. All rights reserved.