org.xnap.gui.component
Class HistoryComboBox

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JComboBox
                  org.xnap.gui.component.HistoryComboBox

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, Clearable, Completable

public class HistoryComboBox
extends javax.swing.JComboBox
implements Clearable, Completable

Provides a JComboBox with auto completion and a history.

See Also:

Serialized Form

Nested Class Summary

class

HistoryComboBox.FocusHandler Make sure a valid item is selected when focus is lost.

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.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

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.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

HistoryComboBox(javax.swing.ComboBoxModel model, int columns)
Constructs a new HistoryComboBox that takes it's items from an existing ComboBoxModel.

HistoryComboBox(int columns)
Constructs a new HistoryComboBox with specified width.

HistoryComboBox(java.util.Vector history, int columns)
Constructs a new HistoryComboBox with a history and specified width.

Method Summary

void	addDistinctItemAtTop(java.lang.Object item) Adds item if not already in list.
void	clear() Implements Clearable interface.
CompletionMode	getCompletionMode() Returns the currently set completion mode.
CompletionModel	getCompletionModel() Returns the currently used completion model.
java.lang.Object[]	getHistoryItems()
boolean	getItemsOnly()
java.awt.Dimension	getMaximumSize()
java.awt.Dimension	getMinimumSize()
java.awt.Dimension	getPreferredSize()
java.lang.Object	getSelectedItem() Returns the selected object if autoComplete is true or editable is false.
java.lang.String	getText()
javax.swing.text.JTextComponent	getTextComponent() Returns the text component the completion mode should operate on.
javax.swing.JTextField	getTextField()
void	intervalAdded(javax.swing.event.ListDataEvent event) Overwritten to insert the new elements in the history into the completion model.
boolean	isItemSelected()
void	setCompletionMode(java.lang.String mode) Sets the completion mode to one of the modes provided by the CompletionModeFactory.
void	setCompletionModel(CompletionModel model) Sets the completion model.
void	setItemsOnly(boolean newValue)
void	setPreferences(java.lang.String prefsKey)
void	setPreferences(java.lang.String prefsKey, PreferencesProvider prefs)
void	setText(java.lang.String newValue)

Methods inherited from class javax.swing.JComboBox

actionPerformed, addActionListener, addItem, 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, getSelectedObjects, getUI, getUIClassID, hidePopup, insertItemAt, installAncestorListener, intervalRemoved, isEditable, isLightWeightPopupEnabled, isPopupVisible, paramString, processKeyEvent, removeActionListener, removeAllItems, removeItem, removeItemAt, 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, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getNextFocusableComponent, getPopupLocation, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, 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

Constructor Detail

HistoryComboBox

public HistoryComboBox(java.util.Vector history,
                       int columns)

Constructs a new HistoryComboBox with a history and specified width.

HistoryComboBox

public HistoryComboBox(javax.swing.ComboBoxModel model,
                       int columns)

Constructs a new HistoryComboBox that takes it's items from an existing ComboBoxModel.

HistoryComboBox

public HistoryComboBox(int columns)

Constructs a new HistoryComboBox with specified width.

Method Detail

getHistoryItems

public java.lang.Object[] getHistoryItems()

isItemSelected

public boolean isItemSelected()

setItemsOnly

public void setItemsOnly(boolean newValue)

getItemsOnly

public boolean getItemsOnly()

getMaximumSize

public java.awt.Dimension getMaximumSize()

Overrides:

getMaximumSize in class javax.swing.JComponent

getMinimumSize

public java.awt.Dimension getMinimumSize()

Overrides:

getMinimumSize in class javax.swing.JComponent

getPreferredSize

public java.awt.Dimension getPreferredSize()

Overrides:

getPreferredSize in class javax.swing.JComponent

getSelectedItem

public java.lang.Object getSelectedItem()

Returns the selected object if autoComplete is true or editable is false. Otherwise you only get a string.

Overrides:

getSelectedItem in class javax.swing.JComboBox

Returns:

the selected object (if autoComplete is true or editable is false).

setText

public void setText(java.lang.String newValue)

getText

public java.lang.String getText()

getTextComponent

public javax.swing.text.JTextComponent getTextComponent()

Description copied from interface: Completable

Returns the text component the completion mode should operate on.

Specified by:

getTextComponent in interface Completable

getTextField

public javax.swing.JTextField getTextField()

setCompletionModel

public void setCompletionModel(CompletionModel model)

Description copied from interface: Completable

Sets the completion model.

Specified by:

setCompletionModel in interface Completable

getCompletionModel

public CompletionModel getCompletionModel()

Description copied from interface: Completable

Returns the currently used completion model.

Specified by:

getCompletionModel in interface Completable

getCompletionMode

public CompletionMode getCompletionMode()

Description copied from interface: Completable

Returns the currently set completion mode.

Specified by:

getCompletionMode in interface Completable

setPreferences

public void setPreferences(java.lang.String prefsKey,
                           PreferencesProvider prefs)

setPreferences

public void setPreferences(java.lang.String prefsKey)

intervalAdded

public void intervalAdded(javax.swing.event.ListDataEvent event)

Overwritten to insert the new elements in the history into the completion model.

Specified by:

intervalAdded in interface javax.swing.event.ListDataListener

Overrides:

intervalAdded in class javax.swing.JComboBox

setCompletionMode

public void setCompletionMode(java.lang.String mode)

Description copied from interface: Completable

Sets the completion mode to one of the modes provided by the CompletionModeFactory.

Specified by:

setCompletionMode in interface Completable

Parameters:

mode - the unique id of the completion mode

addDistinctItemAtTop

public void addDistinctItemAtTop(java.lang.Object item)

Adds item if not already in list.

clear

public void clear()

Implements Clearable interface.

Specified by:

clear in interface Clearable