ucar.ui.widget

Class SuperComboBox

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

ucar.ui.widget.SuperComboBox

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible

public class SuperComboBox
extends javax.swing.JPanel

SuperComboBox is a complete rewrite of JComboBox; it does not extend JComboBox (!) Items added may implement NamedObject, in which case getName() is used as the row name, and getDescription() is used as the tooltip. Otherwise, o.toString() is used as the row name, and there is no tooltip. The row names must be unique. An ActionValueEvent is thrown when the selection is changed through manipulation of the widget. The selection can be obtained from actionEvent.getValue(), which returns the the selection row name. The caller can change the selection by calling setSelectionByName(). In this case, no event is thrown.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JPanel

javax.swing.JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields inherited from class javax.swing.JComponent

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

accessibleContext, 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

Constructors

Constructor and Description
SuperComboBox(javax.swing.RootPaneContainer parent, java.lang.String name, boolean sortOK, java.util.Iterator iter) default is one column, with an iterator of NamedObjects

Method Summary

Modifier and Type	Method and Description
void	addActionValueListener(ActionValueListener l) add ActionValueListener listener
ActionSourceListener	getActionSourceListener() better way to do event management
IndependentWindow	getLoopControl() get the LoopControl Window associated with this list
java.lang.String	getName() get the name associated with this list
int	getSelectedIndex() Get the index of the currently selected object in the list.
java.lang.Object	getSelectedObject() Get the currently selected object.
void	removeActionValueListener(ActionValueListener l) remove ActionValueListener listener
void	setCollection(java.util.Iterator iter) Set the list of things to be selected.
void	setCollection(java.util.Iterator iter, boolean keepIndex)
void	setLabel(java.lang.String s) Set the displayed text.
void	setSelectedByIndex(int index) Set the currently selected object using its index.
int	setSelectedByName(java.lang.String choiceName) Set the currently selected object using its choice name.
int	setSelectedByValue(java.lang.Object choice)

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, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, 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, setFont, 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, 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, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, 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, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Constructor Detail

SuperComboBox

public SuperComboBox(javax.swing.RootPaneContainer parent,
                     java.lang.String name,
                     boolean sortOK,
                     java.util.Iterator iter)

default is one column, with an iterator of NamedObjects

Parameters:

parent - parent container

name - column name

sortOK - true allow sorting, column adding and removing

iter - Iterator of objects inside the combobox.

Method Detail

addActionValueListener

public void addActionValueListener(ActionValueListener l)

add ActionValueListener listener

removeActionValueListener

public void removeActionValueListener(ActionValueListener l)

remove ActionValueListener listener

getActionSourceListener

public ActionSourceListener getActionSourceListener()

better way to do event management

getLoopControl

public IndependentWindow getLoopControl()

get the LoopControl Window associated with this list

getName

public java.lang.String getName()

get the name associated with this list

Overrides:

getName in class java.awt.Component

setCollection

public void setCollection(java.util.Iterator iter)

Set the list of things to be selected. Iterator may return objects of type NamedObjects, otherwise will use object.toString()

setCollection

public void setCollection(java.util.Iterator iter,
                          boolean keepIndex)

setLabel

public void setLabel(java.lang.String s)

Set the displayed text. Typically its only used when the list is empty.

getSelectedObject

@Nullable
public java.lang.Object getSelectedObject()

Get the currently selected object. May be null.

getSelectedIndex

public int getSelectedIndex()

Get the index of the currently selected object in the list. If sortOK, then this may not be the original index.

Returns:

index of selected object, or -1 if none selected.

setSelectedByName

public int setSelectedByName(java.lang.String choiceName)

Set the currently selected object using its choice name. Note that no event is sent due to this call.

Parameters:

choiceName - name of object to match.

Returns:

index of selection, or -1 if not found;

setSelectedByValue

public int setSelectedByValue(java.lang.Object choice)

setSelectedByIndex

public void setSelectedByIndex(int index)

Set the currently selected object using its index. If sortOK, then this may not be the original index.

Parameters:

index - of selected object.