net.sf.sbcc.componentcombo.plaf.basic
Interface ComponentComboPopup

All Known Implementing Classes:
BasicComponentComboPopup, MetalComponentComboBoxUI.MetalComboPopup, MotifComponentComboBoxUI.MotifComboPopup

public interface ComponentComboPopup

The interface which defines the methods required for the implementation of the popup portion of a abstract combo box. This combo box is NOT based on

Warning: Serialized objects of this class will not be compatible with future Swing releases. The current serialization support is appropriate for short term storage or RMI between applications running the same version of Swing. As of 1.4, support for long term storage of all JavaBeansTM has been added to the java.beans package. Please see XMLEncoder.

Version:
1.0
Author:
Christoph Bimminger

Method Summary
 javax.swing.JComponent getComponent()
          Returns the list that is being used to draw the items in the combo box.
 java.awt.event.KeyListener getKeyListener()
          Returns a key listener that will be added to the combo box or null.
 java.awt.event.MouseListener getMouseListener()
          Returns a mouse listener that will be added to the combo box or null.
 java.awt.event.MouseMotionListener getMouseMotionListener()
          Returns a mouse motion listener that will be added to the combo box or null.
 void hide()
          Hides the popup
 boolean isVisible()
          Returns true if the popup is visible (currently being displayed).
 void show()
          Shows the popup
 void uninstallingUI()
          Called to inform the ComboPopup that the UI is uninstalling.
 

Method Detail

show

void show()
Shows the popup


hide

void hide()
Hides the popup


isVisible

boolean isVisible()
Returns true if the popup is visible (currently being displayed).

Returns:
true if the component is visible; false otherwise.

getComponent

javax.swing.JComponent getComponent()
Returns the list that is being used to draw the items in the combo box. This method is highly implementation specific and should not be used for general list manipulation.


getMouseListener

java.awt.event.MouseListener getMouseListener()
Returns a mouse listener that will be added to the combo box or null. If this method returns null then it will not be added to the combo box.

Returns:
a MouseListener or null

getMouseMotionListener

java.awt.event.MouseMotionListener getMouseMotionListener()
Returns a mouse motion listener that will be added to the combo box or null. If this method returns null then it will not be added to the combo box.

Returns:
a MouseMotionListener or null

getKeyListener

java.awt.event.KeyListener getKeyListener()
Returns a key listener that will be added to the combo box or null. If this method returns null then it will not be added to the combo box.


uninstallingUI

void uninstallingUI()
Called to inform the ComboPopup that the UI is uninstalling. If the ComboPopup added any listeners in the component, it should remove them here.