ca.odell.glazedlists.gui.AdvancedTableFormat Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of glazedlists_java15 Show documentation

Event-driven lists for dynamically filtered and sorted tables

There is a newer version: 1.9.1

/* Glazed Lists                                                 (c) 2003-2006 */
/* http://publicobject.com/glazedlists/                      publicobject.com,*/
/*                                                     O'Dell Engineering Ltd.*/
package ca.odell.glazedlists.gui;

import java.util.Comparator;

/**
 * Allows the ability to specify column class information in addition to the standard
 * {@link TableFormat} information.
 *
 * This class can be used as an alternative to the simple {@link TableFormat}
 * class to provide column class information that is used to determine what cell renderer
 * and/or editor should be used for a column. If no custom renderers or editors are
 * required, it is sufficient to implement {@link TableFormat} only.
 *
 * @author Rob Eden
 * @author Jesse Wilson
 *
 * @see WritableTableFormat
 * @see TableFormat
 */
public interface AdvancedTableFormat extends TableFormat {

    /**
     * Returns the most specific superclass for all the cell values in the column. This
     * is used by the table to set up a default renderer and editor for the column.
     *
     * @param column The index of the column being edited.
     */
    public Class getColumnClass(int column);

    /**
     * Returns the default {@link Comparator} to use for the specified column.
     * This {@link Comparator} may be used to determine how a table will be sorted.
     *
     * @see ca.odell.glazedlists.GlazedLists
     *
     * @return the {@link Comparator} to use or null for an unsortable
     *      column.
     */
    public Comparator getColumnComparator(int column);
}