Customizing the EditLive! for Java Interface

Introduction

The menus and toolbars of Ephox EditLive! for Java are completely customizable through the EditLive! for Java configuration process. This article explains how the EditLive! for Java toolbars and menu bars may be configured and how the configuration of the EditLive! for Java menu bar and toolbars affects the functionality of EditLive! for Java.

The Menu Bar

The menu bar in EditLive! for Java can have any number of individual menus added to it. The names of the menus added to the menu bar are completely customizable. Furthermore, the specification of a mnemonic for the menu is also customizable. To specify the mnemonic for a menu an escaped ampersand (&) must be specified in the name attribute of the relevant <menu> element in the XML configuration file.

For example, this would specify the View menu which has the mnemonic of "V":

<editLive>
  ...
  <menuBar>
    ...
    <menu name="&amp;View">
      ...
    </menu>
    ...
  </menuBar>
  ...
</editLive>

Menu Items

Menu items within EditLive! for Java are specified through the use of a <menuItem> XML element. The name attribute of the <menuItem> element determines which menu item is inserted. EditLive! for Java is provided with a collection of predefined interface items which may be placed on the EditLive! for Java menus, the shortcut menu or the toolbars. Items from the interface command collection will have default menu item text associated with them. They may also have default mnemonics, images and shortcuts. For more information on what interface commands are available for use please see the EditLive! for Java Interface Command Collection section of this document.

The following example would add the New, Open..., Save and Save As... items to a menu with the name File.

<editLive>
  ...
  <menuBar>
    ...
      <menu name="&amp;File">
        <menuItem name="New"/>
        <menuItem name="Open"/>
        <menuItem name="Save"/>
        <menuItem name="SaveAs"/>
      </menu>
    ...
  </menuBar>
  ...
</editLive>

Menu Item Groups

Some menu items are added to the applet's interface in a group. These groups of menu items within EditLive! for Java are specified through the use of a <menuItemGroup> XML element. The name attribute of the <menuItemGroup> element determines which menu item group is inserted. EditLive! for Java is provided with a collection of predefined interface item groups which may be placed on the EditLive! for Java menus and toolbars. Items from the interface command collection will have default menu item text associated with them. They may also have default mnemonics, images and shortcuts. For more information on what interface commands are available for use please see the EditLive! for Java Interface Command Collection section of this document. The activation of menu items in menu item groups is mutually exclusive, for example, the Browser View item cannot be activated at the same time as the Window View item.

The following example would add the Browser View and Window View items to the View menu.

<editLive>
  ...
  <menuBar>
    ...
      <menu name="&amp;View">
        <menuItemGroup name="FrameView"/>
      </menu>
    ...
  </menuBar>
  ...
</editLive>

Menu Separators

Menu separators are horizontal lines spanning the width of the menu which can be used to visually break a menu into its constituent parts and areas. These are added through the use of the <menuSeparator> within a <menu> element. They serve no purpose other than that of a visual aid.

The About Dialog

The Ephox logo:

and associated About dialog may be removed from the menu interface. The removal of this menu option is achieved through setting the showAboutMenu attribute of the <menuBar> element to false.

For example, the following XML would remove the Ephox branding and associated About dialog from the menu:

<editLive>
  ...
  <menuBar showAboutMenu="false">
    ...
  </menuBar>
  ...
</editLive>      

Menu Internationalization

Menu names in EditLive! for Java (e.g. File, Tools, etc) are specified by developers in the <menu> element. Ephox has provided 8 menu names that will be automatically translated into the end user's current language. These names are listed in the XML Configuration information for the <menu> element.

Toolbars

The EditLive! for Java applet can be instantiated with multiple toolbars. The <toolbar> element is used to specify a toolbar within the EditLive! for Java configuration file. Toolbars will appear within EditLive! for Java in the order which they are listed within the configuration file. When specifying a toolbar with the <toolbar> element the toolbar must be given a unique name via the name attribute. The value of the name attribute does not appear in the user interface of EditLive! for Java.

The following XML would specify a new toolbar with the name format:

