net.sf.sbcc.componentcombo
Class JAbstractComponentComboBox

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              net.sf.sbcc.componentcombo.JAbstractComponentComboBox

All Implemented Interfaces:

java.awt.event.ActionListener, java.awt.image.ImageObserver, java.awt.ItemSelectable, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, SimpleDataListener

Direct Known Subclasses:

JMultiButtonComboBox

public abstract class JAbstractComponentComboBox
extends javax.swing.JComponent
implements SimpleDataListener, java.awt.ItemSelectable, java.awt.event.ActionListener

Author:

Christoph Bimminger

See Also:

Serialized Form

Nested Class Summary

(package private) class	JAbstractComponentComboBox.DefaultKeySelectionManager
static interface	JAbstractComponentComboBox.KeySelectionManager The interface that defines a 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

private javax.swing.Action	action
protected java.lang.String	actionCommand This protected field is implementation specific.
private java.beans.PropertyChangeListener	actionPropertyChangeListener
protected SimpleComboBoxModel	dataModel This protected field is implementation specific.
protected javax.swing.ComboBoxEditor	editor This protected field is implementation specific.
private boolean	firingActionEvent
protected boolean	isEditable This protected field is implementation specific.
protected JAbstractComponentComboBox.KeySelectionManager	keySelectionManager This protected field is implementation specific.
protected boolean	lightWeightPopupEnabled This protected field is implementation specific.
private javax.swing.JComponent	popupComponent
private java.lang.Object	prototypeDisplayValue
private javax.swing.ListCellRenderer	renderer
protected java.lang.Object	selectedItemReminder This protected field is implementation specific.
private boolean	selectingItem
private boolean	togglePopupOnEachField when this field is set to false, we know to toggle the popup on arrow button only.
private static java.lang.String	uiClassID

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

JAbstractComponentComboBox()

JAbstractComponentComboBox(javax.swing.JComponent P_popupComponent)
use this constructor per default...

Method Summary

