anecho.gui
Class JMappedComboBox

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JComboBox
                  anecho.gui.JMappedComboBox

All Implemented Interfaces:

java.awt.event.ActionListener, java.awt.image.ImageObserver, java.awt.ItemSelectable, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.event.ListDataListener

public class JMappedComboBox
extends javax.swing.JComboBox
implements java.io.Serializable

JMappedComboBox.java is a GUI class that extends JComboBox to allow a hidden "column" of information to go along with the user-displayed information. This is useful for keeping "keys" to database entries or the like.

See Also:

Serialized Form

Nested Class Summary

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

javax.swing.JComboBox.AccessibleJComboBox, javax.swing.JComboBox.KeySelectionManager

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

static long

serialVersionUID the serial version UID required by java.io.Serializable

Fields inherited from class javax.swing.JComboBox

actionCommand, dataModel, editor, isEditable, keySelectionManager, lightWeightPopupEnabled, maximumRowCount, renderer, selectedItemReminder

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

JMappedComboBox()
JMappedComboBox.java is a GUI class that extends JComboBox to allow a hidden "column" of information to go along with the user-displayed information.

JMappedComboBox(javax.swing.ComboBoxModel aModel)
JMappedComboBox.java is a GUI class that extends JComboBox to allow a hidden "column" of information to go along with the user-displayed information.

JMappedComboBox(java.lang.Object[] items)
JMappedComboBox.java is a GUI class that extends JComboBox to allow a hidden "column" of information to go along with the user-displayed information.

JMappedComboBox(java.lang.Object[] items, java.lang.Object[] maps)
JMappedComboBox.java is a GUI class that extends JComboBox to allow a hidden "column" of information to go along with the user-displayed information.

JMappedComboBox(java.util.Vector items)
JMappedComboBox.java is a GUI class that extends JComboBox to allow a hidden "column" of information to go along with the user-displayed information.

JMappedComboBox(java.util.Vector items, java.util.Vector maps)
JMappedComboBox.java is a GUI class that extends JComboBox to allow a hidden "column" of information to go along with the user-displayed information.

Method Summary

void	addItem(java.lang.Object item) This method adds a new item to the bottom of our combobox (with no associated map)
void	addItem(java.lang.Object item, java.lang.Object map) This method will add an item and its associated map to the combobox.
boolean	containsItem(java.lang.Object item) This method is used to determine if the current JMappedComboBox contains for supplied item
int	getItemIndex(java.lang.Object item)
int	getItemIndex(java.lang.Object item, int offset)
java.lang.Object	getMapAt(int index) Return our map key based on the given index
int	getMapIndex(java.lang.Object map) Returns the index of the provided map starting from the beginning of the list of maps
int	getMapIndex(java.lang.Object map, int offset) Returns the index of the provided map based on the starting offset
java.lang.Object	getMappedObject(java.lang.Object map) Returns an object based on the object map provided
java.lang.Object	getSelectedMap() This method returns to map of the currently selected combobox item
void	insertItemAt(java.lang.Object anObject, int index) This method is used to add an item to our combobox at a specific location.
void	insertItemAt(java.lang.Object anObject, int index, java.lang.Object map) This method is used to add an item to our combobox at a specific location.
void	removeAllItems() Removes all items from the JMappedComboBox
void	removeItem(java.lang.Object anObject) The method removes the given object from our combobox
void	removeItemAt(int index) The method removes the object at the given index from our combobox
void	setSelectedMap(java.lang.Object map) This method sets the map of the currently selected object.

Methods inherited from class javax.swing.JComboBox

actionPerformed, actionPropertyChanged, addActionListener, addItemListener, addPopupMenuListener, configureEditor, configurePropertiesFromAction, contentsChanged, createActionPropertyChangeListener, createDefaultKeySelectionManager, fireActionEvent, fireItemStateChanged, firePopupMenuCanceled, firePopupMenuWillBecomeInvisible, firePopupMenuWillBecomeVisible, getAccessibleContext, getAction, getActionCommand, getActionListeners, getEditor, getItemAt, getItemCount, getItemListeners, getKeySelectionManager, getMaximumRowCount, getModel, getPopupMenuListeners, getPrototypeDisplayValue, getRenderer, getSelectedIndex, getSelectedItem, getSelectedObjects, getUI, getUIClassID, hidePopup, installAncestorListener, intervalAdded, intervalRemoved, isEditable, isLightWeightPopupEnabled, isPopupVisible, paramString, processKeyEvent, removeActionListener, removeItemListener, removePopupMenuListener, selectedItemChanged, selectWithKeyChar, setAction, setActionCommand, setEditable, setEditor, setEnabled, setKeySelectionManager, setLightWeightPopupEnabled, setMaximumRowCount, setModel, setPopupVisible, setPrototypeDisplayValue, setRenderer, setSelectedIndex, setSelectedItem, setUI, showPopup, 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, 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, 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, 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

serialVersionUID

public static final long serialVersionUID

the serial version UID required by java.io.Serializable

See Also:

Constant Field Values

Constructor Detail

JMappedComboBox

public JMappedComboBox()