<editLive>
  ...
  <toolbars>
    ...
    <toolbar name="format">
      ...
    </toolbar>
    ...
  </toolbars>
  ...
</editLive>      

Each toolbar can have a variety of buttons, button groups and drop down combo boxes added to it. Toolbar buttons are added via the <toolbarButton> element, toolbar button groups through the <toolbarButtonGroup> element and combo boxes through the <toolbarComboBox> element.

Toolbar Buttons

Toolbar buttons in EditLive! for Java are specified through the use of a <toolbarButton> XML element. The name attribute of the <toolbarButton> element determines which toolbar button is inserted. EditLive! for Java is provided with a collection of predefined interface items which may be placed on the EditLive! for Java toolbars, the menus or shortcut menu. Items from the interface command collection will have default tool tip text associated with them. Most also have default images, however some of the items may not have images associated with them. It is recommended that interface commands without associated images are not placed on the toolbars. For more information on what interface commands are available for use please see the EditLive! for Java Interface Command Collection section of this document.

The following example would add the New, Open..., Save and Save As... items to a toolbar with the name command:

<editLive>
  ...
  <toolbars>
    ...
      <toolbar name="command">
        <toolbarButton name="New"/>
        <toolbarButton name="Open"/>
        <toolbarButton name="Save"/>
        <toolbarButton name="SaveAs"/>
      </toolbar>
    ...
  </toolbars>
  ...
</editLive>

Toolbar Button Groups

Some toolbar buttons are added to the applet's interface in a group. These groups of toolbar buttons within EditLive! for Java are specified through the use of a <toolbarButtonGroup> XML element. The name attribute of the <toolbarButtonGroup> element determines which toolbar button group is inserted. EditLive! for Java is provided with a collection of predefined interface item groups which may be placed on the EditLive! for Java menus and toolbars. Items from the interface command collection will have default tool tip text associated with them. Most also have default images, however some of the items may not have images associated with them. It is recommended that interface item groups without associated images are not placed on the interface. For more information on what interface commands are available for use please see the EditLive! for Java Interface Command Collection section of this document.

The following example would add the Align Left, Align Center and Align Right buttons from the alignment button group to the toolbar named command.

<editLive>
  ...
  <toolbars>
    ...
      <toolbar name="command">
        <toolbarButtonGroup name="Align"/>
      </toolbar>
    ...
  </toolbars>
  ...
</editLive>

Toolbar Combo Boxes

Combo boxes for the style, font typeface and font size text attributes can be added to the EditLive! for Java toolbar through the use of a <toolbarComboBox> element with a specific value for the name attribute. Each toolbar combo box has a specific value for the name attribute associated with it. Furthermore, the items listed in each of these combo boxes can be specified by the developer through the inclusion of <comboBoxItem>child elements in a <toolbarComboBox> element.

For example, the following XML would create the Style drop down combo box in the EditLive! for Java Format Toolbar with the listing of Normal, Heading 1, Heading 2 and Heading 3 items which represent the <P>, <H1>, <H2> and <H3> styles respectively:

<editLive>
  ...
    <toolbars>
    ...
      <toolbar name="format">
        ...
        <toolbarComboBox name="tlbStyle">
          <comboBoxItem name="P" text="Normal" />
          <comboBoxItem name="H1" text="Heading 1" />
          <comboBoxItem name="H2" text="Heading 2" />
          <comboBoxItem name="H3" text="Heading 3" />
        </toolbarComboBox>
        ...
      </toolbar>
    </toolbars>
    ...
</editLive>     

The toolbar combo boxes available for use with EditLive! for Java, their corresponding function and their associated value for the <toolbarComboBox> name are listed below in the Toolbar Combo Box Items section of the EditLive! for Java Interface Command Collection.

Toolbar Separators

Toolbar separators are vertical lines spanning the height of the toolbar which can be used to visually break a toolbar into its constituent parts and areas. These are added through the use of the <toolbarSeparator> within a <toolbar> element. They serve no purpose other than that of a visual aid.

The Shortcut (Context) Menu

