This element specifies the properties for a developer defined custom combo box item for use within Ephox EditLive! for XML. The custom combo box item must be listed within a <customToolbarComboBox> element and will therefore appear on one of the toolbars within EditLive! for XML.
<customComboBoxItem>
<editLive>
...
<toolbars>
<toolbar>
<customToolbarComboBox>
<customComboBoxItem ... />
</customToolbarComboBox>
</toolbar>
</toolbars>
...
</editLive>The name which uniquely defines this custom combo box item within the <customToolbarComboBox> element. This means that there cannot be two <customComboBoxItem> elements with the same name within one <customToolbarComboBox> element.
The text to represent this item within the combo box it is to be listed in.
The action which this custom combo box item performs when selected.
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 given name
customPropertiesDialog - Call a JavaScript function with the given name and pass it the current tag's properties
PostDocument - Post the content of the applet to a server side script
The value of the text or hyperlink to be inserted or the name of the JavaScript function to be called when this toolbar button is clicked.
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 following example demonstrates how to define a custom combo box item for use within a custom combo box which exists on the EditLive! for Java Command Toolbar. The combo box 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>
...
<toolbars>
<toolbar name="command">
<customToolbarComboBox name="customCombo">
<customComboBoxItem
name="customComboItem1"
text="Custom Combo Item"
action="insertHTMLAtCursor"
value="%3Cp%3EHTML%20to%20insert%3C/p%3E" />
</customToolbarComboBox>
</toolbar>
</toolbars>
...
</editLive> The <customComboBoxItem> element can appear multiple times within the <customToolbarComboBox> element.
The <customComboBoxItem> 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:
<customComboBoxItem name=... />
Text assigned to the value attribute must be URL encoded as it is in the example above.
Copyright 2001-2004 Ephox Corporation. All Rights Reserved.