@API(type=NOT_EXTENDABLE, src=PUBLIC) public interface PluginWorkspace extends Workspace, ReferencesCustomizer
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 |
addEditorChangeListener(WSEditorChangeListener editorListener,
int editingArea)
Add listener for editor related events(for example editor opened, closed, page changed).
|
java.net.URL[] |
getAllEditorLocations(int editingArea)
Get all the editor locations.
|
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.
|
UtilAccess |
getUtilAccess()
Get access to utility methods.
|
XMLUtilAccess |
getXMLUtilAccess()
Access to XML utilities.
|
void |
importGlobalOptions(java.io.File optionsFile)
Sets global properties in the Oxygen common preferences.
|
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 |
removeEditorChangeListener(WSEditorChangeListener editorListener,
int editingArea)
Remove listener for editor related events.
|
void |
saveGlobalOptions()
Save the global application options to their default persistence location.
|
void |
setDITAKeyDefinitionManager(KeyDefinitionManager keyDefitionManager)
By default key definitions are gathered from DITA Maps opened in the DITA Maps Manager.
|
void |
setGlobalObjectProperty(java.lang.String key,
java.lang.Object value)
Sets a global property in the Oxygen common preferences.
|
void |
showPreferencesPages(java.lang.String[] pagesToShowKeys,
java.lang.String pageToSelectKey,
boolean showChildrenOfPages)
Show the preferences dialog, with only the desired pages displayed in the
table of contents, and select a specific options page.
The pages to be shown or selected in the dialog are provided using their keys. |
close, closeAll, createNewEditor, delete, getPlatform, isStandalone, open, open, open, refreshInProject, saveAll, setParentFrameTitle
chooseDirectory, chooseFile, chooseFile, chooseFile, chooseFiles, chooseURL, chooseURL, chooseURLPath, chooseURLPath, clearImageCache, createJavaProcess, getDataSourceAccess, getLicenseInformationProvider, getParentFrame, getPreferencesDirectory, getUserInterfaceLanguage, getVersion, getVersionBuildID, openInExternalApplication, showConfirmDialog, showConfirmDialog, showErrorMessage, showInformationMessage, showStatusMessage, showWarningMessage
getColorTheme, getImageInverter
addInputURLChooserCustomizer, addRelativeReferencesResolver
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()
UtilAccess getUtilAccess()
void addEditorChangeListener(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.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 setGlobalObjectProperty(java.lang.String key, java.lang.Object value)
key
- The key from the Oxygen options.value
- Value for the key.void importGlobalOptions(java.io.File optionsFile)
optionsFile
- The file containing the XML options exported from an Oxygen installation.void saveGlobalOptions() throws java.io.IOException
java.io.IOException
- If the save operation fails.void addAuthorCSSAlternativesCustomizer(AuthorCSSAlternativesCustomizer cssAlternativesCustomizer)
cssAlternativesCustomizer
- The CSS alternatives customizer.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 removeAuthorCSSAlternativesCustomizer(AuthorCSSAlternativesCustomizer cssAlternativesCustomizer)
cssAlternativesCustomizer
- The CSS alternatives customizer.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 showPreferencesPages(java.lang.String[] pagesToShowKeys, java.lang.String pageToSelectKey, boolean showChildrenOfPages)
OptionPagePluginExtension
key (returned via the ro.sync.exml.plugin.option.OptionPagePluginExtension.getKey() method).
For Eclipse the keys are actually the IDs of the corresponding <page>
elements from plugin.xml
.pagesToShowKeys
- The keys of the option pages to be shown in the table of contents.pageToSelectKey
- The key of the page to be selected in the table of contents.showChildrenOfPages
- True
to also show the children of the option pages in the table of contents, false
not to show them.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 - 2015. All rights reserved.