void	actionPerformed(java.awt.event.ActionEvent e) This method is public as an implementation side effect.
void	addActionListener(java.awt.event.ActionListener l) Adds an ActionListener.
void	addItemListener(java.awt.event.ItemListener aListener) Adds an ItemListener.
void	addPopupMenuListener(javax.swing.event.PopupMenuListener l) Adds a PopupMenu listener which will listen to notification messages from the popup portion of the combo box.
void	configureEditor(javax.swing.ComboBoxEditor anEditor, java.lang.Object anItem) Initializes the editor with the specified item.
protected void	configurePropertiesFromAction(javax.swing.Action a) Factory method which sets the ActionEvent source's properties according to values from the Action instance.
void	contentsChanged(SimpleDataEvent e) This method is public as an implementation side effect.
protected java.beans.PropertyChangeListener	createActionPropertyChangeListener(javax.swing.Action a) Factory method which creates the PropertyChangeListener used to update the ActionEvent source as properties change on its Action instance.
protected JAbstractComponentComboBox.KeySelectionManager	createDefaultKeySelectionManager() Returns an instance of the default key-selection manager.
protected void	fireActionEvent() Notifies all listeners that have registered interest for notification on this event type.
protected void	fireItemStateChanged(java.awt.event.ItemEvent e) Notifies all listeners that have registered interest for notification on this event type.
void	firePopupMenuCanceled() Notifies PopupMenuListeners that the popup portion of the combo box has been canceled.
void	firePopupMenuWillBecomeInvisible() Notifies PopupMenuListeners that the popup portion of the combo box has become invisible.
void	firePopupMenuWillBecomeVisible() Notifies PopupMenuListeners that the popup portion of the combo box will become visible.
javax.swing.Action	getAction() Returns the currently set Action for this ActionEvent source, or null if no Action is set.
java.lang.String	getActionCommand() Returns the action command that is included in the event sent to action listeners.
java.awt.event.ActionListener[]	getActionListeners() Returns an array of all the ActionListeners added to this JComboBox with addActionListener().
javax.swing.ComboBoxEditor	getEditor() Returns the editor used to paint and edit the selected item in the JComboBox field.
java.awt.event.ItemListener[]	getItemListeners() Returns an array of all the ItemListeners added to this JComboBox with addItemListener().
protected java.lang.String	getItemString(java.lang.Object P_item) override this method to display the selected object different to the default implementation.
JAbstractComponentComboBox.KeySelectionManager	getKeySelectionManager() Returns the list's key-selection manager.
SimpleComboBoxModel	getModel() Returns the data model currently used by the JComboBox.
javax.swing.JComponent	getPopupComponent() The component which is displayed in
javax.swing.event.PopupMenuListener[]	getPopupMenuListeners() Returns an array of all the PopupMenuListeners added to this JComboBox with addPopupMenuListener().
java.lang.Object	getPrototypeDisplayValue() Returns the "prototypical display" value - an Object used for the calculation of the display height and width.
javax.swing.ListCellRenderer	getRenderer() Returns the renderer used to display the selected item in the JComboBox field.
java.lang.Object	getSelectedItem() Returns the current selected item.
protected abstract java.lang.Object	getSelectedValueFromPopup() Must be implementet to know how to get the component value from popup.
ComponentComboBoxUI	getUI() Returns the L&F object that renders this component.
java.lang.String	getUIClassID() Returns the name of the L&F class that renders this component.
void	hidePopup() Causes the combo box to close its popup window.
private void	init()
protected void	installAncestorListener()
boolean	isEditable() Returns true if the JComboBox is editable.
boolean	isLightWeightPopupEnabled() Gets the value of the lightWeightPopupEnabled property.
private boolean	isListener(java.lang.Class c, java.awt.event.ActionListener a)
boolean	isPopupVisible() Determines the visibility of the popup.
boolean	isTogglePopupOnEachField()
protected java.lang.String	paramString() Returns a string representation of this JComboBox.
void	processKeyEvent(java.awt.event.KeyEvent e) Handles KeyEvents, looking for the Tab key.
void	removeActionListener(java.awt.event.ActionListener l) Removes an ActionListener.
void	removeItemListener(java.awt.event.ItemListener aListener) Removes an ItemListener.
void	removePopupMenuListener(javax.swing.event.PopupMenuListener l) Removes a PopupMenuListener.
protected void	selectedItemChanged() This protected method is implementation specific.
boolean	selectWithKeyChar(char keyChar) Selects the list item that corresponds to the specified keyboard character and returns true, if there is an item corresponding to that character.
void	setAction(javax.swing.Action a) Sets the Action for the ActionEvent source.
void	setActionCommand(java.lang.String aCommand) Sets the action command that should be included in the event sent to action listeners.
void	setEditable(boolean aFlag) Determines whether the JComboBox field is editable.
void	setEditor(javax.swing.ComboBoxEditor anEditor) Sets the editor used to paint and edit the selected item in the JComboBox field.
void	setEnabled(boolean b) Enables the combo box so that items can be selected.
void	setKeySelectionManager(JAbstractComponentComboBox.KeySelectionManager aManager) Sets the object that translates a keyboard character into a list selection.
void	setLightWeightPopupEnabled(boolean aFlag) Sets the lightWeightPopupEnabled property, which provides a hint as to whether or not a lightweight Component should be used to contain the JComboBox, versus a heavyweight Component such as a Panel or a Window.
void	setModel(SimpleComboBoxModel aModel) Sets the data model that the JComboBox uses to obtain the list of items.
void	setPopupComponent(javax.swing.JComponent P_popupComponent) similar to JScrollPane.setViewPort - may be called immediately after empty constructor, in cases where we already needed the component instance to create the popup component..
void	setPopupVisible(boolean v) Sets the visibility of the popup.
void	setPrototypeDisplayValue(java.lang.Object prototypeDisplayValue) Sets the prototype display value used to calculate the size of the display for the UI portion.
void	setRenderer(javax.swing.ListCellRenderer aRenderer) Sets the renderer that paints the item selected from the list in the JComboBox field.
void	setSelectedItem(java.lang.Object anObject) Sets the selected item in the combo box display area to the object in the argument.
void	setTogglePopupOnEachField(boolean togglePopupOnEachField)
void	setUI(ComponentComboBoxUI ui) Sets the L&F object that renders this component.
void	showPopup() Causes the combo box to display its popup window.
void	updateUI() Resets the UI property to a value from the current look and feel.

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getAccessibleContext, 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, 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, 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

