Global objects API

Command is an interface for extending the toolbar with your own commands. You must supply the Editor.addCommand method with an object that implements these methods. Note that you only need to implement that methods you need, since Xopus internally extends a base class with the object you supply.

Editor is a global object that represents the Xopus editor.

Editor.Canvas is a namespace for methods related to Xopus Canvasses.

This object represents the change tracking module of Xopus.

The selection object provides a way to talk to Xopus's selection, range and cursor.

This object is a namespace for XML related methods.

When you are running Xopus embedded in an <iframe>, odds are that you would like to communicate with the Xopus running in the frame, telling it what document to load for example. When you include the xopus/embedded.js a new global object will be available: EmbeddedXopus. It distributes the Editor object from your Xopus frames available in their parent frames.

The global HTTPTools object provides a library of HTTP communication functions that can be used for accessing documents, xincludes or schema files in API functions such as IO.setLoadXML or IO.setLoadXSDFunction.

IO is a global object that provides helper functions for interaction between Xopus and your web server.

The ModalDialog object can be used to show and control a generic dialog window that displays any html page.

Scope objects can be used to store command state across command invocations.

It is possible to save documents to a server with WebDAV support. When using the WebDAV, you have to make sure that the web application has the right to access the files on your server. You also have to check that it is possible to set a cookie on the clients browser.

Initial setup of the command. Declare scope variables here.

Execute the command

Returns true when the user can use the command. Unavailable commands are hidden from the user interface.

A command is checked then the button looks activated. For example the bold command is checked when the text at the cursor is bold.

A command is enabled when the user can click on it. Disabled commands are grayed out.

Command.getLabel returns the string label for the command.

Registers a command object with the editor. You can reference the command from a user interface component such as a custom toolbar button.

Add listeners to the load, unload, afterRedraw, loadError, XopusLoaded and XopusUnloaded events.

Deprecated. Use Editor.addEventListener instead.

This is supposed to be a non-blocking alternative to the browsers' alert() function which blocks all scripts from running while the message is shown.

Closes the property panel / Attributes editor. This method can be used in conjunction with node.openAttributesEditor()

This method is part of the Xopus public API and is used to exit Xopus if the exit URI has been set. If the URI has not been set, this function does nothing. In order to set the exit URI you can use the setExitURL method.

Retrieve the currently active Xopus canvas or null when not one is active.

Get the document that the user is currently editing.

Retrieve a collection containing all current Xopus canvasses.

This method can be used to retrieve a command object.

Retrieve the current exit Function. This Function is called when the user presses the exit button.

Retrieve the current exit URL. This URL is used when the user presses the exit button.

Get all HTML representations for the given XML node. Beware, this function will return all elements, not subtrees. These HTML elements where rendered by the XSL while the given XML node was the context node.

Retrieve the ModalDialog object, to show a generic dialog.

This return the Scope Object.

This function returns the array of symbols currently in use in "Insert Character" menu.

This method returns the currently set UI language.

Retrieve the URL currently loaded in the Xopus content frame.

This method returns the Xopus version string, 4.2 for example.

Retrieve the XML node that was the context node in XSL for the given HTML output element.

When Xopus runs inside in an iframe element, it will replace the xopusVisible class name with xopusHidden. This does require the xopusVisible class name to be set already.

Tell Xopus to load the default-config.xml file. Versions of Xopus before 4.2.5 will load this file automaticaly or try to by first using a HEAD request to check if the file exists.

Tell Xopus to load the global-config.xml file. Versions of Xopus before 4.2.5 will load this file automaticaly or try to by first using a HEAD request to check if the file exists.

If Xopus runs in an iframe, it will show a button to maximize the editor frame. This function can be used to trigger the same function from the API.

Remove event listeners added by Editor.addEventListener().

If Xopus runs in an iframe and is maximized, it will show a button to minimize the editor frame again. This function can also be used to trigger the same function from the API.

