Package ro.sync.ecss.extensions.api.webapp.access

Interface WebappPluginWorkspace

All Superinterfaces:

ApplicationInformationAccess, ColorThemeUtilities, DiffAndMergeTools, GlobalOptionsStorage, MathFlowConfigurator, PluginWorkspace, ReferencesCustomizer, StandalonePluginWorkspace, Workspace, WorkspaceUtilities

@API(type=NOT_EXTENDABLE,
     src=PUBLIC)
public interface WebappPluginWorkspace
extends StandalonePluginWorkspace

Plugin workspace access API with webapp-specific features. To obtain an instance of this class, one can either register a WorkspaceAccessPluginExtension or use PluginWorkspaceProvider.

Since:

17

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	OXYGEN_WEBAPP_DATA_DIR	Servlet context attribute used to retrieve the data directory.
static java.lang.String	restApiVersion	The web-app REST api version

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

DITA_MAPS_EDITING_AREA, MAIN_EDITING_AREA

Method Summary

Modifier and Type	Method	Description
void	addDITAMapEditingSessionLifecycleListener(WebappEditingSessionLifecycleListener listener)	Registers a listener for the lifecycle events of the editing sessions for an editable DITA Map opened in the DITA Maps Manager component.
void	addEditingSessionLifecycleListener(WebappEditingSessionLifecycleListener listener)	Registers a listener for the lifecycle events of the editing sessions.
java.util.List<WebappEditingSessionLifecycleListener>	getAllDITAMapEditingSessionLifecycleListeners()
java.util.List<WebappEditingSessionLifecycleListener>	getAllEditingSessionLifecycleListeners()
java.util.Map<java.lang.String,java.lang.String>	getMonitoringStats()
java.util.List<javax.servlet.Filter>	getServletFilters()
SessionStore	getSessionStore()	A store which can remember key, values on a given session.
void	removeDITAMapEditingSessionLifecycleListener(WebappEditingSessionLifecycleListener listener)	Removes the listener for an editable DITA Map's editing session for an editable DITA Map opened in the DITA Maps Manager component.
void	removeEditingSessionLifecycleListener(WebappEditingSessionLifecycleListener listener)	Removes the listener.
void	setDITAKeyDefinitionManagerProvider(KeyDefinitionManagerProvider keyDefinitionManagerProvider)	Sets an object that provides a DITA keys manager for each opened document.

Methods inherited from interface ro.sync.exml.workspace.api.application.ApplicationInformationAccess

getApplicationName, getApplicationType, getLicenseInformationProvider, getPlatform, getPreferencesDirectory, getUserInterfaceLanguage, getVersion, getVersionBuildID

Methods inherited from interface ro.sync.exml.workspace.api.util.ColorThemeUtilities

getColorTheme, getImageInverter

Methods inherited from interface ro.sync.exml.workspace.api.standalone.DiffAndMergeTools

openDiffFilesApplication, openDiffFilesApplication, openDiffFilesApplication, openDiffFilesApplication, openMergeApplication, openMergeApplication, openPreviewDialog

Methods inherited from interface ro.sync.exml.workspace.api.options.GlobalOptionsStorage

addGlobalOptionListener, deserializePersistentObject, getGlobalObjectProperty, importGlobalOptions, importGlobalOptions, removeGlobalOptionListener, saveGlobalOptions, serializePersistentObject, setGlobalObjectProperty, showPreferencesPages

Methods inherited from interface ro.sync.exml.workspace.api.math.MathFlowConfigurator

setMathFlowFixedLicenseFile, setMathFlowFixedLicenseKeyForComposer, setMathFlowFixedLicenseKeyForEditor, setMathFlowInstallationFolder

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

addAuthorCSSAlternativesCustomizer, addBatchOperationsListener, addEditorChangeListener, createAuthorDocumentProvider, createAuthorDocumentProvider, getAllEditorLocations, getBatchOperationsListenersAccess, getCompareUtilAccess, getCurrentEditorAccess, getEditorAccess, getEditorChangeListeners, getOptionsStorage, getResultsManager, getUtilAccess, getValidationUtilAccess, getXMLUtilAccess, removeAuthorCSSAlternativesCustomizer, removeBatchOperationsListener, removeEditorChangeListener, setDITAKeyDefinitionManager

Methods inherited from interface ro.sync.exml.workspace.api.standalone.ReferencesCustomizer