Methods inherited from interface java.awt.ItemSelectable

getSelectedObjects

Field Detail

uiClassID

private static final java.lang.String uiClassID

See Also:

getUIClassID(), JComponent.readObject(java.io.ObjectInputStream), Constant Field Values

popupComponent

private javax.swing.JComponent popupComponent

dataModel

protected SimpleComboBoxModel dataModel

This protected field is implementation specific. Do not access directly or override. Use the accessor methods instead.

See Also:

getModel(), setModel(net.sf.sbcc.componentcombo.SimpleComboBoxModel)

editor

protected javax.swing.ComboBoxEditor editor

This protected field is implementation specific. Do not access directly or override. Use the accessor methods instead.

See Also:

getEditor(), setEditor(javax.swing.ComboBoxEditor)

isEditable

protected boolean isEditable

This protected field is implementation specific. Do not access directly or override. Use the accessor methods instead.

See Also:

isEditable, setEditable(boolean)

keySelectionManager

protected JAbstractComponentComboBox.KeySelectionManager keySelectionManager

This protected field is implementation specific. Do not access directly or override. Use the accessor methods instead.

See Also:

setKeySelectionManager(net.sf.sbcc.componentcombo.JAbstractComponentComboBox.KeySelectionManager), getKeySelectionManager()

actionCommand

protected java.lang.String actionCommand

This protected field is implementation specific. Do not access directly or override. Use the accessor methods instead.

See Also:

setActionCommand(java.lang.String), getActionCommand()

lightWeightPopupEnabled

protected boolean lightWeightPopupEnabled

This protected field is implementation specific. Do not access directly or override. Use the accessor methods instead.

See Also:

setLightWeightPopupEnabled(boolean), isLightWeightPopupEnabled()

selectedItemReminder

protected java.lang.Object selectedItemReminder

This protected field is implementation specific. Do not access directly or override.

prototypeDisplayValue

private java.lang.Object prototypeDisplayValue

firingActionEvent

private boolean firingActionEvent

selectingItem

private boolean selectingItem

renderer

private javax.swing.ListCellRenderer renderer

togglePopupOnEachField

private boolean togglePopupOnEachField

when this field is set to false, we know to toggle the popup on arrow button only.

action

private javax.swing.Action action

actionPropertyChangeListener

private java.beans.PropertyChangeListener actionPropertyChangeListener

Constructor Detail

JAbstractComponentComboBox

public JAbstractComponentComboBox(javax.swing.JComponent P_popupComponent)

use this constructor per default...

JAbstractComponentComboBox

public JAbstractComponentComboBox()

Method Detail

init

private void init()

installAncestorListener

protected void installAncestorListener()

setUI

public void setUI(ComponentComboBoxUI ui)

Sets the L&F object that renders this component.

Parameters:

ui - the ComboBoxUI L&F object

See Also:

UIDefaults.getUI(javax.swing.JComponent)

updateUI

public void updateUI()

Resets the UI property to a value from the current look and feel.

Overrides:

updateUI in class javax.swing.JComponent

See Also:

JComponent.updateUI()

getUIClassID

public java.lang.String getUIClassID()

Returns the name of the L&F class that renders this component.

Overrides:

getUIClassID in class javax.swing.JComponent

Returns:

the string "ComboBoxUI"

See Also:

JComponent.getUIClassID(), UIDefaults.getUI(javax.swing.JComponent)

getUI

public ComponentComboBoxUI getUI()

Returns the L&F object that renders this component.

Returns:

the ComboBoxUI object that renders this component

setModel

public void setModel(SimpleComboBoxModel aModel)

