com.ibm.dse.tools.workbench.gui
Class AbstractCellEditor

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.JPanel
                          |
                          +--com.ibm.dse.tools.workbench.gui.AbstractCellEditor
Direct Known Subclasses:
AllowedValuesValueCellEditor, AttributeCellEditor, FilenameEditor, PropertyCellEditor

public abstract class AbstractCellEditor
extends javax.swing.JPanel
implements javax.swing.CellEditor

This class provides a few functionalities common to all the cell editors.

See Also:
Serialized Form

Inner classes inherited from class javax.swing.JPanel
javax.swing.JPanel.AccessibleJPanel
 
Inner classes inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
 
Fields inherited from class javax.swing.JComponent
accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
 
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
 
Constructor Summary
AbstractCellEditor()
          This constructor creates an instance of this class with the default parameters.
 
Method Summary
 void addCellEditorListener(javax.swing.event.CellEditorListener l)
          This method add a CellEditorListener to the listener list.
 void cancelCellEditing()
          This method cancels the cell edition.
protected  void fireEditingCanceled()
          This method fires a change event of cancel to all the listeners registered to this editor.
protected  void fireEditingStopped()
          This method fires a change event of stop to all the listeners registered to this editor.
abstract  java.lang.Object getCellEditorValue()
          This method must return the value of the current editor.
 boolean isCellEditable(java.util.EventObject anEvent)
          This method returns true if the cell is editable based on an event.
 void removeCellEditorListener(javax.swing.event.CellEditorListener l)
          This method removes the given CellEditorListener from the listener list.
 void setMouseClicksToEdit(int clicks)
          This method sets the number of mouse clicks to start the editting.
 boolean shouldSelectCell(java.util.EventObject anEvent)
          This method returns true if the cell should be selected.
 boolean stopCellEditing()
          This method stops the cell edition.
 
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUIClassID, paramString, updateUI
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getAlignmentX, getAlignmentY, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getGraphics, getHeight, getInsets, getInsets, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getVisibleRect, getWidth, getX, getY, grabFocus, hasFocus, isDoubleBuffered, isFocusCycleRoot, isFocusTraversable, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, processComponentKeyEvent, processFocusEvent, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDoubleBuffered, setEnabled, setFont, setForeground, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setUI, setVisible, unregisterKeyboardAction, update
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getLayout, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setCursor, setLayout, validate, validateTree
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, getBackground, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getInputContext, getInputMethodRequests, getLocale, getLocation, getLocationOnScreen, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hide, imageUpdate, inside, isDisplayable, isEnabled, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, printAll, processComponentEvent, processInputMethodEvent, processMouseEvent, remove, removeComponentListener, removeFocusListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setDropTarget, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

AbstractCellEditor

public AbstractCellEditor()
This constructor creates an instance of this class with the default parameters.
Method Detail

addCellEditorListener

public void addCellEditorListener(javax.swing.event.CellEditorListener l)
This method add a CellEditorListener to the listener list.
Specified by:
addCellEditorListener in interface javax.swing.CellEditor
Parameters:
javax.swing.event.CellEditorListener - l

cancelCellEditing

public void cancelCellEditing()
This method cancels the cell edition.
Specified by:
cancelCellEditing in interface javax.swing.CellEditor

fireEditingCanceled

protected void fireEditingCanceled()
This method fires a change event of cancel to all the listeners registered to this editor.

fireEditingStopped

protected void fireEditingStopped()
This method fires a change event of stop to all the listeners registered to this editor.

getCellEditorValue

public abstract java.lang.Object getCellEditorValue()
This method must return the value of the current editor.
Specified by:
getCellEditorValue in interface javax.swing.CellEditor
Returns:
java.lang.Object

isCellEditable

public boolean isCellEditable(java.util.EventObject anEvent)
This method returns true if the cell is editable based on an event.
Specified by:
isCellEditable in interface javax.swing.CellEditor
Parameters:
anEvent - java.util.EventObject
Returns:
boolean

removeCellEditorListener

public void removeCellEditorListener(javax.swing.event.CellEditorListener l)
This method removes the given CellEditorListener from the listener list.
Specified by:
removeCellEditorListener in interface javax.swing.CellEditor
Parameters:
l - javax.swing.event.CellEditorListener

setMouseClicksToEdit

public void setMouseClicksToEdit(int clicks)
This method sets the number of mouse clicks to start the editting.
Parameters:
clicks - int

shouldSelectCell

public boolean shouldSelectCell(java.util.EventObject anEvent)
This method returns true if the cell should be selected.
Specified by:
shouldSelectCell in interface javax.swing.CellEditor
Parameters:
anEvent - java.util.EventObject
Returns:
boolean

stopCellEditing

public boolean stopCellEditing()
This method stops the cell edition.
Specified by:
stopCellEditing in interface javax.swing.CellEditor
Returns:
boolean