Oxygen XML Editor 12.2 Author API

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:

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

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 addInputURLChooserCustomizer(InputURLChooserCustomizer inputURLChooserCustomizer)
          Adds a customizer which can modify the list of "Browse" actions.
 void addMenuBarCustomizer(MenuBarCustomizer menuBarCustomizer)
          Adds a customizer which can contribute to or modify existing menu components.
 void addRelativeReferencesResolver(java.lang.String protocol, RelativeReferenceResolver resolver)
          Add a relative reference resolver for a certain URL protocol.
 void addToolbarComponentsCustomizer(ToolbarComponentsCustomizer componentsCustomizer)
          Adds a customizer which can contribute to or modify existing toolbars or contribute to the reserved Plugins toolbar.
 void addTopicRefTargetInfoProvider(java.lang.String protocol, TopicRefTargetInfoProvider targetInfoProvider)
          Add a target information provider to the DITA Maps Manager view.
 void addViewComponentCustomizer(ViewComponentCustomizer viewComponentCustomizer)
          Adds a customizer which can contribute to or modify existing views or contribute to the reserved custom view.
 java.lang.String getOxygenActionID(javax.swing.Action action)
          Get an unique ID (which does not depend on the action name) for an action Oxygen has mounted on the main JMenuBar or on the toolbars.
 void showToolbar(java.lang.String toolbarID)
          Show a toolbar specified by the toolbar ID.
 void showView(java.lang.String viewID, boolean requestFocus)
          Show a view specified by the view ID.
 
Methods inherited from interface ro.sync.exml.workspace.api.PluginWorkspace
addEditorChangeListener, getAllEditorLocations, getCurrentEditorAccess, getEditorAccess, getOptionsStorage, getUtilAccess, getXMLUtilAccess, removeEditorChangeListener
 
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
 

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.

addInputURLChooserCustomizer

void addInputURLChooserCustomizer(InputURLChooserCustomizer inputURLChooserCustomizer)
Adds a customizer which can modify the list of "Browse" actions. These actions are available in Oxygen, in any control or dialog that contains an URL input box.
IMPORTANT This customizer must be set early, when the plugin extension's applicationStarted method gets called.
Example: If a CMS developer wants the user to choose the URL from their custom CMS chooser then it will add a new action (possibly removing the others). When the new action gets called the custom code shows the custom chooser and at the end it can call the ro.sync.exml.workspace.api.standalone.InputURLChooser interface to set the new URL in the combo box.

Parameters:
inputURLChooserCustomizer - The input URL chooser customizer.
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.


addRelativeReferencesResolver

void addRelativeReferencesResolver(java.lang.String protocol,
                                   RelativeReferenceResolver resolver)
Add a relative reference resolver for a certain URL protocol. This method can be used by a CMS implementor to take control over the way Oxygen is computing relative references for a certain URL protocol. For example when inserting in a DITA Topic a reference to an image Oxygen will try to make the reference relative to the current XML document. If the DITA Topic is opened using your custom URL protocol you can take control over they way in which the relative path is computed.

Parameters:
protocol - The URL protocol for which you want to take control over the relativization.
resolver - The custom resolver.
Since:
12.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.


addTopicRefTargetInfoProvider

void addTopicRefTargetInfoProvider(java.lang.String protocol,
                                   TopicRefTargetInfoProvider targetInfoProvider)
Add a target information provider to the DITA Maps Manager view. This method can be used by a CMS implementor to take control over the way Oxygen is gathering information about each topic reference. The protocol is the protocol of the URL of the opened DITA Map. For example when a DITA Map is opened in the DITA Maps Manager view the CMS can get called to compute titles for all topic references instead of the default Oxygen behavior (requesting the entire content for the referenced URL).

Parameters:
protocol - The custom protocol of the opened DITA Map for which the plugin will compute the topic reference titles and auxiliary information.
targetInfoProvider - Gets called to resolve the title for the topic references in the DITA Map.
Since:
12.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.


showView

void showView(java.lang.String viewID,
              boolean requestFocus)
Show a view specified by the view ID. If the view is hidden, this method brings it to front.

Parameters:
viewID - The view ID.
requestFocus - True to request the focus inside the view after show.
Since:
12

showToolbar

void showToolbar(java.lang.String toolbarID)
Show a toolbar specified by the toolbar ID. If the toolbar is hidden, this method shows it.

Parameters:
toolbarID - The toolbar ID. You can install a toolbar component customizer and see all available IDs.
Since:
12

getOxygenActionID

java.lang.String getOxygenActionID(javax.swing.Action action)
Get an unique ID (which does not depend on the action name) for an action Oxygen has mounted on the main JMenuBar or on the toolbars.

Parameters:
action - The action for which to retrieve the ID.
Returns:
The unique ID or null if the action is not one provided by Oxygen.
Since:
12.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 12.2 Author API

© Copyright SyncRO Soft SRL 2002 - 2010.