net.sf.jeppers.grid
Class GenericCellEditor

java.lang.Object
  |
  +--javax.swing.AbstractCellEditor
        |
        +--net.sf.jeppers.grid.GenericCellEditor

All Implemented Interfaces:

CellEditor, GridCellEditor, Serializable

public class GenericCellEditor

extends AbstractCellEditor

implements GridCellEditor

Generic implementation of GridCellEditor that uses the toString method.

Author:

Cameron Zemek

See Also:

Serialized Form

Nested Class Summary

protected class

GenericCellEditor.EditorDelegate The protected EditorDelegate class.

Field Summary

protected int	clickCountToStart An integer specifying the number of clicks needed to start editing.
protected GenericCellEditor.EditorDelegate	delegate The delegate class which handles all methods sent from the CellEditor.
protected JComponent	editorComponent The Swing component being edited.

Fields inherited from class javax.swing.AbstractCellEditor

changeEvent, listenerList

Constructor Summary

GenericCellEditor(JCheckBox checkBox)
Constructs a GenericCellEditor object that uses a check box.

GenericCellEditor(JComboBox comboBox)
Constructs a GenericCellEditor object that uses a combo box.

GenericCellEditor(JTextField textField)
Constructs a GenericCellEditor that uses a text field.

Method Summary

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	getEditorComponent(int row, int column, Object value, CellStyle style, boolean isSelected, JGrid grid) Sets an initial value for the editor.
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.

Methods inherited from class javax.swing.AbstractCellEditor

addCellEditorListener, fireEditingCanceled, fireEditingStopped, getCellEditorListeners, removeCellEditorListener

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.swing.CellEditor

addCellEditorListener, removeCellEditorListener

Field Detail

editorComponent

protected JComponent editorComponent

The Swing component being edited.

delegate

protected GenericCellEditor.EditorDelegate delegate

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

clickCountToStart

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.

Constructor Detail

GenericCellEditor

public GenericCellEditor(JTextField textField)

Constructs a GenericCellEditor that uses a text field.

GenericCellEditor

public GenericCellEditor(JCheckBox checkBox)

Constructs a GenericCellEditor object that uses a check box.

GenericCellEditor

public GenericCellEditor(JComboBox comboBox)

Constructs a GenericCellEditor object that uses a combo box.

Method Detail

getEditorComponent

public Component getEditorComponent(int row,
                                    int column,
                                    Object value,
                                    CellStyle style,
                                    boolean isSelected,
                                    JGrid grid)

Description copied from interface: GridCellEditor

Sets an initial value for the editor. This will cause the editor to stopEditing and lose any partially edited value if the editor is editing when this method is called.

Returns the component that should be added to the client's Component hierarchy. Once installed in the client's hierarchy this component will then be able to draw and receive user input.

Specified by:

getEditorComponent in interface GridCellEditor

Parameters:

row - the row of the cell being edited

column - the column of the cell being edited

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

style - the style to be use for rendering the cell

isSelected - true if the cell is to be rendered with highlighting

grid - the JGrid that is asking the editor to edit; can be null

Returns:

the component for editing

See Also:

GridCellEditor.getEditorComponent(int, int, Object, CellStyle, boolean, JGrid)

getComponent

public Component getComponent()

Returns a reference to the editor component.

Returns:

the editor Component

setClickCountToStart

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

See Also:

getClickCountToStart()

getClickCountToStart

public int getClickCountToStart()

Returns the number of clicks needed to start editing.

Returns:

the number of clicks needed to start editing

getCellEditorValue

public Object getCellEditorValue()

Forwards the message from the CellEditor to the delegate.

Specified by:

getCellEditorValue in interface CellEditor

See Also:

GenericCellEditor.EditorDelegate.getCellEditorValue()

isCellEditable

public boolean isCellEditable(EventObject anEvent)

Forwards the message from the CellEditor to the delegate.

Specified by:

isCellEditable in interface CellEditor

Overrides:

isCellEditable in class AbstractCellEditor

See Also:

GenericCellEditor.EditorDelegate.isCellEditable(EventObject)

shouldSelectCell

public boolean shouldSelectCell(EventObject anEvent)

Forwards the message from the CellEditor to the delegate.

Specified by:

shouldSelectCell in interface CellEditor

Overrides:

shouldSelectCell in class AbstractCellEditor

See Also:

GenericCellEditor.EditorDelegate.shouldSelectCell(EventObject)

stopCellEditing

public boolean stopCellEditing()

Forwards the message from the CellEditor to the delegate.

Specified by:

stopCellEditing in interface CellEditor

Overrides:

stopCellEditing in class AbstractCellEditor

See Also:

GenericCellEditor.EditorDelegate.stopCellEditing()

cancelCellEditing

public void cancelCellEditing()

Forwards the message from the CellEditor to the delegate.

Specified by:

cancelCellEditing in interface CellEditor

Overrides:

cancelCellEditing in class AbstractCellEditor

See Also:

GenericCellEditor.EditorDelegate.cancelCellEditing()