magi.toolkit.fields
Class MagiComboBox

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.JComboBox
                          |
                          +--magi.toolkit.fields.MagiComboBox
All Implemented Interfaces:
javax.accessibility.Accessible, java.awt.event.ActionListener, java.util.EventListener, java.awt.image.ImageObserver, java.awt.ItemSelectable, javax.swing.event.ListDataListener, java.awt.MenuContainer, java.io.Serializable

public class MagiComboBox
extends javax.swing.JComboBox

A Combo Box component that allows easy data setting and retrieval.

Author:
Paul Atkinson, Magi Systems Pty Ltd.
See Also:
MagiComboBoxModel, ComboList, Serialized Form

Field Summary
 
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.Container
 
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
MagiComboBox()
          Default constructor.
MagiComboBox(java.util.Collection collection)
          Create a Combo Box with any Collection of Objects, for example a List, Set, Vector, etc.
MagiComboBox(java.util.Collection collection, int index)
          Create a Combo Box with any Collection of Objects, for example a List, Set, Vector, etc.
MagiComboBox(MagiComboBoxModel model)
          Create a Combo Box with a model containing data.
MagiComboBox(java.lang.Object[] objectArray)
          Create a Combo Box with an array of Objects.
MagiComboBox(java.lang.Object[] objectArray, int index)
          Create a Combo Box with an array of Objects.
 
Method Summary
 void addItem(java.lang.Object item)
          Adds an item Object to the end of the combo data.
 ComboList getData()
          Returns a List of Combo Box data from this Combo Box.
 MagiComboBoxModel getMagiModel()
          Return a MagiComboBoxModel used to populate this combo box.
 int getSelectedIndex()
          Returns the selected index from this Combo Box.
 java.lang.Object getSelectedItem()
          Returns the selected item Object from this Combo Box.
 void removeItem(java.lang.Object item)
          Removes an item Object from the combo data.
 void setData(ComboList comboList)
          Sets the list of Combo Box data into this Combo Box.
 void setMagiModel(MagiComboBoxModel model)
          Sets a MagiComboBoxModel used to populate this combo box.
 void setSelectedIndex(int index)
          Sets the selected item index in this Combo Box.
 void setSelectedItem(java.lang.Object item)
          Sets the selected item inside this Combo Box.
 
Methods inherited from class javax.swing.JComboBox
actionPerformed, 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, getSelectedObjects, getUI, getUIClassID, hidePopup, insertItemAt, installAncestorListener, intervalAdded, intervalRemoved, isEditable, isLightWeightPopupEnabled, isPopupVisible, paramString, processKeyEvent, removeActionListener, removeAllItems, removeItemAt, removeItemListener, removePopupMenuListener, selectedItemChanged, selectWithKeyChar, setAction, setActionCommand, setEditable, setEditor, setEnabled, setKeySelectionManager, setLightWeightPopupEnabled, setMaximumRowCount, setModel, setPopupVisible, setPrototypeDisplayValue, setRenderer, setUI, showPopup, updateUI
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setFont, setForeground, 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, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, 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, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, 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, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, 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
 

Constructor Detail

MagiComboBox

public MagiComboBox()
Default constructor.


MagiComboBox

public MagiComboBox(java.lang.Object[] objectArray)
Create a Combo Box with an array of Objects.

Parameters:
objectArray - an array of Objects to populate this combo with.

MagiComboBox

public MagiComboBox(java.util.Collection collection)
Create a Combo Box with any Collection of Objects, for example a List, Set, Vector, etc.

Parameters:
collection - a Collection of objects to populate this combo with.

MagiComboBox

public MagiComboBox(java.lang.Object[] objectArray,
                    int index)
Create a Combo Box with an array of Objects.

Parameters:
objectArray - an array of Objects to populate this combo with.
index - the index of the selected item.

MagiComboBox

public MagiComboBox(java.util.Collection collection,
                    int index)
Create a Combo Box with any Collection of Objects, for example a List, Set, Vector, etc.

Parameters:
collection - a Collection of objects to populate this combo with.
index - the index of the selected item.

MagiComboBox

public MagiComboBox(MagiComboBoxModel model)
Create a Combo Box with a model containing data.

Parameters:
model - a MagiComboBoxModel containing combo data.
Method Detail

getMagiModel

public MagiComboBoxModel getMagiModel()
Return a MagiComboBoxModel used to populate this combo box.

Returns:
a MagiComboBoxModel instance.

setMagiModel

public void setMagiModel(MagiComboBoxModel model)
Sets a MagiComboBoxModel used to populate this combo box.

Parameters:
model - a MagiComboBoxModel instance.

setSelectedItem

public void setSelectedItem(java.lang.Object item)
Sets the selected item inside this Combo Box.

Overrides:
setSelectedItem in class javax.swing.JComboBox
Parameters:
item - the item Object to select.

getSelectedItem

public java.lang.Object getSelectedItem()
Returns the selected item Object from this Combo Box.

Overrides:
getSelectedItem in class javax.swing.JComboBox
Returns:
the selected Object.

setSelectedIndex

public void setSelectedIndex(int index)
Sets the selected item index in this Combo Box.

Overrides:
setSelectedIndex in class javax.swing.JComboBox
Parameters:
index - the selected index.

getSelectedIndex

public int getSelectedIndex()
Returns the selected index from this Combo Box.

Overrides:
getSelectedIndex in class javax.swing.JComboBox
Returns:
the selected index.

addItem

public void addItem(java.lang.Object item)
Adds an item Object to the end of the combo data.

Overrides:
addItem in class javax.swing.JComboBox
Parameters:
item - an item Object to add to the end.
See Also:
removeItem(Object)

removeItem

public void removeItem(java.lang.Object item)
Removes an item Object from the combo data. If this item is the selected item, the combo selection is lost.

Overrides:
removeItem in class javax.swing.JComboBox
Parameters:
item - an item Object to remove.
See Also:
addItem(Object)

setData

public void setData(ComboList comboList)
Sets the list of Combo Box data into this Combo Box.

Parameters:
comboList - a List of combo box data and (optionally) a selected item.

getData

public ComboList getData()
Returns a List of Combo Box data from this Combo Box.

Returns:
a ComboList object.