@API(type=NOT_EXTENDABLE, src=PUBLIC) public interface PluginWorkspace extends Workspace, ReferencesCustomizer, GlobalOptionsStorage
Modifier and Type | Field and Description |
---|---|
static int |
DITA_MAPS_EDITING_AREA
The DITA Maps editing area
|
static int |
MAIN_EDITING_AREA
The main editing area in Oxygen
|
Modifier and Type | Method and Description |
---|---|
void |
addAuthorCSSAlternativesCustomizer(AuthorCSSAlternativesCustomizer cssAlternativesCustomizer)
Add a customizer for the CSS alternatives which the user can choose in the Styles drop-down button when working
in the Author visual editing mode.
|
void |
addBatchOperationsListener(BatchOperationsListener listener)
Add a batch operations listener, listener notified before and after large modification operations start in Oxygen,
for example when the Replace All in Files is started.
|
void |
addEditorChangeListener(WSEditorChangeListener editorListener,
int editingArea)
Add listener for editor related events(for example editor opened, closed, page changed).
|
AuthorDocumentProvider |
createAuthorDocumentProvider(java.net.URL systemId,
java.io.Reader documentReader)
Creates a provider for a given resource specified by URL and/or Reader.
|
AuthorDocumentProvider |
createAuthorDocumentProvider(java.net.URL systemId,
java.io.Reader documentReader,
boolean expandReferences)
Creates a provider for a given resource specified by URL and/or Reader.
|
java.net.URL[] |
getAllEditorLocations(int editingArea)
Get all the editor locations.
|
CompareUtilAccess |
getCompareUtilAccess()
Access to Comparison utilities.
|
WSEditor |
getCurrentEditorAccess(int editingArea)
Get access to the current selected editor.
|
WSEditor |
getEditorAccess(java.net.URL location,
int editingArea)
Find an editor access by location
|
WSEditorChangeListener[] |
getEditorChangeListeners(int editingArea)
Return a list with all registered editor changed listeners, never
null . |
WSOptionsStorage |
getOptionsStorage()
This interface can be used to save and persist in the Oxygen preferences user-defined keys and values.
|
ResultsManager |
getResultsManager()
Get the results manager, that can be used to present operation results
to the user inside a dedicated view.
|
UtilAccess |
getUtilAccess()
Get access to utility methods.
|
ValidationUtilAccess |
getValidationUtilAccess()
Get access to validation utilities.
|
XMLUtilAccess |
getXMLUtilAccess()
Access to XML utilities.
|
void |
removeAuthorCSSAlternativesCustomizer(AuthorCSSAlternativesCustomizer cssAlternativesCustomizer)
Remove a customizer for the CSS alternatives which the user can choose in the Styles drop-down button when working
in the Author visual editing mode.
|
void |
removeBatchOperationsListener(BatchOperationsListener listener)
Remove a batch operations listener.
|
void |
removeEditorChangeListener(WSEditorChangeListener editorListener,
int editingArea)
Remove listener for editor related events.
|
void |
setDITAKeyDefinitionManager(KeyDefinitionManager keyDefitionManager)
By default key definitions are gathered from DITA Maps opened in the DITA Maps Manager.
|
close, closeAll, createNewEditor, createNewEditor, delete, isStandalone, open, open, open, refreshInProject, saveAll, setParentFrameTitle
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, showWarningMessage, startProcess
getColorTheme, getImageInverter
getApplicationName, getApplicationType, getLicenseInformationProvider, getPlatform, getPreferencesDirectory, getUserInterfaceLanguage, getVersion, getVersionBuildID
addInputURLChooserCustomizer, addRelativeReferencesResolver
addGlobalOptionListener, deserializePersistentObject, getGlobalObjectProperty, importGlobalOptions, importGlobalOptions, removeGlobalOptionListener, saveGlobalOptions, serializePersistentObject, setGlobalObjectProperty, showPreferencesPages
static final int MAIN_EDITING_AREA
static final int DITA_MAPS_EDITING_AREA
java.net.URL[] getAllEditorLocations(int editingArea)
editingArea
- One of the constants in this class:
MAIN_EDITING_AREA
- for the editors in the main Oxygen workspace area.
DITA_MAPS_EDITING_AREA
- for the editors in the DITA Maps Manager view workspace area.
WSEditor getEditorAccess(java.net.URL location, int editingArea)
location
- The editor locationeditingArea
- One of the constants in this class:
MAIN_EDITING_AREA
- for the editors in the main Oxygen workspace area.
DITA_MAPS_EDITING_AREA
- for the editors in the DITA Maps Manager view workspace area.
null
if no editor found with that location URL.WSEditor getCurrentEditorAccess(int editingArea)
editingArea
- One of the constants in this class:
MAIN_EDITING_AREA
- for the editors in the main Oxygen workspace area.
DITA_MAPS_EDITING_AREA
- for the editors in the DITA Maps Manager view workspace area.
null
if no editor is opened.XMLUtilAccess getXMLUtilAccess()
CompareUtilAccess getCompareUtilAccess()
UtilAccess getUtilAccess()
ValidationUtilAccess getValidationUtilAccess()
ResultsManager getResultsManager()
void addEditorChangeListener(WSEditorChangeListener editorListener, int editingArea)
editorListener
- The listener notified when an editor is added, removed or the editor page is changed.editingArea
- One of the constants in this class:
MAIN_EDITING_AREA
- for the editors in the main Oxygen workspace area.
DITA_MAPS_EDITING_AREA
- for the editors in the DITA Maps Manager view workspace area.
void removeEditorChangeListener(WSEditorChangeListener editorListener, int editingArea)
editingArea
- One of the constants in this class:
MAIN_EDITING_AREA
- for the editors in the main Oxygen workspace area.
DITA_MAPS_EDITING_AREA
- for the editors in the DITA Maps Manager view workspace area.
editorListener
- The listener notified when an editor is added, removed or the editor page is changed.WSEditorChangeListener[] getEditorChangeListeners(int editingArea)
null
.editingArea
- One of the constants in this class:
MAIN_EDITING_AREA
- for the editors in the main Oxygen workspace area.
DITA_MAPS_EDITING_AREA
- for the editors in the DITA Maps Manager view workspace area.null
.WSOptionsStorage getOptionsStorage()
void setDITAKeyDefinitionManager(KeyDefinitionManager keyDefitionManager)
keyDefitionManager
- The key definition managervoid addAuthorCSSAlternativesCustomizer(AuthorCSSAlternativesCustomizer cssAlternativesCustomizer)
cssAlternativesCustomizer
- The CSS alternatives customizer.void removeAuthorCSSAlternativesCustomizer(AuthorCSSAlternativesCustomizer cssAlternativesCustomizer)
cssAlternativesCustomizer
- The CSS alternatives customizer.void addBatchOperationsListener(BatchOperationsListener listener)
listener
- The batch operations listener.void removeBatchOperationsListener(BatchOperationsListener listener)
listener
- The batch operations listener.AuthorDocumentProvider createAuthorDocumentProvider(java.net.URL systemId, java.io.Reader documentReader) throws java.io.IOException
AuthorDocumentController
.
AuthorDocumentController
API.systemId
- The system id of the resource. If null
, the reader must be provided
and relative DTD entity references will not be properly resolved.documentReader
- The document reader. If null
, the reader will be created internally.AuthorDocumentController
representation of the resource.java.io.IOException
- If any exception occurs during the loading,
for example IO exception due to incorrect system id, unsupported encodings, files saving permission, etcAuthorDocumentProvider createAuthorDocumentProvider(java.net.URL systemId, java.io.Reader documentReader, boolean expandReferences) throws java.io.IOException
AuthorDocumentController
.
AuthorDocumentController
API.systemId
- The system id of the resource. If null
, the reader must be provided
and relative DTD entity references will not be properly resolved.documentReader
- The document reader. If null
, the reader will be created internally.expandReferences
- true
to expand references in the created document.AuthorDocumentController
representation of the resource.java.io.IOException
- If any exception occurs during the loading,
for example IO exception due to incorrect system id, unsupported encodings, files saving permission, etc© Copyright Syncro Soft SRL 2002 - 2023. All rights reserved.