Shortcut menu items in EditLive! for Java are specified through the use of a <shrtMenuItem> XML element with a specific value for the name attribute associated with it. EditLive! for Java is provided with a collection of predefined interface items which may be placed on the EditLive! for Java shortcut menu. Items from the interface command collection will have default menu item text associated with them. They may also have default images. The shortcut menu can also contain submenus. For more information on what interface commands are available for use please see the EditLive! for Java Interface Command Collection section of this document.

Note

Menu item groups cannot be used on the shortcut menu.

The following example would add the Cut, Copy and Paste items to the Shortcut menu:

<editLive>
  ...
  <shortcutMenu>
      <shrtMenu>
        <shrtMenuItem name="Cut"/>
        <shrtMenuItem name="Copy"/>
        <shrtMenuItem name="Paste"/>
      </shrtMenu>
  </shortcutMenu>
  ...
</editLive>

Submenus

Submenus can be added to the EditLive! for Java menu bar and shortcut menu. The submenus available for use in EditLive! for Java are the Font, (font) Size and Style submenus. These are added through the use of the <submenu> XML element with a specific value for the name attribute.

The <submenu>, if left empty, each of the submenus added will contain the same items as the corresponding item on the EditLive! for Java toolbar. If the corresponding item does not exist on the toolbar then the submenu will appear empty. If the developer wishes to make the submenu items distinct from the toolbar items the <submenu>element may have <menuItem> child elements added to it. It should be noted that once menu items are specified within a submenu then the contents of the submenu will no longer mirror the corresponding toolbar element.

The following example would add the Font submenu to the Format menu with items on the submenu corresponding to the items specified in the Font drop down combo box of the EditLive! for Java toolbar:

<editLive>
  ...
  <menuBar>
    ...
    <menu name="Format">
      ...
      <submenu name="mnuFontFace"/>
      ...
    </menu>
    ...
  </menuBar>
  ...
</editLive>      

The following example would add the Style submenu to the Shortcut menu with items on the submenu corresponding to the items specified in the Font drop down combo box of the EditLive! for Java toolbar:

<editLive>
  ...
  <shortcutMenu>
    <shrtMenu>
      ...
      <submenu name="mnuFontFace" />
      ...
    </shrtMenu>
  </shortcutMenu>
  ...
</editLive>

The following example would add the Style submenu to the Format menu. The menu created would contain the Normal and Heading 1 which respectively correspond to the <P> and <H1> styles. Note that this submenu would NOT contain the values from the corresponding toolbar item.

<editLive>
  ...
  <menuBar>
    ...
    <menu name="Format">
      ...
      <submenu name="mnuFontStyle">
        <menuItem name="P" text="Normal" />
        <menuItem name="H1" text="Heading 1" />
      </submenu>
      ...
    </menu>
    ...
  </menuBar>
  ...
</editLive>       

The submenus available for use with EditLive! for Java, their corresponding toolbar item, mnemonic and their associated value for the <submenu> name are listed below in the Submenu Items section of the EditLive! for Java Interface Command Collection.

Note

The Color and Highlight Color submenus should only be used when customizing the Color and Highlight Color menu items. For more information on customizing the color choosers in EditLive! for Java see the section on Customizing the Color Choosers.

EditLive! for Java Interface Command Collection

Menu and Toolbar Button Items

This collection of interface commands can be used within menus, including the shortcut menu, and toolbars in EditLive! for Java. The items, their corresponding function, tool tip and menu text, mnemonic, shortcuts, images and their associated value for the relevant name attribute are listed below:

Note

It is recommended that items, such as Save As..., are not used within toolbars as they do not have a default image associated with them.

File Commands

Function

XML Name Attribute

Menu or Tool Tip Text

Shortcut

Image

Mnemonic

Create a new file.

New

New

CTRL+N

N

Open an existing file on the local machine.

Open

Open...

CTRL+O

O

Save a file to the local machine.

Save

Save

CTRL+S

S

Save a file to the local machine with a different name.

SaveAs

Save As...

CTRL+

SHIFT+S

