Oxygen XML Editor, Version 13.2

ro.sync.ecss.extensions.api.access
Interface AuthorWorkspaceAccess

All Superinterfaces:
ro.sync.exml.workspace.api.Workspace

@API(type=NOT_EXTENDABLE,
     src=PUBLIC)
public interface AuthorWorkspaceAccess
extends ro.sync.exml.workspace.api.Workspace

Provides access to workspace specific information and actions.


Method Summary
 java.net.URL[] getAllEditorLocations()
          Get all the editor locations.
 ro.sync.exml.workspace.api.editor.WSEditor getEditorAccess(java.net.URL location)
          Find an editor access by location.
 boolean open(java.io.File file)
          Deprecated. Use Workspace.open(URL) instead.
 
Methods inherited from interface ro.sync.exml.workspace.api.Workspace
chooseFile, chooseFile, chooseURL, clearImageCache, close, closeAll, createJavaProcess, createNewEditor, delete, getLicenseInformationProvider, getParentFrame, getPreferencesDirectory, getUserInterfaceLanguage, getVersion, isStandalone, open, open, openInExternalApplication, refreshInProject, saveAll, setParentFrameTitle, showConfirmDialog, showConfirmDialog, showErrorMessage, showInformationMessage, showStatusMessage
 

Method Detail

open

@Deprecated
boolean open(java.io.File file)
Deprecated. Use Workspace.open(URL) instead.

Opens the specified File in a new editor.

Parameters:
file - The file to be opened.
Returns:
true if the operation has succeeded.

getAllEditorLocations

java.net.URL[] getAllEditorLocations()
Get all the editor locations.

Returns:
All the editor locations in the main editing area or empty array if no editor is opened.
Since:
13.2

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


getEditorAccess

ro.sync.exml.workspace.api.editor.WSEditor getEditorAccess(java.net.URL location)
Find an editor access by location.

Parameters:
location - The editor location
editingArea - One of the constants in this class:
Returns:
access to the found editor or null if no editor found with that location URL.
Since:
13.2

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


Oxygen XML Editor, Version 13.2

© Copyright Syncro Soft SRL 2002 - 2012.