javax.swing
Interface CellEditor

All Known Subinterfaces:
TableCellEditor sample code for javax.swing.table.TableCellEditor definition code for javax.swing.table.TableCellEditor , TreeCellEditor sample code for javax.swing.tree.TreeCellEditor definition code for javax.swing.tree.TreeCellEditor
All Known Implementing Classes:
AbstractCellEditor sample code for javax.swing.AbstractCellEditor definition code for javax.swing.AbstractCellEditor , DefaultCellEditor sample code for javax.swing.DefaultCellEditor definition code for javax.swing.DefaultCellEditor , DefaultTreeCellEditor sample code for javax.swing.tree.DefaultTreeCellEditor definition code for javax.swing.tree.DefaultTreeCellEditor

public interface CellEditor

This interface defines the methods any general editor should be able to implement.

Having this interface enables complex components (the client of the editor) such as JList, JTree, and JTable to allow any generic editor to edit values in a table cell, or tree cell, etc. Without this generic editor interface, JTable would have to know about specific editors, such as JTextField, JCheckBox, JComboBox, etc. In addition, without this interface, clients of editors such as JTable would not be able to work with any editors developed in the future by the user or a 3rd party ISV.

To use this interface, a developer creating a new editor can have the new component implement the interface. Or the developer can choose a wrapper based approach and provide a companion object which implements the CellEditor interface (See JCellEditor for example). The wrapper approach is particularly useful if the user want to use a 3rd party ISV editor with JTable, but the ISV didn't implement the CellEditor interface. The user can simply create an object that contains an instance of the 3rd party editor object and "translate" the CellEditor API into the 3rd party editor's API.

See Also:
CellEditorListener sample code for javax.swing.event.CellEditorListener definition code for javax.swing.event.CellEditorListener

Method Summary
 void addCellEditorListener sample code for javax.swing.CellEditor.addCellEditorListener(javax.swing.event.CellEditorListener) definition code for javax.swing.CellEditor.addCellEditorListener(javax.swing.event.CellEditorListener) (CellEditorListener sample code for javax.swing.event.CellEditorListener definition code for javax.swing.event.CellEditorListener  l)
          Adds a listener to the list that's notified when the editor stops, or cancels editing.
 void cancelCellEditing sample code for javax.swing.CellEditor.cancelCellEditing() definition code for javax.swing.CellEditor.cancelCellEditing() ()
          Tells the editor to cancel editing and not accept any partially edited value.
 Object sample code for java.lang.Object definition code for java.lang.Object getCellEditorValue sample code for javax.swing.CellEditor.getCellEditorValue() definition code for javax.swing.CellEditor.getCellEditorValue() ()
          Returns the value contained in the editor.
 boolean isCellEditable sample code for javax.swing.CellEditor.isCellEditable(java.util.EventObject) definition code for javax.swing.CellEditor.isCellEditable(java.util.EventObject) (EventObject sample code for java.util.EventObject definition code for java.util.EventObject  anEvent)
          Asks the editor if it can start editing using anEvent.
 void removeCellEditorListener sample code for javax.swing.CellEditor.removeCellEditorListener(javax.swing.event.CellEditorListener) definition code for javax.swing.CellEditor.removeCellEditorListener(javax.swing.event.CellEditorListener) (CellEditorListener sample code for javax.swing.event.CellEditorListener definition code for javax.swing.event.CellEditorListener  l)
          Removes a listener from the list that's notified
 boolean shouldSelectCell sample code for javax.swing.CellEditor.shouldSelectCell(java.util.EventObject) definition code for javax.swing.CellEditor.shouldSelectCell(java.util.EventObject) (EventObject sample code for java.util.EventObject definition code for java.util.EventObject  anEvent)
          Returns true if the editing cell should be selected, false otherwise.
 boolean stopCellEditing sample code for javax.swing.CellEditor.stopCellEditing() definition code for javax.swing.CellEditor.stopCellEditing() ()
          Tells the editor to stop editing and accept any partially edited value as the value of the editor.
 