JMappedComboBox.java is a GUI class that extends JComboBox to allow a hidden "column" of information to go along with the user-displayed information. This is useful for keeping "keys" to database entries or the like

JMappedComboBox

public JMappedComboBox(javax.swing.ComboBoxModel aModel)

JMappedComboBox.java is a GUI class that extends JComboBox to allow a hidden "column" of information to go along with the user-displayed information. This is useful for keeping "keys" to database entries or the like.

Parameters:

aModel - The combobox model to use with this component.

JMappedComboBox

public JMappedComboBox(java.lang.Object[] items)

JMappedComboBox.java is a GUI class that extends JComboBox to allow a hidden "column" of information to go along with the user-displayed information. This is useful for keeping "keys" to database entries or the like.

Parameters:

items - An array of items to be used to populate our combobox

JMappedComboBox

public JMappedComboBox(java.util.Vector items)

JMappedComboBox.java is a GUI class that extends JComboBox to allow a hidden "column" of information to go along with the user-displayed information. This is useful for keeping "keys" to database entries or the like.

Parameters:

items - A Vector of Objects to populate our combobox.

JMappedComboBox

public JMappedComboBox(java.lang.Object[] items,
                       java.lang.Object[] maps)

JMappedComboBox.java is a GUI class that extends JComboBox to allow a hidden "column" of information to go along with the user-displayed information. This is useful for keeping "keys" to database entries or the like.

Parameters:

items - An Array of Objects to populate our combobox

maps - An Array of "maps" to correlate with our items

JMappedComboBox

public JMappedComboBox(java.util.Vector items,
                       java.util.Vector maps)

JMappedComboBox.java is a GUI class that extends JComboBox to allow a hidden "column" of information to go along with the user-displayed information. This is useful for keeping "keys" to database entries or the like.

Parameters:

items - A Vector of items to populate our combobox

maps - A Vector of "maps" to correspond to our items

Method Detail

addItem

public void addItem(java.lang.Object item)

This method adds a new item to the bottom of our combobox (with no associated map)

Overrides:

addItem in class javax.swing.JComboBox

Parameters:

item - The item to be added to our combobox

addItem

public void addItem(java.lang.Object item,
                    java.lang.Object map)

This method will add an item and its associated map to the combobox.

Parameters:

item - Item to be added to the combobox

map - The map associated with our item

getMappedObject

public java.lang.Object getMappedObject(java.lang.Object map)

Returns an object based on the object map provided

Parameters:

map -

Returns:

getMapAt

public java.lang.Object getMapAt(int index)

Return our map key based on the given index

Parameters:

index - This integer indicates the (zero-based) index of an item in our combobox to return

Returns:

The Object at the selected index

containsItem

public boolean containsItem(java.lang.Object item)

This method is used to determine if the current JMappedComboBox contains for supplied item

Parameters:

item - The Object to test for the existance of

Returns:

true the given item is in the JMappedComboBox false the given item is not contained in the JMappedComboBox

getSelectedMap

public java.lang.Object getSelectedMap()

This method returns to map of the currently selected combobox item

Returns:

An Object of the currently selected map of our combobox.

insertItemAt

public void insertItemAt(java.lang.Object anObject,
                         int index)

This method is used to add an item to our combobox at a specific location.

Overrides:

insertItemAt in class javax.swing.JComboBox

Parameters:

anObject - The Object to be added to our combobox.

index - The zero-based index of where to insert the new object

insertItemAt

public void insertItemAt(java.lang.Object anObject,
                         int index,
                         java.lang.Object map)

This method is used to add an item to our combobox at a specific location.

Parameters:

anObject - The Object to be added to our combobox

index - The zero-based index of where to insert the new object

map - The map object associated with the new item we are adding to the combobox.

removeAllItems

public void removeAllItems()

Removes all items from the JMappedComboBox

Overrides:

removeAllItems in class javax.swing.JComboBox

removeItem

public void removeItem(java.lang.Object anObject)

The method removes the given object from our combobox

Overrides:

removeItem in class javax.swing.JComboBox

Parameters:

anObject - The object to be removed from our combobox.

removeItemAt

public void removeItemAt(int index)

The method removes the object at the given index from our combobox

Overrides:

removeItemAt in class javax.swing.JComboBox

Parameters:

index - The (zero-based) index of the object to remove

setSelectedMap

public void setSelectedMap(java.lang.Object map)

This method sets the map of the currently selected object.

Parameters:

map - The map to be used by the currently selected item in our combobox.

getMapIndex

public int getMapIndex(java.lang.Object map,
                       int offset)

Returns the index of the provided map based on the starting offset

Parameters:

map - The "map" object to search for

offset - The offset from the beginning of the map index to start searching

Returns:

This returns the index of the "map" object if found. If the map is not found this method returns -1.

getMapIndex

public int getMapIndex(java.lang.Object map)

Returns the index of the provided map starting from the beginning of the list of maps

Parameters:

map - The "map" object to search for

Returns:

This returns the index of the "map" object if found. If the map is not found this method returns -1.

getItemIndex

public int getItemIndex(java.lang.Object item)

getItemIndex

public int getItemIndex(java.lang.Object item,
                        int offset)