dsto.dfc.swing.controls
Class AbstractPopupEditor

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by javax.swing.JComponent
              extended by javax.swing.JPanel
                  extended by dsto.dfc.swing.controls.AbstractCellEditor
                      extended by dsto.dfc.swing.controls.AbstractPopupEditor
All Implemented Interfaces:
ImageObserver, MenuContainer, Serializable, Accessible, CellEditor, TableCellEditor, TreeCellEditor
Direct Known Subclasses:
FontPopupSelector

public abstract class AbstractPopupEditor
extends AbstractCellEditor

Abstract base class for editors that use the [editor][...] pattern to a display a value and provide a popup dialog to edit the value. Subclasses implement showPopup () and getCellEditorValue ().

Version:
$Revision$
See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class javax.swing.JPanel
JPanel.AccessibleJPanel
 
Nested classes/interfaces inherited from class javax.swing.JComponent
JComponent.AccessibleJComponent
 
Nested classes/interfaces inherited from class java.awt.Container
Container.AccessibleAWTContainer
 
Nested classes/interfaces inherited from class java.awt.Component
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy
 
Field Summary
static int EXPAND_BOTH
           
static int EXPAND_HORIZONTAL
           
static int EXPAND_NONE
           
static int EXPAND_VERTICAL
           
 
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
 
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Constructor Summary
AbstractPopupEditor()
           
AbstractPopupEditor(CellRenderer renderer)
          Create a new editor.
 
Method Summary
abstract  Object getCellEditorValue()
          Superclasses should implement this to return the value of the cell editor.
 JComponent getEditorComponent(JComponent client, Object value, int row, int column, boolean isSelected, boolean expanded, boolean leaf)
          Returns this, after configuring the renderer component.
 int getExpandRenderer()
           
 CellRenderer getRenderer()
           
protected  void popupButton_actionPerformed(ActionEvent e)
           
 void setExpandRenderer(int mode)
           
 void setFont(Font font)
           
 void setRenderer(CellRenderer renderer)
           
 void setRendererBorder(Border border)
          Set the border around the renderer component.
protected  void setValue(Object value)
          Set the value displayed by the renderer.
abstract  boolean showPopup()
          Superclasses should implement this to display the popup dialog for the editor.
protected  void updateRendererConstraints()
          Update the GridBagConstraint used for the renderer component to reflect the current expandRenderer setting.
 
Methods inherited from class dsto.dfc.swing.controls.AbstractCellEditor
addCellEditorListener, cancelCellEditing, fireEditingCanceled, fireEditingStopped, getTableCellEditorComponent, getTreeCellEditorComponent, isCellEditable, removeCellEditorListener, shouldSelectCell, stopCellEditing
 
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusBackward, transferFocusDownCycle, validate, validateTree
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

EXPAND_NONE

public static final int EXPAND_NONE
See Also:
Constant Field Values

EXPAND_HORIZONTAL

public static final int EXPAND_HORIZONTAL
See Also:
Constant Field Values

EXPAND_VERTICAL

public static final int EXPAND_VERTICAL
See Also:
Constant Field Values

EXPAND_BOTH

public static final int EXPAND_BOTH
See Also:
Constant Field Values
Constructor Detail

AbstractPopupEditor

public AbstractPopupEditor()

AbstractPopupEditor

public AbstractPopupEditor(CellRenderer renderer)
Create a new editor.

Parameters:
renderer - The renderer to be displayed to the left of the [...] button.
Method Detail

showPopup

public abstract boolean showPopup()
Superclasses should implement this to display the popup dialog for the editor.

Returns:
True if the popup was OK'd, false if the popup was cancelled.

getCellEditorValue

public abstract Object getCellEditorValue()
Superclasses should implement this to return the value of the cell editor.

Specified by:
getCellEditorValue in interface CellEditor
Specified by:
getCellEditorValue in class AbstractCellEditor

getRenderer

public CellRenderer getRenderer()

setExpandRenderer

public void setExpandRenderer(int mode)

getExpandRenderer

public int getExpandRenderer()

setRendererBorder

public void setRendererBorder(Border border)
Set the border around the renderer component. The border is not used when this component is used inside a JTable.


setRenderer

public void setRenderer(CellRenderer renderer)

getEditorComponent

public JComponent getEditorComponent(JComponent client,
                                     Object value,
                                     int row,
                                     int column,
                                     boolean isSelected,
                                     boolean expanded,
                                     boolean leaf)
Returns this, after configuring the renderer component.

Specified by:
getEditorComponent in class AbstractCellEditor

setFont

public void setFont(Font font)
Overrides:
setFont in class JComponent

updateRendererConstraints

protected void updateRendererConstraints()
Update the GridBagConstraint used for the renderer component to reflect the current expandRenderer setting.


setValue

protected void setValue(Object value)
Set the value displayed by the renderer.


popupButton_actionPerformed

protected void popupButton_actionPerformed(ActionEvent e)


Copyright © 2008 Commonwealth of Australia