Ephox EditLive! for Java uses a JavaScript API to interface with the Web browser. The EditLive! for Java API is contained within a single JavaScript file, editlivejava.js. This file must be included in any Web page in which an instance of EditLive! is present. The is API within this file is used to create instances of the EditLive! for Java applet and also contains various functions allowing the developer to interact with the applet at run time. Finally, the functions in this file are used by the EditLive! for Java JSP Custom Tag Library and ASP class file to create instances of EditLive! for Java in JSP and ASP pages respectively.
Note: It is very important that you use the JavaScript file as provided and do not edit or change it.
The editlivejava.js file includes the various functions required to instantiate EditLive! for Java within a Web page. These functions are listed in the EditLive! for Java JavaScript Object Reference. They must be used before the EditLive! for Java applet is displayed within the page. If developing using either JSP or ASP scripting languages it is recommended that you use the EditLive! for Java JSP Custom Tag Library or the ASP class file to instantiate EditLive! for Java within a Web page.
The EditLive! for Java JSP Custom Tag Library and ASP class files are based on the EditLive! for Java JavaScript instance functions. Therefore, when using these interfaces the developer is not required to use the EditLive! for Java JavaScript instance functions directly. The EditLive! for Java JSP Custom Tag Library and ASP class file do not, however, contain any interface to the EditLive! for Java JavaScript run time functions. In order to use the EditLive! for Java JavaScript run time functions they must be called directly through JavaScript scripting.
Note: If you have instantiated EditLive! for Java using one of the scripting libraries, other than JavaScript, provided by Ephox (e.g. JSP or ASP) then the name assigned to the relevant JavaScript object is that of the name attribute or property with "_js" appended to it. For example, if the name attribute or property was ELJName then the <BODY> of the EditLive! for Java applet could be retrieved with the following JavaScript method call:
ELJName_js.GetBody('retrieveContent');
Also included in the editlivejava.js file is a set of functions which can be used by the developer on an EditLive! for Java applet at run time. These functions are listed in the EditLive! for Java JavaScript Run Time API Reference. These functions can be used to manipulate the contents of the EditLive! for Java applet at run time or complement its functionality. When using any of these functions the developer must access them directly through JavaScript scripting. They are not available for use through the EditLive! for Java JSP Custom Tag Library or the ASP class file.
The editlivejava.js file can be found in the redistributables/editlivejava subdirectory of the Ephox EditLive! for Java webfolder directory.
In order to include the editlivejava.js file, and thus use the methods and classes that it contains, a line similar to the following must be included within the relevant Web page.
<script src="editlivejava/editlivejava.js"></script>
The value associated with the src attribute must be equivalent to the location of the file as stated in the Where to Find the File section of this page or another location where this directory and its files have been copied to.
The line of code used to include this file must be contained within the relevant Web page, before attempting to create any instances of the EditLive! for Java applet.
Copyright © 2001-2004 Ephox Corporation. All Rights Reserved.