Sets the data model that the JComboBox uses to obtain the list of items.

Parameters:

aModel - the ComboBoxModel that provides the displayed list of items

getModel

public SimpleComboBoxModel getModel()

Returns the data model currently used by the JComboBox.

Returns:

the ComboBoxModel that provides the displayed list of items

setLightWeightPopupEnabled

public void setLightWeightPopupEnabled(boolean aFlag)

Sets the lightWeightPopupEnabled property, which provides a hint as to whether or not a lightweight Component should be used to contain the JComboBox, versus a heavyweight Component such as a Panel or a Window. The decision of lightweight versus heavyweight is ultimately up to the JComboBox. Lightweight windows are more efficient than heavyweight windows, but lightweight and heavyweight components do not mix well in a GUI. If your application mixes lightweight and heavyweight components, you should disable lightweight popups. The default value for the lightWeightPopupEnabled property is true, unless otherwise specified by the look and feel. Some look and feels always use heavyweight popups, no matter what the value of this property.

See the article Mixing Heavy and Light Components on The Swing Connection This method fires a property changed event.

Parameters:

aFlag - if true, lightweight popups are desired

isLightWeightPopupEnabled

public boolean isLightWeightPopupEnabled()

Gets the value of the lightWeightPopupEnabled property.

Returns:

the value of the lightWeightPopupEnabled property

See Also:

setLightWeightPopupEnabled(boolean)

setEditable

public void setEditable(boolean aFlag)

Determines whether the JComboBox field is editable. An editable JComboBox allows the user to type into the field or selected an item from the list to initialize the field, after which it can be edited. (The editing affects only the field, the list item remains intact.) A non editable JComboBox displays the selected item in the field, but the selection cannot be modified.

Parameters:

aFlag - a boolean value, where true indicates that the field is editable

isEditable

public boolean isEditable()

Returns true if the JComboBox is editable. By default, a combo box is not editable.

Returns:

true if the JComboBox is editable, else false

setRenderer

public void setRenderer(javax.swing.ListCellRenderer aRenderer)

Sets the renderer that paints the item selected from the list in the JComboBox field. The renderer is used if the JComboBox is not editable. If it is editable, the editor is used to render and edit the selected item.

The default renderer displays a string or an icon. Other renderers can handle graphic images and composite items.

To display the selected item, aRenderer.getListCellRendererComponent is called, passing the list object and an index of -1.

Parameters:

aRenderer - the ListCellRenderer that displays the selected item

See Also:

setEditor(javax.swing.ComboBoxEditor)

getRenderer

public javax.swing.ListCellRenderer getRenderer()

Returns the renderer used to display the selected item in the JComboBox field.

Returns:

the ListCellRenderer that displays the selected item.

setEditor

public void setEditor(javax.swing.ComboBoxEditor anEditor)

Sets the editor used to paint and edit the selected item in the JComboBox field. The editor is used only if the receiving JComboBox is editable. If not editable, the combo box uses the renderer to paint the selected item.

Parameters:

anEditor - the ComboBoxEditor that displays the selected item

See Also:

setRenderer(javax.swing.ListCellRenderer)

getEditor

public javax.swing.ComboBoxEditor getEditor()

Returns the editor used to paint and edit the selected item in the JComboBox field.

Returns:

the ComboBoxEditor that displays the selected item

setSelectedItem

public void setSelectedItem(java.lang.Object anObject)

Sets the selected item in the combo box display area to the object in the argument. If anObject is in the list, the display area shows anObject selected.

If anObject is not in the list and the combo box is uneditable, it will not change the current selection. For editable combo boxes, the selection will change to anObject.

If this constitutes a change in the selected item, ItemListeners added to the combo box will be notified with one or two ItemEvents. If there is a current selected item, an ItemEvent will be fired and the state change will be ItemEvent.DESELECTED. If anObject is in the list and is not currently selected then an ItemEvent will be fired and the state change will be ItemEvent.SELECTED.

ActionListeners added to the combo box will be notified with an ActionEvent when this method is called.

