TableCellEditor
, TreeCellEditor
AbstractCellEditor
, DefaultCellEditor
, DefaultTreeCellEditor
public interface CellEditor
Having this interface enables complex components (the client of the editor) such as 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 DefaultCellEditor
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.
Modifier and Type | Method | Description |
---|---|---|
void |
addCellEditorListener |
Adds a listener to the list that's notified when the editor stops, or cancels editing. |
void |
cancelCellEditing() |
Tells the editor to cancel editing and not accept any partially edited value. |
Object |
getCellEditorValue() |
Returns the value contained in the editor. |
boolean |
isCellEditable |
Asks the editor if it can start editing using anEvent . |
void |
removeCellEditorListener |
Removes a listener from the list that's notified |
boolean |
shouldSelectCell |
Returns true if the editing cell should be selected, false otherwise. |
boolean |
stopCellEditing() |
Tells the editor to stop editing and accept any partially edited value as the value of the editor. |
Object getCellEditorValue()
boolean isCellEditable(EventObject anEvent)
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.anEvent
- the event the editor should use to consider whether to begin editing or notboolean shouldSelectCell(EventObject anEvent)
anEvent
- the event the editor should use to start editingboolean stopCellEditing()
void cancelCellEditing()
void addCellEditorListener(CellEditorListener l)
l
- the CellEditorListenervoid removeCellEditorListener(CellEditorListener l)
l
- the CellEditorListener
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.desktop/javax/swing/CellEditor.html