DITA_MAPS_EDITING_AREA

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

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

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.

addEditorChangeListener

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

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.

removeEditorChangeListener

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

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

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

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.

showPreferencesPages

Show the preferences dialog, with only the desired pages displayed in the
table of contents, and select a specific options page.

The pages to be shown or selected in the dialog are provided using their keys.
For the stand-alone application each key corresponds to a OptionPagePluginExtension key (returned via the ro.sync.exml.plugin.option.OptionPagePluginExtension.getKey() method).
For Eclipse the keys are actually the IDs of the corresponding <page> elements from plugin.xml.

Parameters:

pagesToShowKeys - The keys of the option pages to be shown in the table of contents.

pageToSelectKey - The key of the page to be selected in the table of contents.

showChildrenOfPages - True to also show the children of the option pages in the table of contents, false not to show them.

Since:

17.1

addBatchOperationsListener

Add a batch operations listener, listener notified before and after large modification operations start in Oxygen,
for example when the Replace All in Files is started.
Right now the listener is only called for the standalone version of Oxygen.