Diamond Control Suite 3.0

diamondedge.swing
Interface DsListObject

All Known Subinterfaces:
DsListViewObject

public interface DsListObject

Instances of classes that implement DsListObject can be loaded into a DsComboBox or DsListView using the addItems method. A DsListItem will be created for each DsListObject with all of the properties filled in based on information obtained from this object.


Method Summary
 int getColumnCount()
          Returns the number of columns in the DsListItem.
 String getColumnName(int column)
          Returns the column name for the specified column.
 String getKey()
          Returns the unique string by which this item can be located.
 Object getSmallIcon()
          Returns an Icon or Image that is used in all views except the LARGE_ICON view.
 Object getValue(int column)
          Returns the value for the specified column.
 void initializeItem(DsListItem item)
          initializeItem is called by the containing list to give an opportunity to do any initialization of the DsListItem such as cell formatting after it has been created an populated with data from the other methods.
 

Method Detail

getColumnCount

int getColumnCount()
Returns the number of columns in the DsListItem.


getValue

Object getValue(int column)
Returns the value for the specified column.


getColumnName

String getColumnName(int column)
Returns the column name for the specified column.


getKey

String getKey()
Returns the unique string by which this item can be located. Implementing this is optional and can just return null.


getSmallIcon

Object getSmallIcon()
Returns an Icon or Image that is used in all views except the LARGE_ICON view. It can also return an index (Integer) or key (String) of an icon in an associated IconList control. Implementing this is optional and can just return null.


initializeItem

void initializeItem(DsListItem item)
initializeItem is called by the containing list to give an opportunity to do any initialization of the DsListItem such as cell formatting after it has been created an populated with data from the other methods. This is also called during DsListView.refresh Implementing this is optional and can simply do nothing.


Diamond Control Suite 3.0

Diamond Edge and Diamond Control Suite are trademarks or registered trademarks of Diamond Edge, Inc. Copyright 1999-2005 Diamond Edge, Inc. All Rights Reserved.