class:BasicComboBoxUI [NONE]

Direct Known Subclasses:: MetalComboBoxUI, SynthComboBoxUI

public class BasicComboBoxUI
extends ComboBoxUI

Basic UI implementation for JComboBox.

The combo box is a compound component which means that it is an aggregate of many simpler components. This class creates and manages the listeners on the combo box and the combo box model. These listeners update the user interface in response to changes in the properties and state of the combo box.

All event handling is handled by listener classes created with the createxxxListener() methods and internal classes. You can change the behavior of this class by overriding the createxxxListener() methods and supplying your own event listeners or subclassing from the ones supplied in this class.

For adding specific actions, overide installKeyboardActions to add actions in response to KeyStroke bindings. See the article How to Use Key Bindings

field:comboBox [NONE]

comboBox

protected JComboBox<Object> comboBox

The instance of JComboBox.

field:hasFocus [NONE]

hasFocus

protected boolean hasFocus

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

field:listBox [NONE]

listBox

protected JList<Object> listBox

This list is for drawing the current item in the combo box.

field:currentValuePane [NONE]

currentValuePane

protected CellRendererPane currentValuePane

Used to render the currently selected item in the combo box. It doesn't have anything to do with the popup's rendering.

field:popup [NONE]

popup

protected ComboPopup popup

The implementation of ComboPopup that is used to show the popup.

field:editor [NONE]

editor

protected Component editor

The Component that the @{code ComboBoxEditor} uses for editing.

field:arrowButton [NONE]

arrowButton

protected JButton arrowButton

The arrow button that invokes the popup.

field:keyListener [NONE]

keyListener

protected KeyListener keyListener

This protected field is implementation specific. Do not access directly or override. Override the listener construction method instead.

See Also:: createKeyListener()

field:focusListener [NONE]

focusListener

protected FocusListener focusListener

This protected field is implementation specific. Do not access directly or override. Override the listener construction method instead.

See Also:: createFocusListener()

field:propertyChangeListener [NONE]

propertyChangeListener

protected PropertyChangeListener propertyChangeListener

This protected field is implementation specific. Do not access directly or override. Override the listener construction method instead.

See Also:: createPropertyChangeListener()

field:itemListener [NONE]

itemListener

protected ItemListener itemListener

This protected field is implementation specific. Do not access directly or override. Override the listener construction method instead.

See Also:: createItemListener()

field:popupMouseListener [NONE]

popupMouseListener

protected MouseListener popupMouseListener

The MouseListener listens to events.

field:popupMouseMotionListener [NONE]

popupMouseMotionListener

protected MouseMotionListener popupMouseMotionListener

The MouseMotionListener listens to events.

field:popupKeyListener [NONE]

popupKeyListener

protected KeyListener popupKeyListener

The KeyListener listens to events.

field:listDataListener [NONE]

listDataListener

protected ListDataListener listDataListener

This protected field is implementation specific. Do not access directly or override. Override the listener construction method instead.

See Also:: createListDataListener()

field:isMinimumSizeDirty [NONE]

isMinimumSizeDirty

protected boolean isMinimumSizeDirty

The flag for recalculating the minimum preferred size.

field:cachedMinimumSize [NONE]

cachedMinimumSize

protected Dimension cachedMinimumSize

The cached minimum preferred size.

field:squareButton [NONE]

squareButton

protected boolean squareButton

Indicates whether or not the combo box button should be square. If square, then the width and height are equal, and are both set to the height of the combo minus appropriate insets.

Since:: 1.7

field:padding [NONE]

padding

protected Insets padding

If specified, these insets act as padding around the cell renderer when laying out and painting the "selected" item in the combo box. These insets add to those specified by the cell renderer.

Since:: 1.7

constructor:BasicComboBoxUI() [NONE]

BasicComboBoxUI

public BasicComboBoxUI()

method:createUI(javax.swing.JComponent) [NONE]

createUI

public static ComponentUI createUI?(JComponent c)

Constructs a new instance of BasicComboBoxUI.

Parameters:: c - a component
Returns:: a new instance of BasicComboBoxUI

method:installUI(javax.swing.JComponent) [NONE]

installUI

public void installUI?(JComponent c)

