Oxygen XML Editor 16.1 Author API

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

All Superinterfaces:
ColorThemeUtilities, MathFlowConfigurator, PluginWorkspace, ReferencesCustomizer, Workspace, WorkspaceUtilities

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

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 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 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 hideToolbar(java.lang.String toolbarID)
          Hide a toolbar specified by the toolbar ID.
 void hideView(java.lang.String viewID)
          Hide a view specified by the view ID.
 boolean isToolbarShowing(java.lang.String toolbarID)
          Check if a toolbar is showing or hidden.
 boolean isViewShowing(java.lang.String viewID)
          Check if a view is showing or hidden.
 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, getEditorChangeListeners, getOptionsStorage, getUtilAccess, getXMLUtilAccess, importGlobalOptions, removeEditorChangeListener, saveGlobalOptions, setDITAKeyDefinitionManager, setGlobalObjectProperty
 
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
 
Methods inherited from interface ro.sync.exml.workspace.api.standalone.ReferencesCustomizer
addInputURLChooserCustomizer, addRelativeReferencesResolver
 
Methods inherited from interface ro.sync.exml.workspace.api.math.MathFlowConfigurator
setMathFlowFixedLicenseFile, setMathFlowFixedLicenseKeyForComposer, setMathFlowFixedLicenseKeyForEditor, setMathFlowInstallationFolder
 

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.
NOTICE You will also receive notification for the Author extension toolbars (which are dynamically constructed based on the document type of the current selected XML file). The notifications will be received before the toolbars are constructed after an XML editor which is opened in the Author page was selected. Such toolbar IDs have the prefix "Author_custom_actions" and the suffix is a number depending on how many toolbars were created for that specific document type. In this way you can dynamically filter or add to toolbar buttons already declared in the document type associated to the XML editor.

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.

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

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

hideView

void hideView(java.lang.String viewID)
Hide a view specified by the view ID.

Parameters:
viewID - The view ID.
Since:
15

isViewShowing

boolean isViewShowing(java.lang.String viewID)
Check if a view is showing or hidden.

Parameters:
viewID - The view ID.
Returns:
true if the view is showing
Since:
15

hideToolbar

void hideToolbar(java.lang.String toolbarID)
Hide a toolbar specified by the toolbar ID.

Parameters:
toolbarID - The toolbar ID.
Since:
15

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

isToolbarShowing

boolean isToolbarShowing(java.lang.String toolbarID)
Check if a toolbar is showing or hidden.

Parameters:
toolbarID - The toolbar ID.
Returns:
true if the toolbar is showing
Since:
15

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. If the action appears on a contextual menu but is not installed on a main menu it will pe prefixed with the constant "ACTION_WITH_NO_SHORTCUT/"

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

Oxygen XML Editor 16.1 Author API

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