| Method from javax.swing.JComboBox Detail: |
public void actionPerformed(ActionEvent e) {
Object newItem = getEditor().getItem();
setPopupVisible(false);
getModel().setSelectedItem(newItem);
String oldCommand = getActionCommand();
setActionCommand("comboBoxEdited");
fireActionEvent();
setActionCommand(oldCommand);
}
This method is public as an implementation side effect.
do not call or override. |
protected void actionPropertyChanged(Action action,
String propertyName) {
if (propertyName == Action.ACTION_COMMAND_KEY) {
setActionCommandFromAction(action);
} else if (propertyName == "enabled") {
AbstractAction.setEnabledFromAction(this, action);
} else if (Action.SHORT_DESCRIPTION == propertyName) {
AbstractAction.setToolTipTextFromAction(this, action);
}
}
Updates the combobox's state in response to property changes in
associated action. This method is invoked from the
{@code PropertyChangeListener} returned from
{@code createActionPropertyChangeListener}. Subclasses do not normally
need to invoke this. Subclasses that support additional {@code Action}
properties should override this and
{@code configurePropertiesFromAction}.
Refer to the table at
Swing Components Supporting Action for a list of
the properties this method sets. |
public void addActionListener(ActionListener l) {
listenerList.add(ActionListener.class,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. |
public void addItem(Object anObject) {
checkMutableComboBoxModel();
((MutableComboBoxModel)dataModel).addElement(anObject);
}
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; } };
}
|
public void addItemListener(ItemListener aListener) {
listenerList.add(ItemListener.class,aListener);
}
|
public void addPopupMenuListener(PopupMenuListener l) {
listenerList.add(PopupMenuListener.class,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. |
void checkMutableComboBoxModel() {
if ( !(dataModel instanceof MutableComboBoxModel) )
throw new RuntimeException("Cannot use this method with a non-Mutable data model.");
}
Checks that the dataModel is an instance of
MutableComboBoxModel. If not, it throws an exception. |
public void configureEditor(ComboBoxEditor anEditor,
Object anItem) {
anEditor.setItem(anItem);
}
Initializes the editor with the specified item. |
protected void configurePropertiesFromAction(Action a) {
AbstractAction.setEnabledFromAction(this, a);
AbstractAction.setToolTipTextFromAction(this, a);
setActionCommandFromAction(a);
}
Sets the properties on this combobox to match those in the specified
Action. Refer to
Swing Components Supporting Action for more
details as to which properties this sets. |
public void contentsChanged(ListDataEvent e) {
Object oldSelection = selectedItemReminder;
Object newSelection = dataModel.getSelectedItem();
if (oldSelection == null || !oldSelection.equals(newSelection)) {
selectedItemChanged();
if (!selectingItem) {
fireActionEvent();
}
}
}
This method is public as an implementation side effect.
do not call or override. |
protected PropertyChangeListener createActionPropertyChangeListener(Action a) {
return new ComboBoxActionPropertyChangeListener(this, a);
}
Creates and returns a PropertyChangeListener that is
responsible for listening for changes from the specified
Action and updating the appropriate properties.
Warning: If you subclass this do not create an anonymous
inner class. If you do the lifetime of the combobox will be tied to
that of the Action. |
protected JComboBox.KeySelectionManager createDefaultKeySelectionManager() {
return new DefaultKeySelectionManager();
}
Returns an instance of the default key-selection manager. |
protected void fireActionEvent() {
if (!firingActionEvent) {
// Set flag to ensure that an infinite loop is not created
firingActionEvent = true;
ActionEvent e = null;
// Guaranteed to return a non-null array
Object[] listeners = listenerList.getListenerList();
long mostRecentEventTime = EventQueue.getMostRecentEventTime();
int modifiers = 0;
AWTEvent currentEvent = EventQueue.getCurrentEvent();
if (currentEvent instanceof InputEvent) {
modifiers = ((InputEvent)currentEvent).getModifiers();
} else if (currentEvent instanceof ActionEvent) {
modifiers = ((ActionEvent)currentEvent).getModifiers();
}
// Process the listeners last to first, notifying
// those that are interested in this event
for ( int i = listeners.length-2; i >=0; i-=2 ) {
if ( listeners[i]==ActionListener.class ) {
// Lazily create the event:
if ( e == null )
e = new ActionEvent(this,ActionEvent.ACTION_PERFORMED,
getActionCommand(),
mostRecentEventTime, modifiers);
((ActionListener)listeners[i+1]).actionPerformed(e);
}
}
firingActionEvent = false;
}
}
Notifies all listeners that have registered interest for
notification on this event type. |
protected void fireItemStateChanged(ItemEvent e) {
// Guaranteed to return a non-null array
Object[] listeners = listenerList.getListenerList();
// Process the listeners last to first, notifying
// those that are interested in this event
for ( int i = listeners.length-2; i >=0; i-=2 ) {
if ( listeners[i]==ItemListener.class ) {
// Lazily create the event:
// if (changeEvent == null)
// changeEvent = new ChangeEvent(this);
((ItemListener)listeners[i+1]).itemStateChanged(e);
}
}
}
Notifies all listeners that have registered interest for
notification on this event type. |
public void firePopupMenuCanceled() {
Object[] listeners = listenerList.getListenerList();
PopupMenuEvent e=null;
for (int i = listeners.length-2; i >=0; i-=2) {
if (listeners[i]==PopupMenuListener.class) {
if (e == null)
e = new PopupMenuEvent(this);
((PopupMenuListener)listeners[i+1]).popupMenuCanceled(e);
}
}
}
|
public void firePopupMenuWillBecomeInvisible() {
Object[] listeners = listenerList.getListenerList();
PopupMenuEvent e=null;
for (int i = listeners.length-2; i >=0; i-=2) {
if (listeners[i]==PopupMenuListener.class) {
if (e == null)
e = new PopupMenuEvent(this);
((PopupMenuListener)listeners[i+1]).popupMenuWillBecomeInvisible(e);
}
}
}
|
public void firePopupMenuWillBecomeVisible() {
Object[] listeners = listenerList.getListenerList();
PopupMenuEvent e=null;
for (int i = listeners.length-2; i >=0; i-=2) {
if (listeners[i]==PopupMenuListener.class) {
if (e == null)
e = new PopupMenuEvent(this);
((PopupMenuListener)listeners[i+1]).popupMenuWillBecomeVisible(e);
}
}
}
|
public AccessibleContext getAccessibleContext() {
if ( accessibleContext == null ) {
accessibleContext = new AccessibleJComboBox();
}
return accessibleContext;
}
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. |
public Action getAction() {
return action;
}
Returns the currently set Action for this
ActionEvent source, or null if no
Action is set. |
public String getActionCommand() {
return actionCommand;
}
Returns the action command that is included in the event sent to
action listeners. |
public ActionListener[] getActionListeners() {
return (ActionListener[])listenerList.getListeners(
ActionListener.class);
}
Returns an array of all the ActionListeners added
to this JComboBox with addActionListener(). |
public ComboBoxEditor getEditor() {
return editor;
}
Returns the editor used to paint and edit the selected item in the
JComboBox field. |
public Object getItemAt(int index) {
return dataModel.getElementAt(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. |
public int getItemCount() {
return dataModel.getSize();
}
Returns the number of items in the list. |
public ItemListener[] getItemListeners() {
return (ItemListener[])listenerList.getListeners(ItemListener.class);
}
Returns an array of all the ItemListeners added
to this JComboBox with addItemListener(). |
public JComboBox.KeySelectionManager getKeySelectionManager() {
return keySelectionManager;
}
Returns the list's key-selection manager. |
public int getMaximumRowCount() {
return maximumRowCount;
}
Returns the maximum number of items the combo box can display
without a scrollbar |
public ComboBoxModel getModel() {
return dataModel;
}
Returns the data model currently used by the JComboBox. |
public PopupMenuListener[] getPopupMenuListeners() {
return (PopupMenuListener[])listenerList.getListeners(
PopupMenuListener.class);
}
Returns an array of all the PopupMenuListeners added
to this JComboBox with addPopupMenuListener(). |
public Object getPrototypeDisplayValue() {
return prototypeDisplayValue;
}
Returns the "prototypical display" value - an Object used
for the calculation of the display height and width. |
public ListCellRenderer getRenderer() {
return renderer;
}
Returns the renderer used to display the selected item in the
JComboBox field. |
public int getSelectedIndex() {
Object sObject = dataModel.getSelectedItem();
int i,c;
Object obj;
for ( i=0,c=dataModel.getSize();i< c;i++ ) {
obj = dataModel.getElementAt(i);
if ( obj != null && obj.equals(sObject) )
return i;
}
return -1;
}
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. |
public Object getSelectedItem() {
return dataModel.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. |
public Object[] getSelectedObjects() {
Object selectedObject = getSelectedItem();
if ( selectedObject == null )
return new Object[0];
else {
Object result[] = new Object[1];
result[0] = selectedObject;
return result;
}
}
Returns an array containing the selected item.
This method is implemented for compatibility with
ItemSelectable. |
public ComboBoxUI getUI() {
return(ComboBoxUI)ui;
}
Returns the L&F object that renders this component. |
public String getUIClassID() {
return uiClassID;
}
Returns the name of the L&F class that renders this component. |
public void hidePopup() {
setPopupVisible(false);
}
Causes the combo box to close its popup window. |
public void insertItemAt(Object anObject,
int index) {
checkMutableComboBoxModel();
((MutableComboBoxModel)dataModel).insertElementAt(anObject,index);
}
Inserts an item into the item list at a given index.
This method works only if the JComboBox uses a
mutable data model. |
protected void installAncestorListener() {
addAncestorListener(new AncestorListener(){
public void ancestorAdded(AncestorEvent event){ hidePopup();}
public void ancestorRemoved(AncestorEvent event){ hidePopup();}
public void ancestorMoved(AncestorEvent event){
if (event.getSource() != JComboBox.this)
hidePopup();
}});
}
|
public void intervalAdded(ListDataEvent e) {
if (selectedItemReminder != dataModel.getSelectedItem()) {
selectedItemChanged();
}
}
This method is public as an implementation side effect.
do not call or override. |
public void intervalRemoved(ListDataEvent e) {
contentsChanged(e);
}
This method is public as an implementation side effect.
do not call or override. |
public boolean isEditable() {
return isEditable;
}
Returns true if the JComboBox is editable.
By default, a combo box is not editable. |
public boolean isLightWeightPopupEnabled() {
return lightWeightPopupEnabled;
}
Gets the value of the lightWeightPopupEnabled
property. |
public boolean isPopupVisible() {
return getUI().isPopupVisible(this);
}
Determines the visibility of the popup. |
protected String paramString() {
String selectedItemReminderString = (selectedItemReminder != null ?
selectedItemReminder.toString() :
"");
String isEditableString = (isEditable ? "true" : "false");
String lightWeightPopupEnabledString = (lightWeightPopupEnabled ?
"true" : "false");
return super.paramString() +
",isEditable=" + isEditableString +
",lightWeightPopupEnabled=" + lightWeightPopupEnabledString +
",maximumRowCount=" + maximumRowCount +
",selectedItemReminder=" + selectedItemReminderString;
}
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. |
public void processKeyEvent(KeyEvent e) {
if ( e.getKeyCode() == KeyEvent.VK_TAB ) {
hidePopup();
}
super.processKeyEvent(e);
}
Handles KeyEvents, looking for the Tab key.
If the Tab key is found, the popup window is closed. |
public void removeActionListener(ActionListener l) {
if ((l != null) && (getAction() == l)) {
setAction(null);
} else {
listenerList.remove(ActionListener.class, l);
}
}
Removes an ActionListener. |
public void removeAllItems() {
checkMutableComboBoxModel();
MutableComboBoxModel model = (MutableComboBoxModel)dataModel;
int size = model.getSize();
if ( model instanceof DefaultComboBoxModel ) {
((DefaultComboBoxModel)model).removeAllElements();
}
else {
for ( int i = 0; i < size; ++i ) {
Object element = model.getElementAt( 0 );
model.removeElement( element );
}
}
selectedItemReminder = null;
if (isEditable()) {
editor.setItem(null);
}
}
Removes all items from the item list. |
public void removeItem(Object anObject) {
checkMutableComboBoxModel();
((MutableComboBoxModel)dataModel).removeElement(anObject);
}
Removes an item from the item list.
This method works only if the JComboBox uses a
mutable data model. |
public void removeItemAt(int anIndex) {
checkMutableComboBoxModel();
((MutableComboBoxModel)dataModel).removeElementAt( anIndex );
}
Removes the item at anIndex
This method works only if the JComboBox uses a
mutable data model. |
public void removeItemListener(ItemListener aListener) {
listenerList.remove(ItemListener.class,aListener);
}
|
public void removePopupMenuListener(PopupMenuListener l) {
listenerList.remove(PopupMenuListener.class,l);
}
Removes a PopupMenuListener. |
public boolean selectWithKeyChar(char keyChar) {
int index;
if ( keySelectionManager == null )
keySelectionManager = createDefaultKeySelectionManager();
index = keySelectionManager.selectionForKey(keyChar,getModel());
if ( index != -1 ) {
setSelectedIndex(index);
return true;
}
else
return false;
}
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. |
protected void selectedItemChanged() {
if (selectedItemReminder != null ) {
fireItemStateChanged(new ItemEvent(this,ItemEvent.ITEM_STATE_CHANGED,
selectedItemReminder,
ItemEvent.DESELECTED));
}
// set the new selected item.
selectedItemReminder = dataModel.getSelectedItem();
if (selectedItemReminder != null ) {
fireItemStateChanged(new ItemEvent(this,ItemEvent.ITEM_STATE_CHANGED,
selectedItemReminder,
ItemEvent.SELECTED));
}
}
This protected method is implementation specific. Do not access directly
or override. |
public void setAction(Action a) {
Action oldValue = getAction();
if (action==null || !action.equals(a)) {
action = a;
if (oldValue!=null) {
removeActionListener(oldValue);
oldValue.removePropertyChangeListener(actionPropertyChangeListener);
actionPropertyChangeListener = null;
}
configurePropertiesFromAction(action);
if (action!=null) {
// Don't add if it is already a listener
if (!isListener(ActionListener.class, action)) {
addActionListener(action);
}
// Reverse linkage:
actionPropertyChangeListener = createActionPropertyChangeListener(action);
action.addPropertyChangeListener(actionPropertyChangeListener);
}
firePropertyChange("action", oldValue, action);
}
}
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 {@code PropertyChangeListener} invokes the
{@code actionPropertyChanged} method when a property in the
{@code Action} changes. |
public void setActionCommand(String aCommand) {
actionCommand = aCommand;
}
Sets the action command that should be included in the event
sent to action listeners. |
public void setEditable(boolean aFlag) {
boolean oldFlag = isEditable;
isEditable = aFlag;
firePropertyChange( "editable", oldFlag, isEditable );
}
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. |
public void setEditor(ComboBoxEditor anEditor) {
ComboBoxEditor oldEditor = editor;
if ( editor != null ) {
editor.removeActionListener(this);
}
editor = anEditor;
if ( editor != null ) {
editor.addActionListener(this);
}
firePropertyChange( "editor", oldEditor, 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. |
public void setEnabled(boolean b) {
super.setEnabled(b);
firePropertyChange( "enabled", !isEnabled(), isEnabled() );
}
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). |
public void setKeySelectionManager(JComboBox.KeySelectionManager aManager) {
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. |
public void setLightWeightPopupEnabled(boolean aFlag) {
boolean oldFlag = lightWeightPopupEnabled;
lightWeightPopupEnabled = aFlag;
firePropertyChange("lightWeightPopupEnabled", oldFlag, lightWeightPopupEnabled);
}
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. |
public void setMaximumRowCount(int count) {
int oldCount = maximumRowCount;
maximumRowCount = count;
firePropertyChange( "maximumRowCount", oldCount, maximumRowCount );
}
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. |
public void setModel(ComboBoxModel aModel) {
ComboBoxModel oldModel = dataModel;
if (oldModel != null) {
oldModel.removeListDataListener(this);
}
dataModel = aModel;
dataModel.addListDataListener(this);
// set the current selected item.
selectedItemReminder = dataModel.getSelectedItem();
firePropertyChange( "model", oldModel, dataModel);
}
Sets the data model that the JComboBox uses to obtain
the list of items. |
public void setPopupVisible(boolean v) {
getUI().setPopupVisible(this, v);
}
Sets the visibility of the popup. |
public void setPrototypeDisplayValue(Object prototypeDisplayValue) {
Object oldValue = this.prototypeDisplayValue;
this.prototypeDisplayValue = prototypeDisplayValue;
firePropertyChange("prototypeDisplayValue", oldValue, 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. |
public void setRenderer(ListCellRenderer aRenderer) {
ListCellRenderer oldRenderer = renderer;
renderer = aRenderer;
firePropertyChange( "renderer", oldRenderer, renderer );
invalidate();
}
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. |
public void setSelectedIndex(int anIndex) {
int size = dataModel.getSize();
if ( anIndex == -1 ) {
setSelectedItem( null );
} else if ( anIndex < -1 || anIndex >= size ) {
throw new IllegalArgumentException("setSelectedIndex: " + anIndex + " out of bounds");
} else {
setSelectedItem(dataModel.getElementAt(anIndex));
}
}
Selects the item at index anIndex. |
public void setSelectedItem(Object anObject) {
Object oldSelection = selectedItemReminder;
Object objectToSelect = anObject;
if (oldSelection == null || !oldSelection.equals(anObject)) {
if (anObject != null && !isEditable()) {
// For non editable combo boxes, an invalid selection
// will be rejected.
boolean found = false;
for (int i = 0; i < dataModel.getSize(); i++) {
Object element = dataModel.getElementAt(i);
if (anObject.equals(element)) {
found = true;
objectToSelect = element;
break;
}
}
if (!found) {
return;
}
}
// Must toggle the state of this flag since this method
// call may result in ListDataEvents being fired.
selectingItem = true;
dataModel.setSelectedItem(objectToSelect);
selectingItem = false;
if (selectedItemReminder != dataModel.getSelectedItem()) {
// in case a users implementation of ComboBoxModel
// doesn't fire a ListDataEvent when the selection
// changes.
selectedItemChanged();
}
}
fireActionEvent();
}
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. |
public void setUI(ComboBoxUI ui) {
super.setUI(ui);
}
Sets the L&F object that renders this component. |
public void showPopup() {
setPopupVisible(true);
}
Causes the combo box to display its popup window. |
public void updateUI() {
setUI((ComboBoxUI)UIManager.getUI(this));
ListCellRenderer renderer = getRenderer();
if (renderer instanceof Component) {
SwingUtilities.updateComponentTreeUI((Component)renderer);
}
}
Resets the UI property to a value from the current look and feel. |