Description copied from class: ComponentUI

Configures the specified component appropriately for the look and feel. This method is invoked when the ComponentUI instance is being installed as the UI delegate on the specified component. This method should completely configure the component for the look and feel, including the following:

Install default property values for color, fonts, borders, icons, opacity, etc. on the component. Whenever possible, property values initialized by the client program should not be overridden.
Install a LayoutManager on the component if necessary.
Create/add any required sub-components to the component.
Create/install event listeners on the component.
Create/install a PropertyChangeListener on the component in order to detect and respond to component property changes appropriately.
Install keyboard UI (mnemonics, traversal, etc.) on the component.
Initialize any appropriate instance data.

Overrides:: installUI in class ComponentUI
Parameters:: c - the component where this UI delegate is being installed
See Also:: ComponentUI.uninstallUI(javax.swing.JComponent), JComponent.setUI(javax.swing.plaf.ComponentUI), JComponent.updateUI()

method:uninstallUI(javax.swing.JComponent) [NONE]

uninstallUI

public void uninstallUI?(JComponent c)

Description copied from class: ComponentUI

Reverses configuration which was done on the specified component during installUI. This method is invoked when this UIComponent instance is being removed as the UI delegate for the specified component. This method should undo the configuration performed in installUI, being careful to leave the JComponent instance in a clean state (no extraneous listeners, look-and-feel-specific property objects, etc.). This should include the following:

Remove any UI-set borders from the component.
Remove any UI-set layout managers on the component.
Remove any UI-added sub-components from the component.
Remove any UI-added event/property listeners from the component.
Remove any UI-installed keyboard UI from the component.
Nullify any allocated instance data objects to allow for GC.

Overrides:: uninstallUI in class ComponentUI
Parameters:: c - the component from which this UI delegate is being removed; this argument is often ignored, but might be used if the UI object is stateless and shared by multiple components
See Also:: ComponentUI.installUI(javax.swing.JComponent), JComponent.updateUI()

method:installDefaults() [NONE]

installDefaults

protected void installDefaults()

Installs the default colors, default font, default renderer, and default editor into the JComboBox.

method:installListeners() [NONE]

installListeners

protected void installListeners()

Creates and installs listeners for the combo box and its model. This method is called when the UI is installed.

method:uninstallDefaults() [NONE]

uninstallDefaults

protected void uninstallDefaults()

Uninstalls the default colors, default font, default renderer, and default editor from the combo box.

method:uninstallListeners() [NONE]

uninstallListeners

protected void uninstallListeners()

Removes the installed listeners from the combo box and its model. The number and types of listeners removed and in this method should be the same that was added in installListeners

method:createPopup() [NONE]

createPopup

protected ComboPopup createPopup()

Creates the popup portion of the combo box.

Returns:: an instance of ComboPopup
See Also:: ComboPopup

method:createKeyListener() [NONE]

createKeyListener

protected KeyListener createKeyListener()

Creates a KeyListener which will be added to the combo box. If this method returns null then it will not be added to the combo box.

Returns:: an instance KeyListener or null

method:createFocusListener() [NONE]

createFocusListener

protected FocusListener createFocusListener()

Creates a FocusListener which will be added to the combo box. If this method returns null then it will not be added to the combo box.

Returns:: an instance of a FocusListener or null

method:createListDataListener() [NONE]

createListDataListener

protected ListDataListener createListDataListener()

Creates a list data listener which will be added to the ComboBoxModel. If this method returns null then it will not be added to the combo box model.

Returns:: an instance of a ListDataListener or null

method:createItemListener() [NONE]

createItemListener

protected ItemListener createItemListener()

Creates an ItemListener which will be added to the combo box. If this method returns null then it will not be added to the combo box.

Subclasses may override this method to return instances of their own ItemEvent handlers.

Returns:: an instance of an ItemListener or null

method:createPropertyChangeListener() [NONE]

createPropertyChangeListener

protected PropertyChangeListener createPropertyChangeListener()

Creates a PropertyChangeListener which will be added to the combo box. If this method returns null then it will not be added to the combo box.

Returns:: an instance of a PropertyChangeListener or null

method:createLayoutManager() [NONE]

createLayoutManager