addInputURLChooserCustomizer, addRelativeReferencesResolver

Methods inherited from interface ro.sync.exml.workspace.api.standalone.StandalonePluginWorkspace

addMenuBarCustomizer, addMenusAndToolbarsContributorCustomizer, addPluginExtension, addToolbarComponentsCustomizer, addTopicRefTargetInfoProvider, addViewComponentCustomizer, createEditorComponentProvider, createEditorComponentProvider, getActionsProvider, getOxygenActionID, getProjectManager, getProxyDetailsProvider, getResourceBundle, hideToolbar, hideView, isToolbarShowing, isViewAvailable, isViewShowing, removeMenusAndToolbarsContributorCustomizer, showToolbar, showView

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

close, closeAll, createNewEditor, createNewEditor, delete, isStandalone, open, open, open, refreshInProject, saveAll, setParentFrameTitle

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

chooseDirectory, chooseDirectory, chooseFile, chooseFile, chooseFile, chooseFiles, chooseURL, chooseURL, chooseURL, chooseURLPath, chooseURLPath, clearImageCache, createJavaProcess, createProcess, getDataSourceAccess, getImageUtilities, getParentFrame, getTemplateManager, openInExternalApplication, openInExternalApplication, openInExternalApplication, showConfirmDialog, showConfirmDialog, showErrorMessage, showErrorMessage, showInformationMessage, showStatusMessage, showStatusMessage, showWarningDialog, showWarningDialog, showWarningMessage, startProcess

Field Detail

restApiVersion

static final java.lang.String restApiVersion

The web-app REST api version

See Also:

Constant Field Values

OXYGEN_WEBAPP_DATA_DIR

static final java.lang.String OXYGEN_WEBAPP_DATA_DIR

Servlet context attribute used to retrieve the data directory. This directory contains:

• frameworks
• plugins
• configuration files

See Also:

Constant Field Values

Method Detail

addEditingSessionLifecycleListener

void addEditingSessionLifecycleListener(WebappEditingSessionLifecycleListener listener)

Registers a listener for the lifecycle events of the editing sessions.

Parameters:

listener - The listener to be added.

addDITAMapEditingSessionLifecycleListener

void addDITAMapEditingSessionLifecycleListener(WebappEditingSessionLifecycleListener listener)

Registers a listener for the lifecycle events of the editing sessions for an editable DITA Map opened in the DITA Maps Manager component.

Parameters:

listener - The listener to be added.

Since:

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

removeEditingSessionLifecycleListener

void removeEditingSessionLifecycleListener(WebappEditingSessionLifecycleListener listener)

Removes the listener.

Parameters:

listener - The listener to be removed.

removeDITAMapEditingSessionLifecycleListener

void removeDITAMapEditingSessionLifecycleListener(WebappEditingSessionLifecycleListener listener)

Removes the listener for an editable DITA Map's editing session for an editable DITA Map opened in the DITA Maps Manager component.

Parameters:

listener - The listener to be removed.

Since:

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

getAllEditingSessionLifecycleListeners

java.util.List<WebappEditingSessionLifecycleListener> getAllEditingSessionLifecycleListeners()

Returns:

Returns all the listeners for lifecycle events of the editing sessions.

getAllDITAMapEditingSessionLifecycleListeners

java.util.List<WebappEditingSessionLifecycleListener> getAllDITAMapEditingSessionLifecycleListeners()

Returns:

Returns all the listeners for lifecycle events of editable DITA Maps opened in the DITA Maps Manager component.

Since:

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

getServletFilters

java.util.List<javax.servlet.Filter> getServletFilters()

Returns:

The list of Servlet filters registered by plugins.

getMonitoringStats

java.util.Map<java.lang.String,java.lang.String> getMonitoringStats()

Returns:

A map with statistics that can be used for monitoring.

Since:

19.1

setDITAKeyDefinitionManagerProvider

void setDITAKeyDefinitionManagerProvider(KeyDefinitionManagerProvider keyDefinitionManagerProvider)

Sets an object that provides a DITA keys manager for each opened document.

Parameters:

keyDefinitionManagerProvider - The provider of the keys manager for opened documents.

Since:

19.1

getSessionStore

SessionStore getSessionStore()

A store which can remember key, values on a given session. The values expire automatically when the session expires.

Returns:

A store which can remember key, values on a given session. The values expire automatically when the session expires.

Since:

20.0