This method allows for people to run code in an Xopus transaction, which allows the code to be validated and to be picked up by the undo stack in Xopus.

Set the Function that Xopus should call when the exit button is clicked.

Set the URL that Xopus should use when the exit button is clicked.

This function sets the array of symbols currently in use in Xopus.

This method sets the visibility of a uiGroup in the property panel when uiGroups have been configured.

This methods sets the language of the interface

Load the specified URL in the Xopus document area. This will close all open documents.

When Xopus runs inside in an iframe element, it will replace the xopusHidden class name with xopusVisible. This does require the xopusHidden class name to be set already.

Retrieve the currently active Xopus canvas or null when not one is active.

Retrieve the name that has been set for change tracking.

Get the XopusRange object for the current selection or cursor position in the editor.

Change the selection in the Editor to the supplied range.

Create a browser XMLDocument() instance that is compatible with Xopus.

Creates a instance of XMLHttpRequest() similar to the one used by Xopus itself.

Information on using addListener can be found on the EmbeddedXopus page.

getAPI() can be used to gain access to the Xopus API from outside an <iframe>, without using event listeners. It requires the frame to have a name attribute defined, which is supplied as the only argument of this method.

Send a HTTP HEAD request to check if a file exists.

Retrieve an XML document from the given URI using HTTP GET.

Send a document to your server using a HTTP POST request. This function allows you to specify the encoding explicitly.

Returns the JavaScript function previously set using IO.setAsyncSaveXMLFunction, or null for there is not default save handler.

Returns the function used for loading included XML files, such as XIncludes.

This method returns the method you've set previously using IO.setLoadXMLFunction(fn), or the default load function for XML files. This way you can extend the default Xopus load behavior by re-using the default load function.

This method returns the method you've set previously using IO.setLoadXSDFunction(fn), or the default load function for XML Schemas. This way you can extend the default Xopus load behavior by re-using the default load function.

This method returns the method you've set previously using IO.setLoadXSLFunction(fn), or the default load function for XSL stylesheets. This way you can extend the default Xopus load behavior by re-using the default load function.

This function returns the save function set with IO.setSaveXMLFunction.

Using loadCatalog you can force Xopus to run every URI to load against the catalog to redirect the load.

Use this function to configure Xopus to save your document using in an asynchronous fashion. It has but one difference with IO.setSaveXMLFunction, namely the callback argument. Until the callback function is executed, Xopus will show busy notification in the user interface, and the saving button will be disabled.

Set a new function that is used to load included XML documents. Documents can be included using the document() function in XSL or using XIncludes.

Set a new function to load XML documents that will be edited.

Set a new function to load XML Schemas.

Set a new function to load XSL stylesheets that will be used to render the edit view.

Close the dialog window.

Open the dialog window with the specified URI.

Any scope variable that you want to set or get, must first be declared.

Get the variable value. Note that you have the variable before you can retrieve it.

Set the variable to the given value. Note that you have to declare the variable before it can be set.

Opens the document for reading and puts a write lock (if possible) on the document.

Use a HTTPPUT request for for saving a document to your WebDAV server.

Enables a canvas that is not yet started or enabled. When the canvas is already started this function will return and nothing will happen.

Get the name of the view that is currently active for the canvas.

Retrieves the HTML element that represents the Xopus canvas for this instance of Xopus.

Get the current document that this Xopus canvas is editing.

Gets the collection of view names that are available for this canvas.

This method can be used to get values from parameters that have been declared in the XSL.

The loadDocument function loads a new XML document in the Xopus canvas.

Set the active view for this canvas. The view is identified by name or by index.

This event will be fired after each change to the document.

This event will be fired when a new document is being loaded.

This event will be fired when a document fails to load properly.

This event will be fired when a document is being closed and unloaded by the editor.

This event fires when the cursor is moved to a different node.

This event will be fired when the Xopus window is completely loaded.