Using an Item Renderer with a List

This example shows how to use an ItemRenderer to display the items in a List in your Royale application. It uses the new Jewel UI set that supports themes and is available in the 0.9.4 release or later.

<?xml version="1.0" encoding="UTF-8"?>
<j:Application xmlns:fx=""

        @namespace "";
        @namespace j "library://";

            IItemRenderer: ClassReference("itemRenderers.IconListItemRenderer");
        .iconListItemRenderer .fonticon
            margin-right: 24px;

        <models:ListsModel id="listModel"/>


            <j:Card width="340">
                    <html:H3 text="Jewel List With ItemRenderer" className="primary-normal"/>
                    <j:List width="100%" height="300" className="iconListItemRenderer">


By default, Apache Royale Jewel List-based controls display their data as plain text using ListItemRenderer. But Royale is capable of much more, and you can extend ListItemRenderer to display the items in your list in a pleasing and user-friendly way.

In this example we created an IconListItemRenderer in mxml that extends ListItemRenderer:

<?xml version="1.0" encoding="utf-8"?>
<j:ListItemRenderer xmlns:fx=""

            import vos.IconListVO;
            public function get iconList():IconListVO
                return data as IconListVO;

        <js:ItemRendererDataBinding />
        <j:HorizontalLayout gap="3" itemsVerticalAlign="itemsCenter"/>
    <js:MaterialIcon text="{iconList ? iconList.icon : ''}" visible="{iconList ? iconList.icon != null : false}"/>

    <html:Span text="{iconList ? iconList.label : ''}"/>

The list gets its items from the data provider and passes them through the item renderer. The item renderer models each item in a consistent way: it adds a FontIcon to display an appropriate icon (selected, in this case, from the Google Material Icons font) at the left, and the text of the item in a Label to the right. To manage the components for each list item, you can use absolute positioning, layout classes or CSS. We used CSS in the fx:Style section in the main file for simplicity. As you see, the item renderer is declared in CSS as well, and is located in the itemRenderers package.

Note that we use Data Binding, deploying ItemRendererDataBinding. Data binding in Royale is not available by default to reduce code size. You add it where you need it, following the PAYG principle in Royale: Pay As You Go. We add a data binding bead here since we need the function, and not anywhere we don't need it.

The data used in the List control dataProvider is declared in the ActionScript 3 ListsModel class:

package models
    import org.apache.royale.collections.ArrayList;
    import vos.IconListVO;

    public class ListsModel 
         * this is the dataProvider for the List
        private var _iconListData:ArrayList = new ArrayList([
            new IconListVO("Alert", MaterialIconType.WEB_ASSET),
            new IconListVO("Button", MaterialIconType.CROP_7_5),
            new IconListVO("DropDownList", MaterialIconType.CREDIT_CARD),
            new IconListVO("CheckBox", MaterialIconType.CHECK_BOX),
            new IconListVO("Label", MaterialIconType.LABEL),
            new IconListVO("List", MaterialIconType.LIST_ALT),
            new IconListVO("RadioButton", MaterialIconType.RADIO_BUTTON_CHECKED),
            new IconListVO("Slider", MaterialIconType.STORAGE),
            new IconListVO("Text", MaterialIconType.SUBJECT),
            new IconListVO("TextInput", MaterialIconType.TEXT_FIELDS)            

        public function get iconListData():ArrayList
            return _iconListData;

The MaterialIconType class uses the icon names as they appear in the Material Icons font for convenience and to avoid typos. One additional benefit of using MaterialIconType in your code is that it injects the font into your html directly, without you having to deal with that step.

This class uses a data object (DOT, or POJO, depending on how you name this kind of code), called IconListVO to instance each piece of data that will appear in the List control.

Here's the result of this code snippet:

package vos
    public class IconListVO
        public var label:String;
        public var icon:String;

        public function IconListVO(label:String, icon:String = null)
            this.label = label;
            this.icon = icon;

In the main file, note how we link the ListsModel class through the model variable accessible throughout Royale to make it easy to link a model as a bead.

Finally, we link the model data to the list dataProvider using data binding, with ApplicationDataBinding (since we are at the Application level) and the ConstantBinding class that knows where the data is located (sourceID), what property holds it (iconListData) and where to inject the data (destinationPropertyName).

Hope you like this example 🙂

Where to go from here

The result of this code snippet is the following:

(We're using an iframe to host the actual results of this example compilation. To see the example in a separate window click this link.)

Full project with source code can be found here:

Project Source Code