protected LayoutManager createLayoutManager()

Creates a layout manager for managing the components which make up the combo box.

Returns:: an instance of a layout manager

method:createRenderer() [NONE]

createRenderer

protected ListCellRenderer<Object> createRenderer()

Creates the default renderer that will be used in a non-editiable combo box. A default renderer will used only if a renderer has not been explicitly set with setRenderer.

Returns:: a ListCellRender used for the combo box
See Also:: JComboBox.setRenderer(javax.swing.ListCellRenderer<? super E>)

method:createEditor() [NONE]

createEditor

protected ComboBoxEditor createEditor()

Creates the default editor that will be used in editable combo boxes. A default editor will be used only if an editor has not been explicitly set with setEditor.

Returns:: a ComboBoxEditor used for the combo box
See Also:: JComboBox.setEditor(javax.swing.ComboBoxEditor)

method:installComponents() [NONE]

installComponents

protected void installComponents()

Creates and initializes the components which make up the aggregate combo box. This method is called as part of the UI installation process.

method:uninstallComponents() [NONE]

uninstallComponents

protected void uninstallComponents()

The aggregate components which comprise the combo box are unregistered and uninitialized. This method is called as part of the UI uninstallation process.

method:addEditor() [NONE]

addEditor

public void addEditor()

This public method is implementation specific and should be private. do not call or override. To implement a specific editor create a custom ComboBoxEditor

See Also:: createEditor(), JComboBox.setEditor(javax.swing.ComboBoxEditor), ComboBoxEditor

method:removeEditor() [NONE]

removeEditor

public void removeEditor()

This public method is implementation specific and should be private. do not call or override.

See Also:: addEditor()

method:configureEditor() [NONE]

configureEditor

protected void configureEditor()

This protected method is implementation specific and should be private. do not call or override.

See Also:: addEditor()

method:unconfigureEditor() [NONE]

unconfigureEditor

protected void unconfigureEditor()

This protected method is implementation specific and should be private. Do not call or override.

See Also:: addEditor()

method:configureArrowButton() [NONE]

configureArrowButton

public void configureArrowButton()

This public method is implementation specific and should be private. Do not call or override.

See Also:: createArrowButton()

method:unconfigureArrowButton() [NONE]

unconfigureArrowButton

public void unconfigureArrowButton()

This public method is implementation specific and should be private. Do not call or override.

See Also:: createArrowButton()

method:createArrowButton() [NONE]

createArrowButton

protected JButton createArrowButton()

Creates a button which will be used as the control to show or hide the popup portion of the combo box.

Returns:: a button which represents the popup control

method:isPopupVisible(javax.swing.JComboBox) [NONE]

isPopupVisible

public boolean isPopupVisible?(JComboBox<?> c)

Tells if the popup is visible or not.

Specified by:: isPopupVisible in class ComboBoxUI
Parameters:: c - a JComboBox
Returns:: true if popup of the JComboBox is visible

method:setPopupVisible(javax.swing.JComboBox,boolean) [NONE]

setPopupVisible

public void setPopupVisible?(JComboBox<?> c, boolean v)

Hides the popup.

Specified by:: setPopupVisible in class ComboBoxUI
Parameters:: c - a JComboBox; v - a boolean determining the visibilty of the popup

method:isFocusTraversable(javax.swing.JComboBox) [NONE]

isFocusTraversable

public boolean isFocusTraversable?(JComboBox<?> c)

Determines if the JComboBox is focus traversable. If the JComboBox is editable this returns false, otherwise it returns true.

Specified by:: isFocusTraversable in class ComboBoxUI
Parameters:: c - a JComboBox
Returns:: true if the given JComboBox is traversable

method:paint(java.awt.Graphics,javax.swing.JComponent) [NONE]

paint

public void paint?(Graphics g, JComponent c)

Description copied from class: ComponentUI

Paints the specified component appropriately for the look and feel. This method is invoked from the ComponentUI.update method when the specified component is being painted. Subclasses should override this method and use the specified Graphics object to render the content of the component.

Overrides:: paint in class ComponentUI
Parameters:: g - the Graphics context in which to paint; c - the component being painted; this argument is often ignored, but might be used if the UI object is stateless and shared by multiple components
See Also:: ComponentUI.update(java.awt.Graphics, javax.swing.JComponent)

