net.sf.jeppers.grid
Interface GridCellEditor

All Superinterfaces:

CellEditor

All Known Implementing Classes:

GenericCellEditor

public interface GridCellEditor

extends CellEditor

This interface defines the method that editors must implement to be used as an editor by JGrid.

Author:

Cameron Zemek

Method Summary

Component

getEditorComponent(int row, int column, Object value, CellStyle style, boolean isSelected, JGrid grid) Sets an initial value for the editor.

Methods inherited from interface javax.swing.CellEditor

addCellEditorListener, cancelCellEditing, getCellEditorValue, isCellEditable, removeCellEditorListener, shouldSelectCell, stopCellEditing

Method Detail

getEditorComponent

public Component getEditorComponent(int row,
                                    int column,
                                    Object value,
                                    CellStyle style,
                                    boolean isSelected,
                                    JGrid grid)

Sets an initial value for the editor. This will cause the editor to stopEditing and lose any partially edited value if the editor is editing when this method is called.

Returns the component that should be added to the client's Component hierarchy. Once installed in the client's hierarchy this component will then be able to draw and receive user input.

Parameters:

row - the row of the cell being edited

column - the column of the cell being edited

value - the value of the cell to be edited; it is up to the specific editor to interpret and draw the value. For example, if value is the string "true", it could be rendered as a string or it could be rendered as a check box that is checked. null is a valid value

style - the style to be use for rendering the cell

isSelected - true if the cell is to be rendered with highlighting

grid - the JGrid that is asking the editor to edit; can be null

Returns:

the component for editing