Parameters:

anObject - the list object to select; use null to clear the selection

getSelectedItem

public java.lang.Object getSelectedItem()

Returns the current selected item.

If the combo box is editable, then this value may not have been added to the combo box with addItem, insertItemAt or the data constructors.

Returns:

the current selected Object

See Also:

setSelectedItem(java.lang.Object)

getPrototypeDisplayValue

public java.lang.Object getPrototypeDisplayValue()

Returns the "prototypical display" value - an Object used for the calculation of the display height and width.

Returns:

the value of the prototypeDisplayValue property

Since:

1.4

See Also:

setPrototypeDisplayValue(java.lang.Object)

setPrototypeDisplayValue

public void setPrototypeDisplayValue(java.lang.Object prototypeDisplayValue)

Sets the prototype display value used to calculate the size of the display for the UI portion.

If a prototype display value is specified, the preferred size of the combo box is calculated by configuring the renderer with the prototype display value and obtaining its preferred size. Specifying the preferred display value is often useful when the combo box will be displaying large amounts of data. If no prototype display value has been specified, the renderer must be configured for each value from the model and its preferred size obtained, which can be relatively expensive.

Parameters:

prototypeDisplayValue -

Since:

1.4

See Also:

getPrototypeDisplayValue()

showPopup

public void showPopup()

Causes the combo box to display its popup window.

See Also:

setPopupVisible(boolean)

hidePopup

public void hidePopup()

Causes the combo box to close its popup window.

See Also:

setPopupVisible(boolean)

setPopupVisible

public void setPopupVisible(boolean v)

Sets the visibility of the popup.

isPopupVisible

public boolean isPopupVisible()

Determines the visibility of the popup.

Returns:

true if the popup is visible, otherwise returns false

addItemListener

public void addItemListener(java.awt.event.ItemListener aListener)

Adds an ItemListener.

aListener will receive one or two ItemEvents when the selected item changes.

Specified by:

addItemListener in interface java.awt.ItemSelectable

Parameters:

aListener - the ItemListener that is to be notified

See Also:

setSelectedItem(java.lang.Object)

removeItemListener

public void removeItemListener(java.awt.event.ItemListener aListener)

Removes an ItemListener.

Specified by:

removeItemListener in interface java.awt.ItemSelectable

Parameters:

aListener - the ItemListener to remove

getItemListeners

public java.awt.event.ItemListener[] getItemListeners()

Returns an array of all the ItemListeners added to this JComboBox with addItemListener().

Returns:

all of the ItemListeners added or an empty array if no listeners have been added

Since:

1.4

addActionListener

public void addActionListener(java.awt.event.ActionListener l)

Adds an ActionListener.

The ActionListener will receive an ActionEvent when a selection has been made. If the combo box is editable, then an ActionEvent will be fired when editing has stopped.

Parameters:

l - the ActionListener that is to be notified

See Also:

setSelectedItem(java.lang.Object)

removeActionListener

public void removeActionListener(java.awt.event.ActionListener l)

Removes an ActionListener.

Parameters:

l - the ActionListener to remove

getActionListeners

public java.awt.event.ActionListener[] getActionListeners()

Returns an array of all the ActionListeners added to this JComboBox with addActionListener().

Returns:

all of the ActionListeners added or an empty array if no listeners have been added

Since:

1.4

addPopupMenuListener

public void addPopupMenuListener(javax.swing.event.PopupMenuListener l)

Adds a PopupMenu listener which will listen to notification messages from the popup portion of the combo box.

For all standard look and feels shipped with Java 2, the popup list portion of combo box is implemented as a JPopupMenu. A custom look and feel may not implement it this way and will therefore not receive the notification.

Parameters:

l - the PopupMenuListener to add

Since:

1.4

removePopupMenuListener

public void removePopupMenuListener(javax.swing.event.PopupMenuListener l)

Removes a PopupMenuListener.

Parameters:

l - the PopupMenuListener to remove

Since:

1.4

See Also:

addPopupMenuListener(javax.swing.event.PopupMenuListener)

