com.oxygenxml.workspace.api.eclipse

Interface EclipsePluginWorkspace

All Superinterfaces:

ColorThemeUtilities, GlobalOptionsStorage, MathFlowConfigurator, PluginWorkspace, ReferencesCustomizer, Workspace, WorkspaceUtilities

@API(type=NOT_EXTENDABLE,
     src=PUBLIC)
public interface EclipsePluginWorkspace
extends PluginWorkspace, MathFlowConfigurator

The Eclipse Plugin Workspace offers access utility methods or to access (and add listeners for) all opened editors from the Main editing area or from the DITA Maps editing area.
Each opened editor contains one or more pages.
The current editor page can be accessed trough the WSEditor.getCurrentPage() method that returns specific editor implementations for Author and Text pages:

• WSAuthorEditorPage that provides access to Author editor page document controller or change tracking controller
• WSTextEditorPage that offers access to the edited document.

Both text based editor pages provides informations and actions regarding the caret position or the document current selection.

Since:

18

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

Field Summary

Fields inherited from interface ro.sync.exml.workspace.api.PluginWorkspace

DITA_MAPS_EDITING_AREA, MAIN_EDITING_AREA

Method Summary

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

addAuthorCSSAlternativesCustomizer, addBatchOperationsListener, addEditorChangeListener, getAllEditorLocations, getCurrentEditorAccess, getEditorAccess, getEditorChangeListeners, getOptionsStorage, getUtilAccess, getXMLUtilAccess, removeAuthorCSSAlternativesCustomizer, removeBatchOperationsListener, removeEditorChangeListener, setDITAKeyDefinitionManager, showPreferencesPages

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

close, closeAll, createNewEditor, delete, getPlatform, 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, getImageUtilities, getLicenseInformationProvider, getParentFrame, getPreferencesDirectory, getTemplateManager, getUserInterfaceLanguage, getVersion, getVersionBuildID, openInExternalApplication, openInExternalApplication, showConfirmDialog, showConfirmDialog, showErrorMessage, showInformationMessage, showStatusMessage, showWarningMessage, startProcess

Methods inherited from interface ro.sync.exml.workspace.api.util.ColorThemeUtilities

getColorTheme, getImageInverter

Methods inherited from interface ro.sync.exml.workspace.api.standalone.ReferencesCustomizer

addInputURLChooserCustomizer, addRelativeReferencesResolver

Methods inherited from interface ro.sync.exml.workspace.api.options.GlobalOptionsStorage

addGlobalOptionListener, getGlobalObjectProperty, importGlobalOptions, importGlobalOptions, removeGlobalOptionListener, saveGlobalOptions, setGlobalObjectProperty

Methods inherited from interface ro.sync.exml.workspace.api.math.MathFlowConfigurator

setMathFlowFixedLicenseFile, setMathFlowFixedLicenseKeyForComposer, setMathFlowFixedLicenseKeyForEditor, setMathFlowInstallationFolder