method:getPreferredSize(javax.swing.JComponent) [NONE]

getPreferredSize

public Dimension getPreferredSize?(JComponent c)

Description copied from class: ComponentUI

Returns the specified component's preferred size appropriate for the look and feel. If null is returned, the preferred size will be calculated by the component's layout manager instead (this is the preferred approach for any component with a specific layout manager installed). The default implementation of this method returns null.

Overrides:: getPreferredSize in class ComponentUI
Parameters:: c - the component whose preferred size is being queried; this argument is often ignored, but might be used if the UI object is stateless and shared by multiple components
Returns:: a Dimension object containing given component's preferred size appropriate for the look and feel
See Also:: JComponent.getPreferredSize(), LayoutManager.preferredLayoutSize(java.awt.Container)

method:getMinimumSize(javax.swing.JComponent) [NONE]

getMinimumSize

public Dimension getMinimumSize?(JComponent c)

The minimum size is the size of the display area plus insets plus the button.

Overrides:: getMinimumSize in class ComponentUI
Parameters:: c - the component whose minimum size is being queried; this argument is often ignored, but might be used if the UI object is stateless and shared by multiple components
Returns:: a Dimension object or null
See Also:: JComponent.getMinimumSize(), LayoutManager.minimumLayoutSize(java.awt.Container), ComponentUI.getPreferredSize(javax.swing.JComponent)

method:getMaximumSize(javax.swing.JComponent) [NONE]

getMaximumSize

public Dimension getMaximumSize?(JComponent c)

Description copied from class: ComponentUI

Returns the specified component's maximum size appropriate for the look and feel. If null is returned, the maximum size will be calculated by the component's layout manager instead (this is the preferred approach for any component with a specific layout manager installed). The default implementation of this method invokes getPreferredSize and returns that value.

Overrides:: getMaximumSize in class ComponentUI
Parameters:: c - the component whose maximum size is being queried; this argument is often ignored, but might be used if the UI object is stateless and shared by multiple components
Returns:: a Dimension object or null
See Also:: JComponent.getMaximumSize(), LayoutManager2.maximumLayoutSize(java.awt.Container)

method:getBaseline(javax.swing.JComponent,int,int) [NONE]

getBaseline

public int getBaseline?(JComponent c, int width, int height)

Returns the baseline.

Overrides:: getBaseline in class ComponentUI
Parameters:: c - JComponent baseline is being requested for; width - the width to get the baseline for; height - the height to get the baseline for
Returns:: baseline or a value < 0 indicating there is no reasonable baseline
Throws:: NullPointerException - if c is null; IllegalArgumentException - if width or height is < 0
Since:: 1.6
See Also:: JComponent.getBaseline(int, int)

method:getBaselineResizeBehavior(javax.swing.JComponent) [NONE]

getBaselineResizeBehavior

public Component.BaselineResizeBehavior getBaselineResizeBehavior?(JComponent c)

Returns an enum indicating how the baseline of the component changes as the size changes.

Overrides:: getBaselineResizeBehavior in class ComponentUI
Parameters:: c - JComponent to return baseline resize behavior for
Returns:: an enum indicating how the baseline changes as the component size changes
Throws:: NullPointerException - if c is null
Since:: 1.6
See Also:: JComponent.getBaseline(int, int)

method:getAccessibleChildrenCount(javax.swing.JComponent) [NONE]

getAccessibleChildrenCount

public int getAccessibleChildrenCount?(JComponent c)

Description copied from class: ComponentUI

Returns the number of accessible children in the object. If all of the children of this object implement Accessible, this method should return the number of children of this object. UIs might wish to override this if they present areas on the screen that can be viewed as components, but actual components are not used for presenting those areas. Note: As of v1.3, it is recommended that developers call Component.AccessibleAWTComponent.getAccessibleChildrenCount() instead of this method.

Overrides:: getAccessibleChildrenCount in class ComponentUI
Parameters:: c - JComponent for which to get count of accessible children
Returns:: the number of accessible children in the object
See Also:: ComponentUI.getAccessibleChild(javax.swing.JComponent, int)