getPopupMenuListeners

public javax.swing.event.PopupMenuListener[] getPopupMenuListeners()

Returns an array of all the PopupMenuListeners added to this JComboBox with addPopupMenuListener().

Returns:

all of the PopupMenuListeners added or an empty array if no listeners have been added

Since:

1.4

firePopupMenuWillBecomeVisible

public void firePopupMenuWillBecomeVisible()

Notifies PopupMenuListeners that the popup portion of the combo box will become visible.

This method is public but should not be called by anything other than the UI delegate.

Since:

1.4

See Also:

addPopupMenuListener(javax.swing.event.PopupMenuListener)

firePopupMenuWillBecomeInvisible

public void firePopupMenuWillBecomeInvisible()

Notifies PopupMenuListeners that the popup portion of the combo box has become invisible.

This method is public but should not be called by anything other than the UI delegate.

Since:

1.4

See Also:

addPopupMenuListener(javax.swing.event.PopupMenuListener)

firePopupMenuCanceled

public void firePopupMenuCanceled()

Notifies PopupMenuListeners that the popup portion of the combo box has been canceled.

This method is public but should not be called by anything other than the UI delegate.

Since:

1.4

See Also:

addPopupMenuListener(javax.swing.event.PopupMenuListener)

setActionCommand

public void setActionCommand(java.lang.String aCommand)

Sets the action command that should be included in the event sent to action listeners.

Parameters:

aCommand - a string containing the "command" that is sent to action listeners; the same listener can then do different things depending on the command it receives

getActionCommand

public java.lang.String getActionCommand()

Returns the action command that is included in the event sent to action listeners.

Returns:

the string containing the "command" that is sent to action listeners.

setAction

public void setAction(javax.swing.Action a)

Sets the Action for the ActionEvent source. The new Action replaces any previously set Action but does not affect ActionListeners independently added with addActionListener. If the Action is already a registered ActionListener for the ActionEvent source, it is not re-registered.

A side-effect of setting the Action is that the ActionEvent source's properties are immedately set from the values in the Action (performed by the method configurePropertiesFromAction) and subsequently updated as the Action's properties change (via a PropertyChangeListener created by the method createActionPropertyChangeListener.

Parameters:

a - the Action for the JComboBox, or null.

Since:

1.3

See Also:

Action, getAction(), configurePropertiesFromAction(javax.swing.Action), createActionPropertyChangeListener(javax.swing.Action)

isListener

private boolean isListener(java.lang.Class c,
                           java.awt.event.ActionListener a)

getAction

public javax.swing.Action getAction()

Returns the currently set Action for this ActionEvent source, or null if no Action is set.

Returns:

the Action for this ActionEvent source; or null

Since:

1.3

See Also:

Action, setAction(javax.swing.Action)

configurePropertiesFromAction

protected void configurePropertiesFromAction(javax.swing.Action a)

Factory method which sets the ActionEvent source's properties according to values from the Action instance. The properties which are set may differ for subclasses. By default, the properties which get set are Enabled and ToolTipText.

Parameters:

a - the Action from which to get the properties, or null

Since:

1.3

See Also:

Action, setAction(javax.swing.Action)

createActionPropertyChangeListener

protected java.beans.PropertyChangeListener createActionPropertyChangeListener(javax.swing.Action a)

Factory method which creates the PropertyChangeListener used to update the ActionEvent source as properties change on its Action instance. Subclasses may override this in order to provide their own PropertyChangeListener if the set of properties which should be kept up to date differs from the default properties (Text, Icon, Enabled, ToolTipText). Note that PropertyChangeListeners should avoid holding strong references to the ActionEvent source, as this may hinder garbage collection of the ActionEvent source and all components in its containment hierarchy.

Since:

1.3

See Also:

Action, setAction(javax.swing.Action)

fireItemStateChanged

protected void fireItemStateChanged(java.awt.event.ItemEvent e)

Notifies all listeners that have registered interest for notification on this event type.

Parameters:

e - the event of interest

See Also:

EventListenerList

fireActionEvent

protected void fireActionEvent()

Notifies all listeners that have registered interest for notification on this event type.

See Also:

EventListenerList

selectedItemChanged

protected void selectedItemChanged()

This protected method is implementation specific. Do not access directly or override.

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent e)

