|
Oxygen XML Editor 15.0 Author API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@API(type=NOT_EXTENDABLE, src=PUBLIC) public interface Workspace
Provides access to workspace specific information and actions.
Method Summary | |
---|---|
boolean |
close(java.net.URL url)
Closes the editor specified by the URL. |
boolean |
closeAll()
Closes all the editors. |
java.net.URL |
createNewEditor(java.lang.String extension,
java.lang.String contentType,
java.lang.String content)
This is available only in the standalone Oxygen version (not available in the Oxygen Eclipse plugin). Create a new "Untitled" editor. |
void |
delete(java.net.URL url)
Delete the resource identified by the specified URL . |
boolean |
isStandalone()
Check if the extension is used in the Oxygen stand alone or Eclipse plugin version. |
boolean |
open(java.net.URL url)
Opens the file at the specified URL in a new editor. |
boolean |
open(java.net.URL url,
java.lang.String imposedPage)
Opens the file at the specified URL in a new editor. |
void |
refreshInProject(java.net.URL url)
In a new file appeared as a child of a folder in the project, use this method to refresh the parent folder. |
void |
saveAll()
Saves the content of all opened and unsaved editors. |
void |
setParentFrameTitle(java.lang.String parentFrameTitle)
Set a title on the parent frame. |
Methods inherited from interface ro.sync.exml.workspace.api.WorkspaceUtilities |
---|
chooseDirectory, chooseFile, chooseFile, chooseFile, chooseURL, chooseURL, chooseURLPath, clearImageCache, createJavaProcess, getDataSourceAccess, getLicenseInformationProvider, getParentFrame, getPreferencesDirectory, getUserInterfaceLanguage, getVersion, openInExternalApplication, showConfirmDialog, showConfirmDialog, showErrorMessage, showInformationMessage, showStatusMessage |
Method Detail |
---|
boolean open(java.net.URL url)
URL
in a new editor.
url
- The URL of the file to be opened.
true
if the operation has succeeded.boolean open(java.net.URL url, java.lang.String imposedPage)
URL
in a new editor.
url
- The URL of the file to be opened.imposedPage
- The imposed page for opening the URL.
true
if the operation has succeeded.void saveAll()
boolean close(java.net.URL url)
If the editor has unsaved content, the user will be given the opportunity to save it.
url
- The url of the editor to be closed.
true
if the editor was successfully closed, and
false
if the editor could not be closed.boolean closeAll()
If there are editors with unsaved content, the user will be given the opportunity to save them.
true
if the editors were successfully closed, and
false
if the editors are still open.void delete(java.net.URL url) throws java.io.IOException
URL
.
Currently supported protocols are:
url
- The URL from where to delete a resource.
java.io.IOException
void refreshInProject(java.net.URL url)
url
- The new resourcejava.net.URL createNewEditor(java.lang.String extension, java.lang.String contentType, java.lang.String content)
extension
- The editor extension ("xml" or "dita" or "xsl" or "xsd", etc...)contentType
- The content type which can take values like: "text/xml" or "text/xsl" or "text/xsd", etc...
If NULL, the content type will be automatically detected from the extension.content
- The XML content will be used to load the new editor from.
boolean isStandalone()
true
if this is the stand-alone Oxygen version or
false
if it is the Oxygen Eclipse plug-in version.void setParentFrameTitle(java.lang.String parentFrameTitle)
parentFrameTitle
- The new title to set on the parent frame.
If NULL, will reset to the default title.
|
Oxygen XML Editor 15.0 Author API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |