|
Oxygen XML Editor 14.2 Author API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@API(type=NOT_EXTENDABLE, src=PUBLIC) public interface StandalonePluginWorkspace
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.
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 |
setMathFlowFixedLicenseKeyForComposer(java.lang.String fixedKey)
Set a fixed key for licensing the MathFlow composer used to view embedded MathML equations. |
void |
setMathFlowFixedLicenseKeyForEditor(java.lang.String fixedKey)
Set a fixed key for licensing the MathFlow editor dialog used to edit embedded MathML equations. |
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, setDITAKeyDefinitionManager |
Methods inherited from interface ro.sync.exml.workspace.api.Workspace |
---|
chooseFile, chooseFile, chooseFile, chooseURL, chooseURL, chooseURLPath, clearImageCache, close, closeAll, createJavaProcess, createNewEditor, delete, getDataSourceAccess, getLicenseInformationProvider, getParentFrame, getPreferencesDirectory, getUserInterfaceLanguage, getVersion, isStandalone, open, open, openInExternalApplication, refreshInProject, saveAll, setParentFrameTitle, showConfirmDialog, showConfirmDialog, showErrorMessage, showInformationMessage, showStatusMessage |
Methods inherited from interface ro.sync.exml.workspace.api.standalone.ReferencesCustomizer |
---|
addInputURLChooserCustomizer, addRelativeReferencesResolver |
Method Detail |
---|
void addToolbarComponentsCustomizer(ToolbarComponentsCustomizer componentsCustomizer)
componentsCustomizer
- The tool bar components customizer.void addViewComponentCustomizer(ViewComponentCustomizer viewComponentCustomizer)
viewComponentCustomizer
- The views component customizer.void addMenuBarCustomizer(MenuBarCustomizer menuBarCustomizer)
menuBarCustomizer
- The menu bar components customizer.void addTopicRefTargetInfoProvider(java.lang.String protocol, TopicRefTargetInfoProvider targetInfoProvider)
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.void showView(java.lang.String viewID, boolean requestFocus)
viewID
- The view ID.requestFocus
- True to request the focus inside the view after show.void showToolbar(java.lang.String toolbarID)
toolbarID
- The toolbar ID. You can install a toolbar component customizer and see all available IDs.java.lang.String getOxygenActionID(javax.swing.Action action)
action
- The action for which to retrieve the ID.
null
if the action is not one provided by Oxygen.void setMathFlowFixedLicenseKeyForEditor(java.lang.String fixedKey)
fixedKey
- The fixed key. The key needs to be obtained from MathFlow:
http://dessci.com/
and has the following format:
MFSCKKK-KKKKKK-KKKKK
If no editor key will be given then MathFlow will be used neither for editing nor for rendering.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.
void setMathFlowFixedLicenseKeyForComposer(java.lang.String fixedKey)
fixedKey
- The fixed key. The key needs to be obtained from MathFlow:
http://dessci.com/
and has the following format:
MFSEKKK-KKKKKK-KKKKK
If no composer key will be given then the fallback for rendering will be the Apache JEuclid library.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 14.2 Author API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |