Package org.pentaho.reporting.ui.datasources.table

Class TypedHeaderCellEditor

java.lang.Object

org.pentaho.reporting.ui.datasources.table.TypedHeaderCellEditor

All Implemented Interfaces:

CellEditor, TableCellEditor

public class TypedHeaderCellEditor
extends Object
implements TableCellEditor

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	TypedHeaderCellEditor.ShowPopupAction

Constructor Summary

Constructors

Constructor	Description
TypedHeaderCellEditor()

Method Summary

Modifier and Type	Method	Description
void	addCellEditorListener(CellEditorListener l)	Adds a listener to the list that's notified when the editor stops, or cancels editing.
void	cancelCellEditing()	Tells the editor to cancel editing and not accept any partially edited value.
protected void	fireEditingCanceled()
protected void	fireEditingStopped()
Object	getCellEditorValue()	Returns the value contained in the editor.
Component	getTableCellEditorComponent(JTable table, Object value, boolean isSelected, int row, int column)	Sets an initial value for the editor.
boolean	isCellEditable(EventObject anEvent)	Asks the editor if it can start editing using anEvent.
void	removeCellEditorListener(CellEditorListener l)	Removes a listener from the list that's notified
boolean	shouldSelectCell(EventObject anEvent)	Returns true if the editing cell should be selected, false otherwise.
boolean	stopCellEditing()	Tells the editor to stop editing and accept any partially edited value as the value of the editor.

Methods inherited from class java.lang.Object

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

Constructor Detail

TypedHeaderCellEditor

public TypedHeaderCellEditor()

Method Detail

getTableCellEditorComponent

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

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:

getTableCellEditorComponent in interface TableCellEditor

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

getCellEditorValue

public Object getCellEditorValue()

Returns the value contained in the editor.

Specified by:

getCellEditorValue in interface CellEditor

Returns:

the value contained in the editor

isCellEditable

public boolean isCellEditable(EventObject anEvent)

Asks 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.

Specified by:

isCellEditable in interface CellEditor

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(java.util.EventObject)

shouldSelectCell

public boolean shouldSelectCell(EventObject anEvent)

Returns true if the editing cell should be selected, false otherwise. 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.

Specified by:

shouldSelectCell in interface CellEditor

Parameters:

anEvent - the event the editor should use to start editing

Returns:

true if the editor would like the editing cell to be selected; otherwise returns false

See Also:

isCellEditable(java.util.EventObject)

stopCellEditing

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.

Specified by:

stopCellEditing in interface CellEditor

Returns:

true if editing was stopped; false otherwise

cancelCellEditing

public void cancelCellEditing()

Tells the editor to cancel editing and not accept any partially edited value.

Specified by:

cancelCellEditing in interface CellEditor

fireEditingCanceled

protected void fireEditingCanceled()

fireEditingStopped

protected void fireEditingStopped()

addCellEditorListener

public void addCellEditorListener(CellEditorListener l)

Adds a listener to the list that's notified when the editor stops, or cancels editing.

Specified by:

addCellEditorListener in interface CellEditor

Parameters:

l - the CellEditorListener

removeCellEditorListener

public void removeCellEditorListener(CellEditorListener l)

Removes a listener from the list that's notified

Specified by:

removeCellEditorListener in interface CellEditor

Parameters:

l - the CellEditorListener