<comboBoxItem> Configuration Element
Prev Chapter 18. XML Configuration API Next

<comboBoxItem> Configuration Element

This element contains the information required by Ephox EditLive! for XML to configure an item within one of the EditLive! for XML combo boxes.

Configuration Element Tree Structure

<editLive>
     ...
     <toolbars>
          <toolbar>
               <toolbarComboBox ... >
                    <comboBoxItem ... />
               </toolbarComboBox>
          </toolbar>
     </toolbars>
     ...
</editLive>

Required Attributes

name

The value of the name attribute is different depending on the type of combo box being configured. The following gives information on the way that the name attribute is used in each case:

Style Combo Box

This attribute gives the value to be used when the item is being inserted into the HTML source code. When used in the Style combo box the name attribute gives the name of the tag inserted into the HTML source code within EditLive! for Java.

Example: If the name attribute was set to H1 then the <H1> tag would be inserted into the HTML when this style was used.

Typeface Combo Box

This attribute gives the value to be used when the item is being inserted into the HTML source code. When used in the Typeface combo box the name attribute gives the value used for the face attribute within the <FONT> tag used within the EditLive! for Java HTML source code.

Example: If the name attribute was set to Times New Roman then the following <FONT> tag would be inserted into the EditLive! for XML HTML source code:

<FONT face="Times New Roman">

Size Combo Box

This attribute gives the value to be used when the item is being inserted into the HTML source code. When used in the Size combo box the name attribute gives the value used for the size attribute within the <FONT> tag used within the EditLive! for Java HTML source code.

Note

The name attribute for the Size combo box must be between 1 and 7, inclusive.

Example: If the name attribute was set to 3 then the following <FONT> tag would be inserted into the EditLive! for XML HTML source code:

<FONT size="3">

Optional Attributes

text

This attribute gives the value which appears inside the relevant combo box within EditLive! for XML (eg. Heading 1, Normal, 12pt, Times New Roman).

Example

The following example adds the H1 style to the Style combo box so that it appears as "Heading 1" inside the combo box in EditLive! for XML. Also added is the Arial font to the Typeface combo box and it is listed as "Company Font" in the combo box in EditLive! for XML. Finally the HTML font size 3 is added to the Size combo box and lists it as "12pt" in the combo box in EditLive! for XML.

All the combo boxes in this example are added to the Format Toolbar.

<editLive>
    ...
    <toolbars>
        <toolbar name="format">
            <toolbarComboBox name="Style">
                <comboBoxItem name="H1" text="Heading 1"/>
            </toolbarComboBox>
            <toolbarComboBox name="Face">
                <comboBoxItem name="Arial" text="Company Font"/>
            </toolbarComboBox>
            <toolbarComboBox name="Size">
                <comboBoxItem name="3" text="12pt"/>
            </toolbarComboBox>
        </toolbar>
    </toolbars>
    ...
</editLive>

Remarks

The <comboBoxItem> element can appear multiple times within the <toolbarComboBox> element.

The <comboBoxItem> 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:

<comboBoxItem name=... />

Copyright 2001-2004 Ephox Corporation. All Rights Reserved.

Prev Up Next
<toolbarComboBox> Element Home <customToolbarButton> Configuration Element