Interface java.awt.swing.CellEditor
- Subinterfaces:
- TableCellEditor, TreeCellEditor
- public interface CellEditor
getCellEditorValue
public Object getCellEditorValue()
- Returns the value contained in the editor
isCellEditable
public boolean isCellEditable(EventObject anEvent)
- Ask 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()
shouldSelectCell
public boolean shouldSelectCell(EventObject anEvent)
- Tell the editor to start editing using anEvent. It is
up to the editor if it want to start editing in different states
depending on the exact type of anEvent. For example, with
a text field editor, if the event is a mouse event the editor
might start editing with the cursor at the clicked point. If
the event is a keyboard event, it might want replace the value
of the text field with that first key, etc. anEvent
is in the invoking component's coordinate system. A null value
is a valid parameter for anEvent, and it is up to the editor
to determine what is the default starting state. For example,
a text field editor might want to select all the text and start
editing if anEvent is null. The editor can assume
the Component returned by getCellEditorComponent() is properly
installed in the clients Component hierarchy before this method is
called.
The return value of shouldSelectCell() is a boolean indicating whether
the editing cell should be selected or not. 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
- See Also:
- isCellEditable()
stopCellEditing
public boolean stopCellEditing()
- Tell 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, useful for editors which validates and
can not accept invalid entries.
- Returns:
- true if editing was stopped
cancelCellEditing
public void cancelCellEditing()
- Tell the editor to cancel editing and not accept any partially
edited value.
addCellEditorListener
public void addCellEditorListener(CellEditorListener l)
- Add a listener to the list that's notified when the editor starts,
stops, or cancels editing.
- Parameters:
l
- the CellEditorListener
removeCellEditorListener
public void removeCellEditorListener(CellEditorListener l)
- Remove a listener from the list that's notified
- Parameters:
l
- the CellEditorListener
Submit a bug or feature
Submit comments/suggestions about new javadoc look.
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.
Copyright 1993-1998 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A. All Rights Reserved.