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.
javax.swing.event.CellEditorListener
| Modifier and Type | Method and Description |
|---|---|
| public void | addCellEditorListener(CellEditorListener
the CellEditorListener l)Adds a listener to the list that's notified when the editor stops, or cancels editing. |
| public void | |
| public Object | Returns: the value contained in the editorReturns the value contained in the editor. |
| public boolean | Returns: true if editing can be startedthe event the editor should use to consider
whether to begin editing or not anEvent)Asks the editor if it can start editing using |
| public void | removeCellEditorListener(CellEditorListener
the CellEditorListener l)Removes a listener from the list that's notified |
| public boolean | Returns: true if the editor would like the editing cell to be selected; otherwise returns falsethe event the editor should use to start
editing anEvent)Returns true if the editing cell should be selected, false otherwise. |
| public boolean | Returns: true if editing was stopped; false otherwiseTells the editor to stop editing and accept any partially edited value as the value of the editor. |
| addCellEditorListener | back to summary |
|---|---|
| public void addCellEditorListener(CellEditorListener l) Adds a listener to the list that's notified when the editor stops, or cancels editing.
| |
| cancelCellEditing | back to summary |
|---|---|
| public void cancelCellEditing() Tells the editor to cancel editing and not accept any partially edited value. | |
| getCellEditorValue | back to summary |
|---|---|
| public Object getCellEditorValue() Returns the value contained in the editor.
| |
| isCellEditable | back to summary |
|---|---|
| public boolean isCellEditable(EventObject anEvent) Asks the editor if it can start editing using
| |
| removeCellEditorListener | back to summary |
|---|---|
| public void removeCellEditorListener(CellEditorListener l) Removes a listener from the list that's notified
| |
| shouldSelectCell | back to summary |
|---|---|
| public boolean shouldSelectCell(EventObject anEvent) Returns true if the editing cell should be selected, false otherwise. Typically, the return value is true, because in 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, e.g. in a table that contains a column of check boxes, the user might want to be able to change those checkboxes without altering the selection. 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.
| |
| stopCellEditing | back to summary |
|---|---|
| public 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.
| |