ro.sync.exml.workspace.api.standalone
Interface StandalonePluginWorkspace

All Superinterfaces:

PluginWorkspace, Workspace

public interface StandalonePluginWorkspace
extends PluginWorkspace

The Plugin Workspace offers the possibility to customize the Workspace toolbars, menu bars or views, to 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.

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

Since:

11.2

Field Summary

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

DITA_MAPS_EDITING_AREA, MAIN_EDITING_AREA

Method Summary

void	addMenuBarCustomizer(MenuBarCustomizer menuBarCustomizer) Adds a customizer which can contribute to or modify existing menu components.
void	addToolbarComponentsCustomizer(ToolbarComponentsCustomizer componentsCustomizer) Adds a customizer which can contribute to or modify existing toolbars or contribute to the reserved Plugins toolbar.
void	addViewComponentCustomizer(ViewComponentCustomizer viewComponentCustomizer) Adds a customizer which can contribute to or modify existing views or contribute to the reserved custom view.

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

addEditorChangeListener, getAllEditorLocations, getCurrentEditorAccess, getEditorAccess, getUtilAccess, getXMLUtilAccess, removeEditorChangeListener

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

chooseFile, chooseFile, chooseURL, close, closeAll, delete, getParentFrame, isStandalone, open, refreshInProject, saveAll, showConfirmDialog, showErrorMessage, showInformationMessage, showStatusMessage

Method Detail

addToolbarComponentsCustomizer

void addToolbarComponentsCustomizer(ToolbarComponentsCustomizer componentsCustomizer)

Adds a customizer which can contribute to or modify existing toolbars or contribute to the reserved Plugins toolbar.
IMPORTANT This customizer must be set early, when the plugin extension's applicationStarted method gets called.

Parameters:

componentsCustomizer - The tool bar components customizer.

addViewComponentCustomizer

void addViewComponentCustomizer(ViewComponentCustomizer viewComponentCustomizer)

Adds a customizer which can contribute to or modify existing views or contribute to the reserved custom view.
IMPORTANT This customizer must be set early, when the plugin extension's applicationStarted method gets called.

Parameters:

viewComponentCustomizer - The views component customizer.

addMenuBarCustomizer

void addMenuBarCustomizer(MenuBarCustomizer menuBarCustomizer)

Adds a customizer which can contribute to or modify existing menu components.
IMPORTANT This customizer must be set early, when the plugin extension's applicationStarted method gets called.

Parameters:

menuBarCustomizer - The menu bar components customizer.