Method Detail

getCellEditorValue sample code for javax.swing.CellEditor.getCellEditorValue() definition code for javax.swing.CellEditor.getCellEditorValue()

Object sample code for java.lang.Object definition code for java.lang.Object  getCellEditorValue()
Returns the value contained in the editor.

Returns:
the value contained in the editor

isCellEditable sample code for javax.swing.CellEditor.isCellEditable(java.util.EventObject) definition code for javax.swing.CellEditor.isCellEditable(java.util.EventObject)

boolean isCellEditable(EventObject sample code for java.util.EventObject definition code for java.util.EventObject  anEvent)
Asks the editor if it can start editing using anEvent. anEvent is in the invoking component coordinate system. The editor can not assume the Component returned by getCellEditorComponent is installed. This method is intended for the use of client to avoid the cost of setting up and installing the editor component if editing is not possible. If editing can be started this method returns true.

Parameters:
anEvent - the event the editor should use to consider whether to begin editing or not
Returns:
true if editing can be started
See Also:
shouldSelectCell(java.util.EventObject) sample code for javax.swing.CellEditor.shouldSelectCell(java.util.EventObject) definition code for javax.swing.CellEditor.shouldSelectCell(java.util.EventObject)

shouldSelectCell sample code for javax.swing.CellEditor.shouldSelectCell(java.util.EventObject) definition code for javax.swing.CellEditor.shouldSelectCell(java.util.EventObject)

boolean shouldSelectCell(EventObject sample code for java.util.EventObject definition code for java.util.EventObject  anEvent)
Returns true if the editing cell should be selected, false otherwise. Typically, the return value is true, because is most cases the editing cell should be selected. However, it is useful to return false to keep the selection from changing for some types of edits. eg. A table that contains a column of check boxes, the user might want to be able to change those checkboxes without altering the selection. (See Netscape Communicator for just such an example) Of course, it is up to the client of the editor to use the return value, but it doesn't need to if it doesn't want to.

Parameters:
anEvent - the event the editor should use to start editing
Returns:
true if the editor would like the editing cell to be selected; otherwise returns false
See Also:
isCellEditable(java.util.EventObject) sample code for javax.swing.CellEditor.isCellEditable(java.util.EventObject) definition code for javax.swing.CellEditor.isCellEditable(java.util.EventObject)

stopCellEditing sample code for javax.swing.CellEditor.stopCellEditing() definition code for javax.swing.CellEditor.stopCellEditing()

boolean stopCellEditing()
Tells the editor to stop editing and accept any partially edited value as the value of the editor. The editor returns false if editing was not stopped; this is useful for editors that validate and can not accept invalid entries.

Returns:
true if editing was stopped; false otherwise

cancelCellEditing sample code for javax.swing.CellEditor.cancelCellEditing() definition code for javax.swing.CellEditor.cancelCellEditing()

void cancelCellEditing()
Tells the editor to cancel editing and not accept any partially edited value.


addCellEditorListener sample code for javax.swing.CellEditor.addCellEditorListener(javax.swing.event.CellEditorListener) definition code for javax.swing.CellEditor.addCellEditorListener(javax.swing.event.CellEditorListener)

void addCellEditorListener(CellEditorListener sample code for javax.swing.event.CellEditorListener definition code for javax.swing.event.CellEditorListener  l)
Adds a listener to the list that's notified when the editor stops, or cancels editing.

Parameters:
l - the CellEditorListener

removeCellEditorListener sample code for javax.swing.CellEditor.removeCellEditorListener(javax.swing.event.CellEditorListener) definition code for javax.swing.CellEditor.removeCellEditorListener(javax.swing.event.CellEditorListener)

void removeCellEditorListener(CellEditorListener sample code for javax.swing.event.CellEditorListener definition code for javax.swing.event.CellEditorListener  l)
Removes a listener from the list that's notified

Parameters:
l - the CellEditorListener