TableModel.java

/*
 * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores
 * CA 94065 USA or visit www.oracle.com if you need additional information or
 * have any questions.
 */
package com.sun.lwuit.table;

import com.sun.lwuit.events.DataChangedListener;

/**
 * The table and table model class are complimentry classes allowing the quick construction
 * of tabular data controls. The table model represents the data source according to which
 * the table is constructed.
 *
 * @author Shai Almog
 */
public interface TableModel {
    /**
     * Returns the number of rows in the table
     *
     * @return the number of rows in the table
     */
    public int getRowCount();

    /**
     * Returns the number of columns in the table
     *
     * @return the number of columns in the table
     */
    public int getColumnCount();

    /**
     * Returns the name of the column at the given offset
     *
     * @param i the offset for the column name
     * @return name to display at the top of the table
     */
    public String getColumnName(int i);

    /**
     * Returns true if the cell at the given location is an editable cell
     *
     * @param row the cell row
     * @param column the cell column
     * @return true if the cell at the given location is an editable cell
     */
    public boolean isCellEditable(int row, int column);

    /**
     * Returns the value of the cell at the given location
     *
     * @param row the cell row
     * @param column the cell column
     * @return the value of the cell at the given location
     */
    public Object getValueAt(int row, int column);

    /**
     * Sets the value of the cell at the given location
     *
     * @param row the cell row
     * @param column the cell column
     * @param o the value of the cell at the given location 
     */
    public void setValueAt(int row, int column, Object o);

    /**
     * Adds a listener to the data changed event
     *
     * @param d the new listener
     */
    public void addDataChangeListener(DataChangedListener d);

    /**
     * Removes a listener to the data changed event
     *
     * @param d the listener to remove
     */
    public void removeDataChangeListener(DataChangedListener d);
    
}