public class

DefaultCellEditor

extends AbstractCellEditor
implements TableCellEditor TreeCellEditor
java.lang.Object
   ↳ javax.swing.AbstractCellEditor
     ↳ javax.swing.DefaultCellEditor
Known Direct Subclasses

Class Overview

The default editor for table and tree cells.

Warning: Serialized objects of this class will not be compatible with future Swing releases. The current serialization support is appropriate for short term storage or RMI between applications running the same version of Swing. As of 1.4, support for long term storage of all JavaBeansTM has been added to the java.beans package. Please see XMLEncoder.

Summary

Nested Classes
class DefaultCellEditor.EditorDelegate The protected EditorDelegate class. 
Fields
protected int clickCountToStart An integer specifying the number of clicks needed to start editing.
protected DefaultCellEditor.EditorDelegate delegate The delegate class which handles all methods sent from the CellEditor.
protected JComponent editorComponent The Swing component being edited.
[Expand]
Inherited Fields
From class javax.swing.AbstractCellEditor
Public Constructors
DefaultCellEditor(JTextField textField)
Constructs a DefaultCellEditor that uses a text field.
DefaultCellEditor(JCheckBox checkBox)
Constructs a DefaultCellEditor object that uses a check box.
DefaultCellEditor(JComboBox comboBox)
Constructs a DefaultCellEditor object that uses a combo box.
Public Methods
void cancelCellEditing()
Forwards the message from the CellEditor to the delegate.
Object getCellEditorValue()
Forwards the message from the CellEditor to the delegate.
int getClickCountToStart()
Returns the number of clicks needed to start editing.
Component getComponent()
Returns a reference to the editor component.
Component getTableCellEditorComponent(JTable table, Object value, boolean isSelected, int row, int column)
Implements the TableCellEditor interface.
Component getTreeCellEditorComponent(JTree tree, Object value, boolean isSelected, boolean expanded, boolean leaf, int row)
Implements the TreeCellEditor interface.
boolean isCellEditable(EventObject anEvent)
Forwards the message from the CellEditor to the delegate.
void setClickCountToStart(int count)
Specifies the number of clicks needed to start editing.
boolean shouldSelectCell(EventObject anEvent)
Forwards the message from the CellEditor to the delegate.
boolean stopCellEditing()
Forwards the message from the CellEditor to the delegate.
[Expand]
Inherited Methods
From class javax.swing.AbstractCellEditor
From class java.lang.Object
From interface javax.swing.CellEditor
From interface javax.swing.table.TableCellEditor
From interface javax.swing.tree.TreeCellEditor

Fields

protected int clickCountToStart

An integer specifying the number of clicks needed to start editing. Even if clickCountToStart is defined as zero, it will not initiate until a click occurs.

protected DefaultCellEditor.EditorDelegate delegate

The delegate class which handles all methods sent from the CellEditor.

protected JComponent editorComponent

The Swing component being edited.

Public Constructors

public DefaultCellEditor (JTextField textField)

Constructs a DefaultCellEditor that uses a text field.

Parameters
textField a JTextField object

public DefaultCellEditor (JCheckBox checkBox)

Constructs a DefaultCellEditor object that uses a check box.

Parameters
checkBox a JCheckBox object

public DefaultCellEditor (JComboBox comboBox)

Constructs a DefaultCellEditor object that uses a combo box.

Parameters
comboBox a JComboBox object

Public Methods

public void cancelCellEditing ()

Forwards the message from the CellEditor to the delegate.

public Object getCellEditorValue ()

Forwards the message from the CellEditor to the delegate.

Returns
  • the value contained in the editor

public int getClickCountToStart ()

Returns the number of clicks needed to start editing.

Returns
  • the number of clicks needed to start editing

public Component getComponent ()

Returns a reference to the editor component.

Returns
  • the editor Component

public Component getTableCellEditorComponent (JTable table, Object value, boolean isSelected, int row, int column)

Implements the TableCellEditor interface.

Parameters
table the JTable that is asking the editor to edit; can be null
value the value of the cell to be edited; it is up to the specific editor to interpret and draw the value. For example, if value is the string "true", it could be rendered as a string or it could be rendered as a check box that is checked. null is a valid value
isSelected true if the cell is to be rendered with highlighting
row the row of the cell being edited
column the column of the cell being edited
Returns
  • the component for editing

public Component getTreeCellEditorComponent (JTree tree, Object value, boolean isSelected, boolean expanded, boolean leaf, int row)

Implements the TreeCellEditor interface.

Parameters
tree the JTree that is asking the editor to edit; this parameter can be null
value the value of the cell to be edited
isSelected true if the cell is to be rendered with selection highlighting
expanded true if the node is expanded
leaf true if the node is a leaf node
row the row index of the node being edited
Returns
  • the component for editing

public boolean isCellEditable (EventObject anEvent)

Forwards the message from the CellEditor to the delegate.

Parameters
anEvent an event object
Returns
  • true

public void setClickCountToStart (int count)

Specifies the number of clicks needed to start editing.

Parameters
count an int specifying the number of clicks needed to start editing

public boolean shouldSelectCell (EventObject anEvent)

Forwards the message from the CellEditor to the delegate.

Parameters
anEvent an event object
Returns
  • true

public boolean stopCellEditing ()

Forwards the message from the CellEditor to the delegate.

Returns
  • true