N/A

A

Edit Commands

Function

XML Name Attribute

Menu or Tool Tip Text

Shortcut

Image

Mnemonic

Undo the last editor action.

Undo

Undo

CTRL+Z

U

Redo the last undone editor action.

Redo

Redo

CTRL+Y

R

Cut the selection.

Cut

Cut

CTRL+X

T

Copy the selection.

Copy

Copy

CTRL+C

C

Paste.

Paste

Paste

CTRL+V

P

Paste Special.

PasteSpecial

Paste Special

N/A

N/A

S

Select all editor content.

SelectAll

Select All

CTRL+A

N/A

L

Find text in the editor.

Find

Find...

CTRL+F

F

View Commands

Function

XML Name Attribute

Menu or Tool Tip Text

Shortcut

Image

Mnemonic

Show or hide document navigator.

ShowDocument Navigator

Document Navigator

N/A

N/A

N

Show or hide paragraph markers and editing grid lines.

ParagraphMarker

Show/Hide Paragraph Markers

N/A

P

Display EditLive! for Java in a seperate window

Popout

Window View

N/A

P

Insert Commands

Function

XML Name Attribute

Menu or Tool Tip Text

Shortcut

Image

Mnemonic

Insert a hyperlink.

HLink

Hyperlink...

CTRL+K

H

Insert a horizontal line.

HRule

Horizontal Line

N/A

L

Insert a symbol.

Symbol

Symbol...

N/A

S

Insert a bookmark.

Bookmark

Bookmark...

N/A

K

Insert an image from the local machine.

ImageLocal

Local Image...

N/A

N/A

M

Insert an image from the server image library.

ImageServer

Server Image Library...

N/A

I

Insert an embedded object or multimedia file.

InsertObject

Insert Object...

N/A

N/A

N/A

Insert a HTML comment.

InsertComment

Insert Comment...

N/A

N/A

Insert a Date and Time

DateTime

Insert Date and Time...

N/A

T

Format Commands

Function

XML Name Attribute

Menu or Tool Tip Text

Shortcut

Image

Mnemonic

The text color selector.

Color

Color

N/A

C

The text highlight color selector.

HighlightColor

Highlight Color

N/A

C

Bold text.

Bold

Bold

CTRL+B

B

Italic text.

Italic

Italic

CTRL+I

I

Underline text.

Underline

Underline

CTRL+U

U

Strikethrough text.

Strike

Strikethrough

N/A

S

Format painter.

FormatPainter

Format Painter

CTRL + SHIFT + C

N/A

Remove formatting.

RemoveFormatting

Remove Formatting

CTRL + SPACE

R

Increase the paragraph or list indent.

IncreaseIndent

Increase Indent

N/A

N

Decrease the paragraph or list indent.

DecreaseIndent

Decrease Indent

N/A

D

Tool Commands

Function

XML Name Attribute

Menu or Tool Tip Text

Shortcut

Image

Mnemonic

Run the spell checker.

Spelling

Spelling...

F7

S

Turn the background spell checker on and off.

BackgroundSpell Checking

Enable/ Disable Check Spelling As You Type

N/A

B

Perform a word count on the document.

WordCount

Word Count...

N/A

W

Perform an accessibility compliance check on the document, based on the W3C standards.

Accessibility

Accessibility Report...

F8

A

Table Commands

Function

XML Name Attribute

Menu or Tool Tip Text

Shortcut

Image

Mnemonic

Insert a table wizard. Allows user to click and select number of rows and columns.

This item can only be used as a toolbar button.

InsTableWizard

Insert Table

N/A

I

Insert a table.

InsTable

Insert Table...

N/A

I

Insert a row in the current table.InsRowInsert RowN/A

N/A
Insert a column in the current table.InsColInsert ColumnN/A

N/A

Insert rows or columns in the table.

InsRowCol

Insert Row or Column...

N/A

N/A

R

Insert a cell in a table.

InsCell

Insert Cell

N/A

N/A

E

Delete a row from a table.

DelRow

Delete Row

N/A

D