method:getAccessibleChild(javax.swing.JComponent,int) [NONE]

getAccessibleChild

public Accessible getAccessibleChild?(JComponent c, int i)

Description copied from class: ComponentUI

Returns the ith Accessible child of the object. UIs might need to override this if they present areas on the screen that can be viewed as components, but actual components are not used for presenting those areas.

Note: As of v1.3, it is recommended that developers call Component.AccessibleAWTComponent.getAccessibleChild() instead of this method.

Overrides:: getAccessibleChild in class ComponentUI
Parameters:: c - a JComponent for which to get a child object; i - zero-based index of child
Returns:: the ith Accessible child of the object
See Also:: ComponentUI.getAccessibleChildrenCount(javax.swing.JComponent)

method:isNavigationKey(int) [NONE]

isNavigationKey

protected boolean isNavigationKey?(int keyCode)

Returns whether or not the supplied keyCode maps to a key that is used for navigation. This is used for optimizing key input by only passing non- navigation keys to the type-ahead mechanism. Subclasses should override this if they change the navigation keys.

Parameters:: keyCode - a key code
Returns:: true if the supplied keyCode maps to a navigation key

method:selectNextPossibleValue() [NONE]

selectNextPossibleValue

protected void selectNextPossibleValue()

Selects the next item in the list. It won't change the selection if the currently selected item is already the last item.

method:selectPreviousPossibleValue() [NONE]

selectPreviousPossibleValue

protected void selectPreviousPossibleValue()

Selects the previous item in the list. It won't change the selection if the currently selected item is already the first item.

method:toggleOpenClose() [NONE]

toggleOpenClose

protected void toggleOpenClose()

Hides the popup if it is showing and shows the popup if it is hidden.

method:rectangleForCurrentValue() [NONE]

rectangleForCurrentValue

protected Rectangle rectangleForCurrentValue()

Returns the area that is reserved for drawing the currently selected item.

Returns:: the area that is reserved for drawing the currently selected item

method:getInsets() [NONE]

getInsets

protected Insets getInsets()

Gets the insets from the JComboBox.

Returns:: the insets

method:paintCurrentValue(java.awt.Graphics,java.awt.Rectangle,boolean) [NONE]

paintCurrentValue

public void paintCurrentValue?(Graphics g, Rectangle bounds, boolean hasFocus)

Paints the currently selected item.

Parameters:: g - an instance of Graphics; bounds - a bounding rectangle to render to; hasFocus - is focused

method:paintCurrentValueBackground(java.awt.Graphics,java.awt.Rectangle,boolean) [NONE]

paintCurrentValueBackground

public void paintCurrentValueBackground?(Graphics g, Rectangle bounds, boolean hasFocus)

Paints the background of the currently selected item.

Parameters:: g - an instance of Graphics; bounds - a bounding rectangle to render to; hasFocus - is focused

method:getDefaultSize() [NONE]

getDefaultSize

protected Dimension getDefaultSize()

Return the default size of an empty display area of the combo box using the current renderer and font.

Returns:: the size of an empty display area
See Also:: getDisplaySize()

method:getDisplaySize() [NONE]

getDisplaySize

protected Dimension getDisplaySize()

Returns the calculated size of the display area. The display area is the portion of the combo box in which the selected item is displayed. This method will use the prototype display value if it has been set.

For combo boxes with a non trivial number of items, it is recommended to use a prototype display value to significantly speed up the display size calculation.

Returns:: the size of the display area calculated from the combo box items
See Also:: JComboBox.setPrototypeDisplayValue(E)

method:getSizeForComponent(java.awt.Component) [NONE]

getSizeForComponent

protected Dimension getSizeForComponent?(Component comp)

Returns the size a component would have if used as a cell renderer.

Parameters:: comp - a Component to check
Returns:: size of the component
Since:: 1.7

method:installKeyboardActions() [NONE]

installKeyboardActions

protected void installKeyboardActions()

Adds keyboard actions to the JComboBox. Actions on enter and esc are already supplied. Add more actions as you need them.

method:uninstallKeyboardActions() [NONE]

uninstallKeyboardActions

protected void uninstallKeyboardActions()

Removes the focus InputMap and ActionMap.