Writing Custom CellRenderer using the Declarative new GWT 2.5 UiRenderer

before gwt 2.5, writing a custom cellrenderer to present data in a certain manner was very complicated and very difficult to achieve.

all the custom ui code had to be written inside a java class that inherits from the abstractcell class, using html strings concatenation, which is a pretty clunky solution. if you want something cleaner you could choose to use the @template class, but still it is very difficult to write and to maintain.

i always said, if only google would add in gwt the ability to define the ui of a custom cellrenderer using xml, just like they did with the introduction of uibinder, and to have the possibility to bind the ui components using the @uifield and to hook event processing using @uihandler ==> hooraaahhhh !!!! this dream came true with gwt 2.5, and it is called the uirenderer .

in this article i’ll show some snippets of codes of a real use case example to explore most of the features brought to us with uirender. first let’s describe the custom cellrenderer we will implement.

as you can see in the schema, the cell item renderer is composed of a picture, a text and two buttons, one to remove the item and the other one to open a popup for editing data.

to create a custom cellrenderer using uirenderer we have to create two files, one containing the xml declarative ui code (think of the myview.ui.xml files), and the other one holds the associated java view (think of the myview.java). the two files must have the same name.

declarative ui code of mycellrenderer.ui.xml :

one thing to remember, the difference between the uirenderer and uibinder is that in uirenderer you can only use html tags. all gwt custom components will not work in here. i hope google will add this feature in a future release.

<ui:uibinder xmlns:ui='urn:ui:com.google.gwt.uibinder'>
    <ui:with field='name' type='java.lang.string'/>
    <ui:with field='image' type='java.lang.string'/>

    <ui:style>
        .imagewrapper {
            float: left;
            margin-right: 10px;
        }
        .imagewrapper img {
            width: 64px;
            height: 64px;
        }
        .infowrapper {
            float: left;
        }
        .infowrapper div span {
            display: inline-block;
            marin-right: 5px;
            text-decoration: underline;
            cursor: pointer;
        }
    </ui:style>

    <div>
        <div class="imagewrapper">
            <img alt="{name}" src="{image}" />
        </div>

        <div class="infowrapper">
            <h3><ui:text from="{name}"/></h3>
            <div>
                <span ui:field="remove">remove</span>
                <span ui:field="update">update</span>
            </div>
        </div>

        <div style="clear: both;"/>
    </div>
</ui:uibinder>

custom cellrenderer java file mycellrenderer.java :

this file will manage the ui logic, like for example passing the data to be displayed, formatting data (date conversion, number conversion…), handling events…

in this example, we have two events to handle (the click on remove and update buttons). thanks to uirenderer, we can use ui:fields and the @uihandler annotation. there is some other boilerplate code to add, like the onbrowse event handler to make it work (everything is well described in the snippet of code below).

public class mycellrenderer extends abstractcell {
    // this can be compared to uibinder --> here where all magic is done
    public interface renderer extends uirenderer {
        void render(safehtmlbuilder sb, string name, string image);

        void onbrowserevent(mycellrenderer o, nativeevent e, element p, person n);
    }

    private final renderer uirenderer;

    @inject
    public mycellrenderer(final renderer uirenderer) {
        super(browserevents.click);
        this.uirenderer = uirenderer;
    }

    @override
    public void onbrowserevent(context context, element parent, person value, nativeevent event,
                               valueupdater valueupdater) {
        uirenderer.onbrowserevent(this, event, parent, value);
    }

    @override
    public void render(context context, person value, safehtmlbuilder safehtmlbuilder) {
        // all data extraction, transformation should be done in here
        string name = value.getfirstname() + value.getlastname();
        string image = value.getimage();

        // we directly the uirenderer and we pass the htmlbuilder
        uirenderer.render(safehtmlbuilder, name, image);
    }

    @uihandler({"remove"})
    void onremovepersonclicked(clickevent event, element parent, person value) {
        window.alert("do you want to remove : " + value.getfirstname());
    }

    @uihandler({"update"})
    void onupdatepersonclicked(clickevent event, element parent, person value) {
        //maybe use the actioncell.delegate to process the action elsewhere...
        window.alert("do you want to update : " + value.getfirstname());
    }
}

using the new renderer in a celllist :

now that we are done writing our custom, sophisticated and good looking cellrenderer (:d), we can use it the same way we used the old legacy renderer. i added below a small snippet to show you how in case you forget:

public class myview extends composite {
    public interface binder extends uibinder<widget, webcartview> {
    }

    @uifield(provided = true)
    celllist personlist;

    @inject
    public myview(final binder uibinder, final mycellrenderer mycellrenderer) {
        personlist = new celllist(mycellrenderer); // same way as using old renderers
        ....  // continue what you always do...
    }
}

that’s it for this article, i hope this was useful and will help you build more awesome sophisticated apps without having to write a lot of complicated code. ps: this new uirenderer can be used with any cell based gwt widget.

for more details check the following links : http://goo.gl/2fepf (gwt 2.5 uirenderer official docs ), http://goo.gl/ogr3j (cell widget docs).