Delete a column from a table.

DelCol

Delete Column

N/A

C

Delete a cell from a table.

DelCell

Delete Cell

N/A

N/A

L

Split a cell in a table.

Split

Split Cell...

N/A

S

Merge cells in a table.

Merge

Merge Cells

N/A

M

Toggle table gridlines on and off.

Gridlines

Show/Hide Gridlines

N/A

G

Properties Commands

Function

XML Name Attribute

Menu or Tool Tip Text

Shortcut

Image

Mnemonic

Edit the current cell's properties.

PropCell

Cell Properties...

N/A

N/A

R

Edit the selected row's properties.

PropRow

Row Properties...

N/A

N/A

N/A

Edit the selected column's properties.

PropCol

Column Properties...

N/A

N/A

N/A

Edit the current table's properties.

PropTable

Table Properties...

N/A

N/A

T

Edit the properties of a list.

PropList

List Properties...

N/A

N/A

N/A

Edit the properties of an embedded object.

PropObject

Object Properties...

N/A

N/A

N/A

Edit the properties of a horizontal line.

PropHR

Horizontal Line Properties...

N/A

N/A

N/A

Form Commands

Note

Form Commands can only be placed within the menu of an instance of EditLive! for Java and not the toolbar.

Function

XML Name Attribute

Menu or Tool Tip Text

Shortcut

Image

Mnemonic

Insert a form.

InsForm

Insert Form

N/A

N/A

F

Insert a text field into a form.

InsTextField

Insert Text Field

N/A

N/A

T

Insert a password field into a form.

InsPasswordField

Insert Password Field

N/A

N/A

P

Insert a hidden field into a form.

InsHiddenField

Insert Hidden Field

N/A

N/A

H

Insert a file browsing field into a form.

InsFileField

Insert File Upload Field

N/A

N/A

I

Insert a button into a for

InsButtonField

Insert Button Field

N/A

N/A

B

Insert a submit button into a form.

InsSubmitField

Insert Submit Field

N/A

N/A

S

Insert a reset button into a form.

InsResetField

Insert Reset Field

N/A

N/A

R

Insert a checkbox into a form.

InsCheckboxField

Insert Checkbox Field

N/A

N/A

C

Insert a radio-button into a form.

InsRadioField

Insert Radio Field

N/A

N/A

A

Insert a text area into a form.

InsTextAreaField

Insert TextArea Field

N/A

N/A

E

Insert a selection / combobox into a form.

InsSelectField

Insert Select Field

N/A

N/A

L

Insert an image field into a form.

InsImageField

Insert Image Field

N/A

N/A

I

Display the Form Properties Dialog for a form.

PropForm

Form Properties...

N/A

N/A

N/A

Miscellaneous Commands

Function

XML Name Attribute

Menu or Tool Tip Text

Shortcut

Image

Mnemonic

Edit a HTML comment, scripting tag or unknown custom tag.

EditTag

Edit Tag...

N/A

N/A

Remove a hyperlink.

RemoveHyperlink

Remove Hyperlink

N/A

N/A

EditLive! Equation Editor Specific Menu and Toolbar Items

The following menu and toolbar items can only be used with the EditLive! Equation Editor Add-On

Function

XML Name Attribute

Menu or Tool Tip Text

Shortcut

Image

Mnemonic

Insert a MathML mathematical equation.

InsertEquation

Insert Equation

N/A

E

Edit a MathML mathematical equation.

EditEquation

Edit Equation...

N/A

N/A

N/A

Menu Item and Toolbar Button Groups

This collection of interface commands can be used only within menus and toolbars in EditLive! for Java. These interface items are added as a group of buttons or menu items within EditLive! for Java. The activation of buttons and menu items in the groups is mutually exclusive, for example, the left alignment item cannot be activated at the same time as the center or right alignment buttons. The items, their corresponding function, tool tip and menu text, mnemonic, shortcuts, images and their associated value for the relevant name attribute of the group are listed below:

Note

These groups cannot be added to the shortcut menu within EditLive! for Java.

View Commands

Function

