net.rim.device.api.ui.component.table
Class RichListDataTemplate

java.lang.Object
  net.rim.device.api.ui.component.table.DataTemplate
      net.rim.device.api.ui.component.table.RichListDataTemplate

public class RichListDataTemplate
extends DataTemplate

This class describes a default implementation of a DataTemplate for the needs of the RichList class. All model Strings become LabelFields that use all available width, truncate with an ellipses and are focusable. All model Bitmaps become BitmapFields with no style. All model Fields remain as they are. Anything else is ignored.

Since:

BlackBerry API 6.0.0

Constructor Summary

RichListDataTemplate(DataView view, int rows, int columns)
Creates an instance of a RichListDataTemplate.

Method Summary
Field[]	getDataFields(int modelRowIndex) Given an index for a model row, this method reads the row from the model and returns an array of fields encompassing the data found.

Methods inherited from class net.rim.device.api.ui.component.table.DataTemplate

createRegion, createRegion, getColumnProperties, getNumberOfColumns, getNumberOfRegions, getNumberOfRows, getRowProperties, getView, isFixedHeight, setColumnProperties, setPosition, setRowProperties, useFixedHeight

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RichListDataTemplate

public RichListDataTemplate(DataView view,
                            int rows,
                            int columns)

Creates an instance of a RichListDataTemplate.

Parameters:

view - The DataView object to which this RichListDataTemplate will be associated.

rows - The number of region rows in the RichListDataTemplate.

columns - The number of region columns in the RichListDataTemplate

Since:

BlackBerry API 6.0.0

Method Detail

getDataFields

public Field[] getDataFields(int modelRowIndex)

Given an index for a model row, this method reads the row from the model and returns an array of fields encompassing the data found. The fields are created as described in RichListDataTemplate.

Specified by:

getDataFields in class DataTemplate

Parameters:

modelRowIndex - An integer representing the row index in the model associated to the view of this DataTemplate.

Returns:

An array of Field objects that represent the data found at the specified model row.

Since:

BlackBerry API 6.0.0