Understanding LWUIT List
This article explains the LWUIT List Component. This component is usually the hardest to understand out of all the LWUIT components. This article is intended for beginners so that they can understand how it works.
LWUIT list is one of the most often used component, at the same time , it is the least understood component. This is primarily because a LWUIT list makes use of MVC model.
MVC stands for Model - View - Controller.
1.) Model - Model contains the data that is to be displayed.
2.) View - The view contains the logic that renders the list on the screen.
3.) Controller - Controller coordinates the Model and View
In LWUIT List, the Model is a List Model, View is a List Cell Renderer and Controller is the List itself.
Default Model and Renderer
While this might seem like a complex set of process to be taken care of for creating a list, however, LWUIT has a Default List Model and Default List Cell Renderer that is suitable for most common operations.
The default list model along with the default list cell renderer is created in the background for a simple list that displays a string at each row.
This automatically creates a simple list , with a default list model and a default list cell renderer, with each row containing one entry. The entries apple, orange ,mangoes and peaches are added into the default list model.
A Custom Designed list
We will now talk about how to create a custom list which is shown in the figure.
The list model contains an image,a heading string and a description string. We will have all these in a class.
public class ModelData
public ModelData(String heading, String description, String imgLocation)
this.name = heading;
this.description = description;
this.display_pic = Image.createImage(imgLocation);
} catch (IOException ex)
public Image getDisplay_pic()
public void setDisplay_pic(Image display_pic)
this.display_pic = display_pic;
public String getName()
public void setName(String name)
this.name = name;
public String getDescription()
public void setDescription(String description)
this.description = description;
Now we can use an array/vector of objects of this class as our list model.
We will now create our List cell Renderer. To do this, we need to implement ListCellRenderer interface.
The getListCellRendererComponent method is called for painting each row in the list. This method is expected to return a component each time it is called. Since memory allocation is a time consuming process, it is not advisable to create a new component and return that. We will instead extend a pre-existing component and return that.
The image shows how each entry in the row should look like. We will implement this within our renderer using layouts.
class myRenderer extends Container implements ListCellRenderer
Container left = new Container();
Container right = new Container();
dp = new Label();
heading = new Label();
description = new Label();
//Adding them to the main container
public Component getListCellRendererComponent(List list, Object value, int index, boolean isSelected)
public Component getListFocusComponent(List list)
In the above code, we have managed to create the necessary layout we need. We will now map the data to the components in this container. This is done in the getListCellRendererComponent Method.
getListCellRendererComponent(List list, Object value, int index, boolean isSelected)
For rendering each row, this method is called. The present index which is being rendered is available in the index variable. The value contains the data for that particular index, taken from the list model. We will typecast the value variable to our need and use it. The resulting method is shown below.
Now everything is ready. We just need to populate the list with a few entries. I have added a few dummy entries along with a few sample pictures.
List myComplexList = new List();
//Creating the data
ModelData entries = new ModelData
new ModelData("John", "Lives in New York", "/images/1.png"),
new ModelData("Jim", "He works in a bank.", "/images/2.png"),
new ModelData("Jack", " Lives in Australis", "/images/3.png"),
new ModelData("Jill", "Works with the Police", "/images/4.png")
//Creating a Default List Model and putting the data in it.
DefaultListModel dlm = new DefaultListModel(entries);
// Setting the model.
// Setting the renderer.
Interacting with the List
You can use either a Selection Listener or an ActionListener in a list for interacting with it. Action Listeners are more commonly used , especially in touch devices.
We use the method getSelectedItem() for getting the currently selected item.
Precautions & Limitations
While Lists are very powerful (Million Entry List), it is important to keep in mind that it has its own limitations.
A List Row can have only a fixed width/height. Hence complex animations/expansion of a particular row in a list is not possible. A Component called Container List does not have this problem.
The following articles are worth reading :
This article is intended to give an introduction to LWUIT lists for beginners.