XML Name Attribute

Menu or Tool Tip Text

Shortcut

Image

Mnemonic

View the document in Design mode (WYSIWYG mode).

SourceView

Design View

N/A

N/A

D

View and edit the HTML source for the document.

HTML View

N/A

N/A

H

View the applet in the browser.

FrameView

Browser View

N/A

N/A

B

View the applet in a separate window.

Window View

N/A

N/A

W

Formatting Commands

Function

XML Name Attribute

Menu or Tool Tip Text

Shortcut

Image

Mnemonic

Insert an ordered list or change an unordered list to an ordered list.

List

Ordered List

N/A

O

Insert an unordered list or change an ordered list to an unordered list.

Unordered List

N/A

T

Set left alignment.

Align

Align Left

CTRL+L

L

Set center alignment.

Align Center

CTRL+E

C

Set right alignment.

Align Right

CTRL+R

R

Superscript text.

Script

Superscript

N/A

S

Subscript text.

Subscript

N/A

S

Submenu Items

The following predefined submenus can be used in any menu of the EditLive! for Java interface.

Submenu Item Name

XML Name Attribute

Mnemonic

Function

Font

FontFace

F

List the available fonts.

Size

FontSize

S

List the available font sizes.

Style

Style

T

List the available styles.
ColorColorCList the available text foreground colors.
Highlight ColorHighlightColorCList the available highlighter colors.
SelectSelectSList the elements available for selection according to the

Note

The Color and Highlight Color submenus should only be used when customizing the Color and Highlight Color menu items. For more information on customizing the color choosers in EditLive! for Java see the section on Customizing the Color Choosers.

Toolbar Combobox Items

The following predefined combo box items are available for use on the EditLive! for Java toolbars.

Example Image

Function

XML Name Attribute

List of styles available for use in this document.

Style

List of fonts available for use in this document.

Face

List of font sizes available for use in this document.

Size

Customizing Available Items

The interface items available through the standard EditLive! for Java interface command collection can be customized to allow the associated text, mnemonic and image to be altered. These customizations can be performed on menu and toolbar items by setting the text, imageURL and mnemonic attributes of the <menuItem> and <shrtMenuItem> and the text and imageURL attributes of the <toolbarButton> element.

Note

The properties of menu item and toolbar button groups cannot be customized.

The following example customizes the New menu item to use the text Create New, the image customImage.gif and the mnemonic c.

<editLive>
  ...
  <menuBar>
    ...
      <menu name="&amp;File">
        <menuItem
          name="New"
          text="Create New"
          imageURL="customImage.gif"
          mnemonic="c"
        />
        ...
      </menu>
    ...
  </menuBar>
  ...
</editLive>

Customizing the Color Choosers

The color choosers for both the Color and Hightlight Color menu and toolbar items can be customized to include only a specific set of predefined colors. The More Colors... item will also be available in addition to any predefined colors.

