org.itsnat.comp.list
Interface ItsNatListCellEditor

All Superinterfaces:

javax.swing.CellEditor

public interface ItsNatListCellEditor
extends javax.swing.CellEditor

Used to specify how a list item value is edited in place.

Author:

Jose Maria Arranz Santamaria

See Also:

ItsNatComponentManager.createDefaultItsNatListCellEditor(ItsNatComponent), ItsNatList.getItsNatListCellEditor()

Method Summary

ItsNatComponent

getListCellEditorComponent(ItsNatList list, int index, java.lang.Object value, boolean isSelected, org.w3c.dom.Element cellContentElem) Returns the component used to edit in place the list item value.

Methods inherited from interface javax.swing.CellEditor

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

Method Detail

getListCellEditorComponent

ItsNatComponent getListCellEditorComponent(ItsNatList list,
                                           int index,
                                           java.lang.Object value,
                                           boolean isSelected,
                                           org.w3c.dom.Element cellContentElem)

Returns the component used to edit in place the list item value.

Default implementation uses a ItsNatHTMLInputText (text not formatted version) to edit the list item value.

Default implementation ignores isSelected parameter.

Parameters:

list - the list component, may be used to provide contextual information. Default implementation ignores it.

index - the list item index.

value - the value to edit (initial value).

isSelected - true if the cell is selected.

cellContentElem - the list item content element to render the value into. Is a hint, if provided should be obtained by calling list.getItsNatListUI().getContentElementAt(index).

Returns:

the component used to edit in place the list item value. Current implementation of lists does nothing with this component and may be null (is not mandatory to use a single component as an editor).

See Also:

ItsNatList.setItsNatListCellEditor(ItsNatListCellEditor)