rle.simple.ui
Interface ItemTableModel

All Superinterfaces:

javax.swing.table.TableModel

All Known Implementing Classes:

EquipmentTableModel, InventoryTableModel

public interface ItemTableModel
extends javax.swing.table.TableModel

Provides a mapping from an ItemContainer to a table which can be displayed on screen allowing items to be chosen by the user.

Method Summary

char	getCharacterForRow(int row) Returns the character which must be keyed to reference the item(s) at the given row in the table.
ItemContainer	getItemContainer() The item container.
Item	getItemForRow(int row) Return the first item represented by a row in the table.
java.util.List<Item>	getItemsForRow(int row) Return the items represented by a row in the table.

Methods inherited from interface javax.swing.table.TableModel

addTableModelListener, getColumnClass, getColumnCount, getColumnName, getRowCount, getValueAt, isCellEditable, removeTableModelListener, setValueAt

Method Detail

getItemContainer

ItemContainer getItemContainer()

The item container.

getCharacterForRow

char getCharacterForRow(int row)

Returns the character which must be keyed to reference the item(s) at the given row in the table. The character returned is case-sensitive. In general, even if some items are hidden using an ItemFilter, the character returned should be as if there were no filter. For example, if slot 'a' contained a spell book and slot 'b' a food ration, the food ration would appear as row 0 for an 'eat' command, and row 1 for a 'drop' command. In each case, however, the character returned for the row containing the food ration should be 'b'.

Parameters:

- - the row in the table presented to the user

getItemForRow

Item getItemForRow(int row)

Return the first item represented by a row in the table. This is a convenience method, and should return the same Item as for getItemsForRow(row).get(0). If the row does not contain any items, this method should return null.

getItemsForRow

java.util.List<Item> getItemsForRow(int row)

Return the items represented by a row in the table. If the row does not contain any items, this method should return an empty list.