This method is public as an implementation side effect. do not call or override.

Specified by:

actionPerformed in interface java.awt.event.ActionListener

contentsChanged

public void contentsChanged(SimpleDataEvent e)

This method is public as an implementation side effect. do not call or override.

Specified by:

contentsChanged in interface SimpleDataListener

Parameters:

e - a ListDataEvent encapsulating the event information

selectWithKeyChar

public boolean selectWithKeyChar(char keyChar)

Selects the list item that corresponds to the specified keyboard character and returns true, if there is an item corresponding to that character. Otherwise, returns false.

Parameters:

keyChar - a char, typically this is a keyboard key typed by the user

setEnabled

public void setEnabled(boolean b)

Enables the combo box so that items can be selected. When the combo box is disabled, items cannot be selected and values cannot be typed into its field (if it is editable).

Overrides:

setEnabled in class javax.swing.JComponent

Parameters:

b - a boolean value, where true enables the component and false disables it

configureEditor

public void configureEditor(javax.swing.ComboBoxEditor anEditor,
                            java.lang.Object anItem)

Initializes the editor with the specified item.

Parameters:

anEditor - the ComboBoxEditor that displays the list item in the combo box field and allows it to be edited

anItem - the object to display and edit in the field

processKeyEvent

public void processKeyEvent(java.awt.event.KeyEvent e)

Handles KeyEvents, looking for the Tab key. If the Tab key is found, the popup window is closed.

Overrides:

processKeyEvent in class javax.swing.JComponent

Parameters:

e - the KeyEvent containing the keyboard key that was pressed

setKeySelectionManager

public void setKeySelectionManager(JAbstractComponentComboBox.KeySelectionManager aManager)

Sets the object that translates a keyboard character into a list selection. Typically, the first selection with a matching first character becomes the selected item.

getKeySelectionManager

public JAbstractComponentComboBox.KeySelectionManager getKeySelectionManager()

Returns the list's key-selection manager.

Returns:

the KeySelectionManager currently in use

createDefaultKeySelectionManager

protected JAbstractComponentComboBox.KeySelectionManager createDefaultKeySelectionManager()

Returns an instance of the default key-selection manager.

Returns:

the KeySelectionManager currently used by the list

See Also:

setKeySelectionManager(net.sf.sbcc.componentcombo.JAbstractComponentComboBox.KeySelectionManager)

paramString

protected java.lang.String paramString()

Returns a string representation of this JComboBox. This method is intended to be used only for debugging purposes, and the content and format of the returned string may vary between implementations. The returned string may be empty but may not be null.

Overrides:

paramString in class javax.swing.JComponent

Returns:

a string representation of this JComboBox

setPopupComponent

public void setPopupComponent(javax.swing.JComponent P_popupComponent)

similar to JScrollPane.setViewPort - may be called immediately after empty constructor, in cases where we already needed the component instance to create the popup component..

Parameters:

P_popupComponent -

getPopupComponent

public javax.swing.JComponent getPopupComponent()

The component which is displayed in

Returns:

Returns the popupComponent.

getSelectedValueFromPopup

protected abstract java.lang.Object getSelectedValueFromPopup()

Must be implementet to know how to get the component value from popup. This is the value which is used to display the value, too.

Returns:

getItemString

protected java.lang.String getItemString(java.lang.Object P_item)

override this method to display the selected object different to the default implementation.

Parameters:

P_item - the object which will be displayed - e.g. the selected object.

Returns:

isTogglePopupOnEachField

public boolean isTogglePopupOnEachField()

Returns:

Returns the togglePopupOnEachField.

setTogglePopupOnEachField

public void setTogglePopupOnEachField(boolean togglePopupOnEachField)

Parameters:

togglePopupOnEachField - The togglePopupOnEachField to set.