|
JavaTM 2 Platform Std. Ed. v1.3.1 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 approch and provide a companion object which implements the CellEditor interface (See JCellEditor for example). The wrapper approch 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.
CellEditorListener
Method Summary | |
void |
addCellEditorListener(CellEditorListener l)
Add a listener to the list that's notified when the editor starts, stops, or cancels editing. |
void |
cancelCellEditing()
Tell the editor to cancel editing and not accept any partially edited value. |
Object |
getCellEditorValue()
Returns the value contained in the editor |
boolean |
isCellEditable(EventObject anEvent)
Ask the editor if it can start editing using anEvent. |
void |
removeCellEditorListener(CellEditorListener l)
Remove a listener from the list that's notified |
boolean |
shouldSelectCell(EventObject anEvent)
The return value of shouldSelectCell() is a boolean indicating whether the editing cell should be selected or not. |
boolean |
stopCellEditing()
Tell the editor to stop editing and accept any partially edited value as the value of the editor. |
Method Detail |
public Object getCellEditorValue()
public boolean isCellEditable(EventObject anEvent)
anEvent
- the event the editor should use to consider
whether to begin editing or not.shouldSelectCell(java.util.EventObject)
public boolean shouldSelectCell(EventObject anEvent)
anEvent
- the event the editor should use to start
editing.isCellEditable(java.util.EventObject)
public boolean stopCellEditing()
public void cancelCellEditing()
public void addCellEditorListener(CellEditorListener l)
l
- the CellEditorListenerpublic void removeCellEditorListener(CellEditorListener l)
l
- the CellEditorListener
|
JavaTM 2 Platform Std. Ed. v1.3.1 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Java, Java 2D, and JDBC are trademarks or registered trademarks of Sun Microsystems, Inc. in the US and other countries.
Copyright 1993-2001 Sun Microsystems, Inc. 901 San Antonio Road
Palo Alto, California, 94303, U.S.A. All Rights Reserved.