products/editlive/upgrading50.htmlUpgrading to EditLive! for Java 5.0test3

Upgrading to EditLive! 5.0

Upgrading the EditLive! Source

In order to update to EditLive! 5.0 the new EditLive! redistributables must be placed on the relevant Web server.  These files can be found in the INSTALL_HOME/webfolder/redistributables directory of the EditLive! 5.0 SDK, where INSTALL_HOME represents the location of the EditLive! 5.0 SDK install.

These files can be used to replace the existing EditLive! 4.0 files.  

New Menu and Toolbar Commands

EditLive! 5.0 includes a significant amount of new end user functionality.  Much of the new end user functionality is enabled through a collection of new menu and toolbar commands.  New menu and toolbar commands for EditLive! 5.0 are as follows:

  • Accessibility - This command allows the user to check their content against the W3C Accessibility Compliance Guidelines.  The dialog allows users to view the precise instances in their content where the W3C guidelines are not met, and provides links to the W3C website regarding the specific guidelines.

    Note: For the accessibility compliance functionality to work correctly, the logicalEmphasis attribute of the <htmlfilter> element must be set to true. For more information on accessibility compliance see the Accessibility Compliance chapter in the EditLive! documentation.

  • DateTime - This command allows users to insert a date/time value into their content.
  • InsertComment - This command allows users to insert a HTML comment into their content.
  • InsForm - This command allows users to insert a HTML form into their content.
  • InsTextField - This command allows users to insert a text field HTML form control into their content.
  • InsPasswordField - This command allows users to insert a password field HTML form control into their content.
  • InsHiddenField - This command allows users to insert a hidden field HTML form control into their content.
  • InsFileField - This command allows users to insert an insert file field HTML form control into their content.
  • InsButtonField - This command allows users to insert a button HTML form control into their content.
  • InsSubmitField - This command allows users to insert a submit button HTML form control into their content.
  • InsResetField - This command allows users to insert a reset button HTML form control into their content.
  • InsCheckboxField - This command allows users to insert a checkbox field HTML form control into their content.
  • InsRadioField - This command allows users to insert a radio button field HTML form control into their content.
  • InsTextAreaField - This command allows users to insert a textarea field HTML form control into their content.
  • InsSelectField - This command allows users to insert a selection field HTML form control into their content.
  • InsImageField - This command allows users to insert a image field HTML form control into their content.

    Note: The HTML form control insertion commands are only available for the <menuItem> elements of an EditLive! configuration file.

  • Print - This command allows users to print the document contained in the Ephox EditLive! editor.

    Note: In order for the print dialog to appear pop-up blockers must be turned off on the client's machine.

These menu and toolbar items can be added to any EditLive! menu or toolbar within a <menuItem> or <toolbarButton> configuration element.  The following example demonstrates how to specify the Accessibility item as either a menu item or toolbar button:

Menu Item:

<menuItem name="Accessibility" />

Toolbar Button:

<toolbarButton name="Accessibility" />

For more information on how to configure the EditLive! interface please see the section in the EditLive! SDK on Customizing the EditLive! Interface.

Disable Background Spell Checking

EditLive! 5.0 allows developers to turn off the spell check as you type functionality of EditLive! upon loading the editor. This is done by setting the startBackgroundSpellChecking attribute of the <spellCheck> XML configuration file element to false. For example:

<spellCheck jar="../../redistributables/editlivejava/dictionaries/
en_us_3_1.jar" startBackgroundChecking="false" useNotModified="false" />

For more information on disabling background spell checking please see the section in the EditLive! SDK on the Spell Check XML configuration elements.

  Disable Inline Table and Image Resizing

EditLive! 5.0 allows developers to turn off the user's ability to resize images and tables existing in the editor's content. This is done by setting the disableInlineImageResizing and disableInlineTableResizing attributes of the <wysiwygEditor> XML configuration file element to true. For example:

<wysiwygEditor disableInlineImageResizing="true" disableInlineTableResizing="true" />

For more information on disabling inline image and table resizing please see the section in the EditLive! SDK on the wysiwyg Editor XML configuration elements.

Advanced APIs

EditLive! 5.0 now supports a set of advanced APIs. These APIs are a collection of Java classes and interfaces developers can use to change the fundamental functionality of the EditLive! applet.

Note: These advanced APIs are designed for use by advanced Java programmers. They should only be used by experienced Java programmers wishing to customize the core default actions of EditLive!.

For more information please see the Advanced API documentation.

Internationalized Menus

EditLive! 5.0 now features internationalized menus. This allows developers to specify a menu name in an EditLive! configuration file that will be properly translated to the desired language based on the user's locale.

The following XML menu name attributes will be automatically internationalized:

  • ephox_filemenu - The internationalized File menu name
  • ephox_editmenu - The internationalized Edit menu name
  • ephox_viewmenu - The internationalized View menu name
  • ephox_insertmenu - The internationalized Insert menu name
  • ephox_formatmenu - The internationalized Format menu name
  • ephox_toolsmenu - The internationalized Tools menu name
  • ephox_formmenu - The internationalized Forms menu name

 

To specify an internationalized menu name, enter one of the specified menu names into name attribute of a <menu> XML configuration element. For example:

<menu name="ephox_filemenu">

For more information on how to configure the EditLive! internationalized menus please see the section in the EditLive! SDK on Menu XML configuration elements.

Adding Symbols to the Insert Symbols Dialog

Using the EditLive! XML configuration file, developers can specify extra symbols to appear in the insert symbols dialog. This is done by embedding a <symbol> XML element with-in a <symbols> XML element. For example, to add a â symbol to the insert symbols dialog:

<symbols>
  <symbol char="â">
</symbols>

For more information on how to configure the EditLive! insert symbols dialog please see the section in the EditLive! SDK on the Symbol XML configuration element.

  Web-Based Image Browser

EditLive! 5.0 allows developers to specify a webpage that can appear in the image insertion dialog. This allows users to click on images and image links in this webpage to insert them into the current document in the EditLive! editor. To specify a webpage to appear in the image insertion dialog, use the <imageBrowser> XML configuration element. For example, to specify the webpage www.ephox.com to appear in the image insertion dialog, the following <imageBrowser> XML configuration element would be used:

<images ...>
  <imageBrowser href="www.ephox.com" />
<images .../>

For more information on how to configure the EditLive! web-based image browser please see the section in the EditLive! SDK on the Image Insertion Dialog's Browser Component.

IsDirty Runtime Method

EditLive! 5.0 provides an IsDirty runtime method to allow developers to see if the contents of the EditLive! editor have changed since the editor was first instantiated.

For more information on how to use the IsDirty runtime method please see the section in the EditLive! SDK on the IsDirty function.

Upgrading from Versions Prior to 4.0

If you are  upgrading from a version of EditLive! prior to EditLive! 4.0 you should also consult the Upgrading to EditLive! 4.0 documentation.

For an overview of the new features packaged with EditLive! 5.0 please refer to the What's New & Noteworthy in 5.0 document