In order to customize the Color or Highlight Color menu items the relevant <menuItem> element must be replaced with a <submenu> element with the same name attribute. Each color should then be listed as a separate <menuItem> element. For each color <menuItem> element the name attribute should provide the HTML color value (either as a hexidecimal color value or reserved color key word, e.g. #FF0000 or red). The text attribute for each color <menuItem> element should provide a text description of the color.

Example 9.1. Custom Color Chooser in a Submenu

The following example creates a custom color chooser in a submenu to customize the Color menu item. The submenu will contain the colors Red, Blue and Green.

<editLive>
  ...
  <menuBar>
    ...
      <menu name="F&amp;ormat">
        ...
        <submenu name="mnuColor">
          <menuItem name="#FF0000" text="Red" />
          <menuItem name="blue" text="Blue" />
          <menuItem name="green" text="Green" />
        </submenu>
        ...
      </menu>
    ...
  </menuBar>
  ...
</editLive>

In order to customize the Color or Highlight Color toolbar items the relevant <toolbarButton> element must be replaced with a <toolbarComboBox> element with the same name attribute. Each color should then be listed as a separate <comboBoxItem> element. For each color <comboBoxItem> element the name attribute should provide the HTML color value (either as a hexidecimal color value or reserved color key word, e.g. #FF0000 or red). The text attribute for each color <comboBoxItem> element should provide a text description of the color.

Example 9.2. Custom Color Chooser in a Toolbar

The following example creates a custom color chooser in a submenu to customize the Highlight Color toolbar button. The drop down will contain the colors Red, Blue and Green.

<editLive>
  ...
  <toolbars>
    ...
      <toolbar name="format">
        ...
        <toolbarComboBox name="tlbHighlightColor">
          <comboBoxItem name="#FF0000" text="Red" />
          <comboBoxItem name="blue" text="Blue" />
          <comboBoxItem name="green" text="Green" />
        </toolbarComboBox>
        ...
      </toolbar>
    ...
  </toolbars>
  ...
</editLive>

Creating New Items

Custom items can be added to the EditLive! for Java menus and toolbars. This gives the developer greater flexibility when integrating EditLive! for Java in existing systems. It allows developers to complement the functionality of EditLive! for Java with existing JavaScript functions and also to extend the menus and toolbars of the EditLive! for Java applet to include custom functionality.

EditLive! for Java allows for the specification of custom menu items, custom toolbar buttons and custom toolbar combo boxes, this can be done with the <customMenuItem>, <customToolbarButton> and <customToolbarComboBox> elements respectively.

For more information on how to use custom items in EditLive! for Java please see the article on Custom Menu and Toolbar Items for EditLive! for Java.

Tab Views

EditLive! for Java can be configured to use a tabbed view which allows users to more intuitively switch between different views. These tabs can be placed on the top or bottom of the EditLive! for Java editing area, they can also be removed completely. The configuration of the tabbed view for EditLive! for Java is achieved via the tabPlacement attribute of the <wysiwygEditor> element.

For example, the following XML would place the view tabs at the top of the EditLive! for Java editing pane.

<editLive>
    ...
    <wysiwygEditor tabPlacement="top">
    ...
</editLive>       

The tabbed view settings for use with EditLive! for Java and their associated value for the <wysiwygEditor> tabPlacement attribute are listed below.

Example Image

Function

XML tabPlacement Attribute

Place tabs at the top of the editing pane.

top

Place tabs at the bottom of the editing pane.

bottom

Remove tabs.

off

Removing the Menu Bar and Toolbars

Both the menu bar and either of the toolbars of EditLive! for Java may be removed. In order to display EditLive! for Java without any toolbars ensure that there are no <toolbar> elements within the configuration file.

To remove the menu bar ensure that the <menuBar>element is empty (i.e. it has no child elements) and ensure that the showAboutMenu attribute of the <menuBar>element is set to false.

Limiting the Functionality of EditLive! for Java

Removing specific functionality from EditLive! for Java is achieved by removing the corresponding menu and/or toolbar buttons from the EditLive! for Java interface. When the item is not included in the XML configuration then the item will not appear on the menu or toolbar and, in most cases, the shortcut key for the item will be disabled.

It should be noted that the shortcut keys for the Cut, Copy, Paste, Bold, Italic and Underline actions will always be enabled. This is independent of the associated menu items and toolbar buttons. Thus, the shortcut keys for these functions will still be functional even if the associated menu items or toolbar buttons are removed.

Summary

The interface for EditLive! for Java is highly customizable. Through the EditLive! for Java configuration process developers gain the flexibility to make the interface for EditLive! for Java as simple or as complex as they wish. EditLive! for Java is supplied with a standard complement of menu and toolbar items providing editor functionality. These items are listed in the above sections of this document along with all the relevant information pertaining to each item.

Furthermore, EditLive! for Java gives the developer the ability to create custom functionality which can be accessed through custom menu and toolbar items. This can be used to complement the functionality of the EditLive! for Java applet with the developers own custom functions and macros.

Finally, through the exclusion of relevant menu and toolbar items the developer can limit the functionality of the EditLive! for Java applet, thus preventing end users from accessing functionality which the developer does not wish them to.