This element specifies the properties for a developer defined custom menu item for use within Ephox EditLive! for XML.
<editLive>
...
<menuBar>
...
<menu>
<customMenuItem... />
</menu>
...
</menuBar>
...
</editLive>The name which uniquely defines this custom menu item.
The text to place on the menu for this item.
The action which this menu item performs when clicked on.
This attribute has the following possible values:
insertHTMLAtCursor - Insert the given HTML at the cursor
insertHyperlinkAtCursor - Insert the given hyperlink at the cursor
raiseEvent -Call a JavaScript function with the name specified in the value attribute. An event is also fired to the ELXBean using this XML configuration file. The following values will be assigned to the TextEvent sent with the event:
Action Command = TextEvent.CUSTOM_ACTION
Extra String = the string specified in the value attribute
Extra Object = a Java Map containing the attributes of the element selected when the custom menu item was selected. In the case of this example, this element will be a <td> element.
The event sent to the bean will also have the value TextEvent.CustomAction.RAISE_EVENT added to the extra int property of the event.
When the event has been handled (by using the event method setHandled(boolean b), where b = true), the javascript function defined in value will be called.
customPropertiesDialog - Fires an event for the ELXBean using this XML configuration file. The following values will be assigned to the TextEvent sent with the event:
Action Command = TextEvent.SHOW_CUSTOM_PROPERTIES
Extra String = the string specified in the value attribute
Extra Object = a Java Map containing the attributes of the element selected when the custom menu item was selected. In the case of this example, this element will be a <td> element.
The value of this attribute depends on the value specified in the action attribute
insertHTMLAtCursor - value will be a string of HTML.
InsertHyperlinkAtCursor - value will be a URL
raiseEvent - value will be the name of a JavaScript function
customPropertiesDialog - value will be the Extra String field of the TextEvent sent with the ELXBean event.
When using the insertHTMLAtCursor action the HTML to be inserted must be URL encoded in the XML file. For example, <p>HTML to insert<p> becomes %3Cp%3EHTML%20to%20insert%3C/p%3E.
The URL of the image to be placed on the menu with the menu item text. The image should be of a .gif format and be a size of sixteen (16) pixels high and sixteen (16) pixels wide.
This URL can be relative or absolute. Relative URLs are relative to the location of the page in which EditLive! for XML is embedded.
This attribute defines in which tags the function should be enabled. For example, when set to td the function will be enabled when the cursor is within a <td> tag (i.e. a table cell).
The following example demonstrates how to define a custom menu item for use within EditLive! for XML. The menu item defined in this example will insert HTML to insert at the cursor, note that the value in the example below is URL encoded.
<editLive>
...
<menuBar>
...
<menu name="Example">
<customMenuItem
name="customItem1"
text="Custom Item"
imageURL="http://www.someserver.com/image16x16.gif"
action="insertHTMLAtCursor"
value="%3Cp%3EHTML%20to%20insert%3C/p%3E" />
</menu>
...
</menuBar>
...
</editLive> The following example demonstrates how to define a custom properties dialog which is launched from a custom menu item for use within EditLive! for XML. The custom properties dialog will be available for use when the cursor is inside any <td> tag.
<editLive>
...
<menuBar>
...
<menu name="Example">
<customMenuItem
name="customProperties1"
text="Custom td Properties"
action="customPropertiesDialog"
value="customTDFunction"
enableintag="td"
/>
</menu>
...
</menuBar>
...
</editLive> The <customMenuItem> element can appear multiple times within the <menu> element.
The <customMenuItem> element must be a complete tag, it cannot contain a tag body. Therefore the tag must be closed in the same line. See the example below:
<customMenuItem name=... />Text assigned to the value attribute must be URL encoded as it is in the example above.
Copyright 2001-2005 Ephox Corporation. All Rights Reserved.