@API(type=NOT_EXTENDABLE, src=PUBLIC) public interface StandalonePluginWorkspace extends PluginWorkspace, MathFlowConfigurator, DiffAndMergeTools
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.
DITA_MAPS_EDITING_AREA, MAIN_EDITING_AREA
Modifier and Type | Method and Description |
---|---|
void |
addMenuBarCustomizer(MenuBarCustomizer menuBarCustomizer)
Adds a customizer which can contribute to or modify existing menu components.
|
void |
addMenusAndToolbarsContributorCustomizer(MenusAndToolbarsContributorCustomizer customizer)
Add a customizer for menus and toolbars.
|
void |
addPluginExtension(java.lang.String extensionType,
PluginExtension pluginExtension)
Adds a plug-in extension of a specified type.
|
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.
|
EditorComponentProvider |
createEditorComponentProvider(java.lang.String[] allowedPages,
java.lang.String initialPage)
Creates a new editor component.
|
ActionsProvider |
getActionsProvider()
Provides access to global actions defined in the application.
|
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.
|
ProjectController |
getProjectManager()
Get access to Project related API.
|
ProxyDetailsProvider |
getProxyDetailsProvider()
Get access to currently configured network proxy information.
|
PluginResourceBundle |
getResourceBundle()
A message bundle that holds all the internationalized messages displayed in all the plugins
for a language set in Preferences.
|
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 |
isViewAvailable(java.lang.String viewID)
Check if a view with a certain ID is available in the application.
|
boolean |
isViewShowing(java.lang.String viewID)
Check if a view is showing or hidden.
|
void |
removeMenusAndToolbarsContributorCustomizer(MenusAndToolbarsContributorCustomizer customizer)
Remove a customizer for menus and 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.
|
addAuthorCSSAlternativesCustomizer, addBatchOperationsListener, addEditorChangeListener, createAuthorDocumentProvider, createAuthorDocumentProvider, getAllEditorLocations, getCompareUtilAccess, getCurrentEditorAccess, getEditorAccess, getEditorChangeListeners, getOptionsStorage, getResultsManager, getUtilAccess, getXMLUtilAccess, removeAuthorCSSAlternativesCustomizer, removeBatchOperationsListener, removeEditorChangeListener, setDITAKeyDefinitionManager
close, closeAll, createNewEditor, createNewEditor, delete, isStandalone, open, open, open, refreshInProject, saveAll, setParentFrameTitle
chooseDirectory, chooseDirectory, chooseFile, chooseFile, chooseFile, chooseFiles, chooseURL, chooseURL, chooseURLPath, chooseURLPath, clearImageCache, createJavaProcess, createProcess, getDataSourceAccess, getImageUtilities, getParentFrame, getTemplateManager, openInExternalApplication, openInExternalApplication, openInExternalApplication, showConfirmDialog, showConfirmDialog, showErrorMessage, showErrorMessage, showInformationMessage, showStatusMessage, showStatusMessage, showWarningMessage, startProcess
getColorTheme, getImageInverter
getApplicationName, getApplicationType, getLicenseInformationProvider, getPlatform, getPreferencesDirectory, getUserInterfaceLanguage, getVersion, getVersionBuildID
addInputURLChooserCustomizer, addRelativeReferencesResolver
addGlobalOptionListener, deserializePersistentObject, getGlobalObjectProperty, importGlobalOptions, importGlobalOptions, removeGlobalOptionListener, saveGlobalOptions, serializePersistentObject, setGlobalObjectProperty, showPreferencesPages
setMathFlowFixedLicenseFile, setMathFlowFixedLicenseKeyForComposer, setMathFlowFixedLicenseKeyForEditor, setMathFlowInstallationFolder
openDiffFilesApplication, openDiffFilesApplication, openDiffFilesApplication, openDiffFilesApplication, openMergeApplication
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 hideView(java.lang.String viewID)
viewID
- The view ID.boolean isViewShowing(java.lang.String viewID)
viewID
- The view ID.true
if the view is showingboolean isViewAvailable(java.lang.String viewID)
viewID
- The view ID.true
if the view is available in the applicationvoid hideToolbar(java.lang.String toolbarID)
toolbarID
- The toolbar ID.void showToolbar(java.lang.String toolbarID)
toolbarID
- The toolbar ID. You can install a toolbar component customizer and see all available IDs.boolean isToolbarShowing(java.lang.String toolbarID)
toolbarID
- The toolbar ID.true
if the toolbar is showingjava.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.ActionsProvider getActionsProvider()
null
when called in certain contexts (for example from the webapp application).void addMenusAndToolbarsContributorCustomizer(MenusAndToolbarsContributorCustomizer customizer)
customizer
- The customizer which will be notified to customize menus and toolbars.void removeMenusAndToolbarsContributorCustomizer(MenusAndToolbarsContributorCustomizer customizer)
customizer
- The customizer to remove.EditorComponentProvider createEditorComponentProvider(java.lang.String[] allowedPages, java.lang.String initialPage) throws AuthorComponentException
allowedPages
- The pages which will be used in the editor. One of the constant fields:
EditorPageConstants.PAGE_TEXT
, EditorPageConstants.PAGE_AUTHOR
, EditorPageConstants.PAGE_GRID
initialPage
- The initial page in which the component will edit.AuthorComponentException
- The component was not initialized properly.PluginResourceBundle getResourceBundle()
<translation>
<languageList>
<language description="English US" lang="en_US"/>
<language description="German" lang="de_DE"/>
<language description="French" lang="fr_FR"/>
</languageList>
<key value="key_name1">
<comment>key description1</comment>
<val lang="en_US">en_US_translation1</val>
<val lang="de_DE">de_DE_translation1</val>
<val lang="fr_FR">fr_FR_translation1</val>
</key>
<key value="key_name2">
<comment>key description2</comment>
<val lang="en_US">en_US_translation2</val>
<val lang="de_DE">de_DE_translation2</val>
<val lang="fr_FR">fr_FR_translation2</val>
</key>
........................
</translation>
ProxyDetailsProvider getProxyDetailsProvider()
ProjectController getProjectManager()
void addPluginExtension(java.lang.String extensionType, PluginExtension pluginExtension)
extensionType
- The type of the plugin extension; can be a constant from .pluginExtension
- The plugin extension implementation to be added.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.
© Copyright Syncro Soft SRL 2002 - 2022. All rights reserved.