javax.swing.JComboBox — clojure-interop/javax.swing 1.0.5

A component that combines a button or editable field and a drop-down list. The user can select a value from the drop-down list, which appears at the user's request. If you make the combo box editable, then the combo box includes an editable field into which the user can type a value.

Warning: Swing is not thread safe. For more information see Swing's Threading Policy.

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 JavaBeans™ has been added to the java.beans package. Please see XMLEncoder.

See How to Use Combo Boxes in The Java Tutorial for further information.

->j-combo-box clj

(->j-combo-box)

(->j-combo-box a-model)

Constructor.

Creates a JComboBox that takes its items from an existing ComboBoxModel. Since the ComboBoxModel is provided, a combo box created using this constructor does not create a default combo box model and may impact how the insert, remove and add methods behave.

a-model - the ComboBoxModel that provides the displayed list of items - javax.swing.ComboBoxModel

action-performed clj

(action-performed this e)

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

e - java.awt.event.ActionEvent

add-action-listener clj

(add-action-listener this 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.

l - the ActionListener that is to be notified - java.awt.event.ActionListener

add-item clj

(add-item this item)

Adds an item to the item list. This method works only if the JComboBox uses a mutable data model.

Warning: Focus and keyboard navigation problems may arise if you add duplicate String objects. A workaround is to add new objects instead of String objects and make sure that the toString() method is defined. For example:

comboBox.addItem(makeObj("Item 1")); comboBox.addItem(makeObj("Item 1")); ... private Object makeObj(final String item) { return new Object() { public String toString() { return item; } }; }

item - the item to add to the list - E

add-item-listener clj

(add-item-listener this a-listener)

Adds an ItemListener.

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

a-listener - the ItemListener that is to be notified - java.awt.event.ItemListener

add-popup-menu-listener clj

(add-popup-menu-listener this 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, 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.

l - the PopupMenuListener to add - javax.swing.event.PopupMenuListener

configure-editor clj

(configure-editor this an-editor an-item)

Initializes the editor with the specified item.

an-editor - the ComboBoxEditor that displays the list item in the combo box field and allows it to be edited - javax.swing.ComboBoxEditor an-item - the object to display and edit in the field - java.lang.Object

contents-changed clj

(contents-changed this e)

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

e - a ListDataEvent encapsulating the event information - javax.swing.event.ListDataEvent

editable? clj

(editable? this)

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

returns: true if the JComboBox is editable, else false - boolean

fire-popup-menu-canceled clj

(fire-popup-menu-canceled this)

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.

fire-popup-menu-will-become-invisible clj

(fire-popup-menu-will-become-invisible this)

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.

fire-popup-menu-will-become-visible clj

(fire-popup-menu-will-become-visible this)

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.

get-accessible-context clj

(get-accessible-context this)

Gets the AccessibleContext associated with this JComboBox. For combo boxes, the AccessibleContext takes the form of an AccessibleJComboBox. A new AccessibleJComboBox instance is created if necessary.

returns: an AccessibleJComboBox that serves as the AccessibleContext of this JComboBox - javax.accessibility.AccessibleContext

get-action clj

(get-action this)

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 - javax.swing.Action

get-action-command clj

(get-action-command this)

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. - java.lang.String

get-action-listeners clj

(get-action-listeners this)

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 - java.awt.event.ActionListener[]

get-editor clj

(get-editor this)

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

returns: the ComboBoxEditor that displays the selected item - javax.swing.ComboBoxEditor

get-item-at clj

(get-item-at this index)

Returns the list item at the specified index. If index is out of range (less than zero or greater than or equal to size) it will return null.

index - an integer indicating the list position, where the first item starts at zero - int

returns: the item at that list position; or null if out of range - E

get-item-count clj

(get-item-count this)

Returns the number of items in the list.

returns: an integer equal to the number of items in the list - int

get-item-listeners clj

(get-item-listeners this)

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 - java.awt.event.ItemListener[]

get-key-selection-manager clj

(get-key-selection-manager this)

Returns the list's key-selection manager.

returns: the KeySelectionManager currently in use - javax.swing.JComboBox$KeySelectionManager

get-maximum-row-count clj

(get-maximum-row-count this)

Returns the maximum number of items the combo box can display without a scrollbar

returns: an integer specifying the maximum number of items that are displayed in the list before using a scrollbar - int

get-model clj

(get-model this)

Returns the data model currently used by the JComboBox.

returns: the ComboBoxModel that provides the displayed list of items - javax.swing.ComboBoxModel<E>

get-popup-menu-listeners clj

(get-popup-menu-listeners this)

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 - javax.swing.event.PopupMenuListener[]

get-prototype-display-value clj

(get-prototype-display-value this)

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

returns: the value of the prototypeDisplayValue property - E

get-renderer clj

(get-renderer this)

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

returns: the ListCellRenderer that displays the selected item. - javax.swing.ListCellRenderer<? super E>

get-selected-index clj

(get-selected-index this)

Returns the first item in the list that matches the given item. The result is not always defined if the JComboBox allows selected items that are not in the list. Returns -1 if there is no selected item or if the user specified an item which is not in the list.

returns: an integer specifying the currently selected list item, where 0 specifies the first item in the list; or -1 if no item is selected or if the currently selected item is not in the list - int

get-selected-item clj

(get-selected-item this)

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 - java.lang.Object

get-selected-objects clj

(get-selected-objects this)

Returns an array containing the selected item. This method is implemented for compatibility with ItemSelectable.

returns: an array of Objects containing one element -- the selected item - java.lang.Object[]

get-ui clj

(get-ui this)

Returns the L&F object that renders this component.

returns: the ComboBoxUI object that renders this component - javax.swing.plaf.ComboBoxUI

get-ui-class-id clj

(get-ui-class-id this)

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

returns: the string "ComboBoxUI" - java.lang.String

hide-popup clj

(hide-popup this)

Causes the combo box to close its popup window.

insert-item-at clj

(insert-item-at this item index)

Inserts an item into the item list at a given index. This method works only if the JComboBox uses a mutable data model.

item - the item to add to the list - E index - an integer specifying the position at which to add the item - int

interval-added clj

(interval-added this e)

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

e - a ListDataEvent encapsulating the event information - javax.swing.event.ListDataEvent

interval-removed clj

(interval-removed this e)

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

e - a ListDataEvent encapsulating the event information - javax.swing.event.ListDataEvent

light-weight-popup-enabled? clj

(light-weight-popup-enabled? this)

Gets the value of the lightWeightPopupEnabled property.

returns: the value of the lightWeightPopupEnabled property - boolean

popup-visible? clj

(popup-visible? this)

Determines the visibility of the popup.

returns: true if the popup is visible, otherwise returns false - boolean

process-key-event clj

(process-key-event this e)

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

e - the KeyEvent containing the keyboard key that was pressed - java.awt.event.KeyEvent

remove-action-listener clj

(remove-action-listener this l)

Removes an ActionListener.

l - the ActionListener to remove - java.awt.event.ActionListener

remove-all-items clj

(remove-all-items this)

Removes all items from the item list.

remove-item clj

(remove-item this an-object)

Removes an item from the item list. This method works only if the JComboBox uses a mutable data model.

an-object - the object to remove from the item list - java.lang.Object

remove-item-at clj

(remove-item-at this an-index)

Removes the item at anIndex This method works only if the JComboBox uses a mutable data model.

an-index - an int specifying the index of the item to remove, where 0 indicates the first item in the list - int

remove-item-listener clj

(remove-item-listener this a-listener)

Removes an ItemListener.

a-listener - the ItemListener to remove - java.awt.event.ItemListener

remove-popup-menu-listener clj

(remove-popup-menu-listener this l)

Removes a PopupMenuListener.

l - the PopupMenuListener to remove - javax.swing.event.PopupMenuListener

select-with-key-char clj

(select-with-key-char this key-char)

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.

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

returns: boolean

set-action clj

(set-action this 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.

Setting the Action results in immediately changing all the properties described in Swing Components Supporting Action. Subsequently, the combobox's properties are automatically updated as the Action's properties change.

This method uses three other methods to set and help track the Action's property values. It uses the configurePropertiesFromAction method to immediately change the combobox's properties. To track changes in the Action's property values, this method registers the PropertyChangeListener returned by createActionPropertyChangeListener. The default PropertyChangeListener invokes the actionPropertyChanged method when a property in the Action changes.

a - the Action for the JComboBox, or null. - javax.swing.Action

set-action-command clj

(set-action-command this a-command)

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

a-command - 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 - java.lang.String

set-editable clj

(set-editable this a-flag)

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.

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

set-editor clj

(set-editor this an-editor)

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.

an-editor - the ComboBoxEditor that displays the selected item - javax.swing.ComboBoxEditor

set-enabled clj

(set-enabled this 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).

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

set-key-selection-manager clj

(set-key-selection-manager this a-manager)

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.

a-manager - javax.swing.JComboBox$KeySelectionManager

set-light-weight-popup-enabled clj

(set-light-weight-popup-enabled this a-flag)

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 This method fires a property changed event.

a-flag - if true, lightweight popups are desired - boolean

set-maximum-row-count clj

(set-maximum-row-count this count)

Sets the maximum number of rows the JComboBox displays. If the number of objects in the model is greater than count, the combo box uses a scrollbar.

count - an integer specifying the maximum number of items to display in the list before using a scrollbar - int

set-model clj

(set-model this a-model)

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

a-model - the ComboBoxModel that provides the displayed list of items - javax.swing.ComboBoxModel

set-popup-visible clj

(set-popup-visible this v)

Sets the visibility of the popup.

v - boolean

set-prototype-display-value clj

(set-prototype-display-value this prototype-display-value)

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.

prototype-display-value - E

set-renderer clj

(set-renderer this a-renderer)

Sets the renderer that paints the list items and 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.

a-renderer - the ListCellRenderer that displays the selected item - javax.swing.ListCellRenderer

set-selected-index clj

(set-selected-index this an-index)

Selects the item at index anIndex.

an-index - an integer specifying the list item to select, where 0 specifies the first item in the list and -1 indicates no selection - int

throws: java.lang.IllegalArgumentException - if anIndex < -1 or anIndex is greater than or equal to size

set-selected-item clj

(set-selected-item this an-object)

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.

an-object - the list object to select; use null to clear the selection - java.lang.Object

set-ui clj

(set-ui this ui)

Sets the L&F object that renders this component.

ui - the ComboBoxUI L&F object - javax.swing.plaf.ComboBoxUI

show-popup clj

(show-popup this)

Causes the combo box to display its popup window.

update-ui clj

(update-ui this)

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