org.itsnat.comp.list

Interface ItsNatComboBox

All Superinterfaces:

ItemSelectable, ItsNatComponent, ItsNatElementComponent, ItsNatList, ItsNatUserData

All Known Subinterfaces:

ItsNatFreeComboBox, ItsNatHTMLSelectComboBox

public interface ItsNatComboBox
extends ItsNatList, ItemSelectable

Is the base interface of combo box components.

Items of combo boxes are not editable "in place", for instance a call to ItsNatList.setItsNatListCellEditor(ItsNatListCellEditor) throws an ItsNatException.

By default this component type uses a javax.swing.DefaultComboBoxModel data model.

When the selection item changes the component notifies to all java.awt.event.ItemListener listeners registered (this component implements java.awt.ItemSelectable).

Author:

Jose Maria Arranz Santamaria

Method Summary

Methods

Modifier and Type	Method and Description
void	addElement(Object anObject) Adds a new value to the list model.
ComboBoxModel	getComboBoxModel() Returns the current data model of this component.
ItemListener[]	getItemListeners() Returns all ItemListener objects registered.
Object	getSelectedItem() Returns the current selected item.
void	insertElementAt(int index, Object anObject) Inserts a new value in the list model at the specified position.
void	removeAllElements() Removes all items.
void	removeElement(Object anObject) Removes the specified value from the list model.
void	removeElementAt(int index) Removes a list item at the specified index.
void	setComboBoxModel(ComboBoxModel dataModel) Changes the data model of this component.
void	setSelectedItem(Object anObject) Sets the current selected item.

Methods inherited from interface org.itsnat.comp.list.ItsNatList

createDefaultListModel, getEditingIndex, getEditorActivatorEvent, getItsNatListCellEditor, getItsNatListCellRenderer, getItsNatListStructure, getItsNatListUI, getListModel, getSelectedIndex, indexOf, isEditing, isEditingEnabled, setEditingEnabled, setEditorActivatorEvent, setItsNatListCellEditor, setItsNatListCellRenderer, setListModel, setSelectedIndex, startEditingAt

Methods inherited from interface org.itsnat.comp.ItsNatElementComponent

getElement, getItsNatElementComponentUI

Methods inherited from interface org.itsnat.comp.ItsNatComponent

addEventListener, addEventListener, addEventListener, addEventListener, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, disableEventListener, disableEventListener, dispose, enableEventListener, enableEventListener, getArtifact, getArtifact, getItsNatComponentManager, getItsNatComponentUI, getItsNatDocument, getNode, getPropertyChangeListeners, getPropertyChangeListeners, getVetoableChangeListeners, isDisposed, isEnabled, registerArtifact, removeArtifact, removeEventListener, removeEventListener, removeEventListener, removeEventListener, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, setEnabled, setEventListenerParams, setEventListenerParams, setNode

Methods inherited from interface org.itsnat.core.ItsNatUserData

containsUserValueName, getUserValue, getUserValueNames, removeUserValue, setUserValue

Methods inherited from interface java.awt.ItemSelectable

addItemListener, getSelectedObjects, removeItemListener

Method Detail

getComboBoxModel

ComboBoxModel getComboBoxModel()

Returns the current data model of this component.

Returns:

the current data model

See Also:

setComboBoxModel(javax.swing.ComboBoxModel)

setComboBoxModel

void setComboBoxModel(ComboBoxModel dataModel)

Changes the data model of this component.

Parameters:

dataModel - the new data model.

See Also:

getComboBoxModel(), ItsNatList.setListModel(javax.swing.ListModel)

addElement

void addElement(Object anObject)

Adds a new value to the list model.

This method only works if the data model is a javax.swing.MutableComboBoxModel.

Parameters:

anObject - the value to add at the end of the list.

insertElementAt

void insertElementAt(int index,
                   Object anObject)

Inserts a new value in the list model at the specified position.

This method only works if the data model is a javax.swing.MutableComboBoxModel.

Parameters:

index - index of the new list item.

anObject - the value to add at the end of the list.

removeElement

void removeElement(Object anObject)

Removes the specified value from the list model.

This method only works if the data model is a javax.swing.MutableComboBoxModel.

Parameters:

anObject - the value to remove.

removeElementAt

void removeElementAt(int index)

Removes a list item at the specified index.

This method only works if the data model is a javax.swing.MutableComboBoxModel.

Parameters:

index - index of the item to remove.

removeAllElements

void removeAllElements()

Removes all items.

This method only works if the data model is a javax.swing.MutableComboBoxModel.

getSelectedItem

Object getSelectedItem()

Returns the current selected item.

This method delegates to ComboBoxModel.getSelectedItem().

Returns:

the current selected item or null if none is selected.

setSelectedItem

void setSelectedItem(Object anObject)

Sets the current selected item.

This method delegates to ComboBoxModel.setSelectedItem(Object).

Parameters:

anObject - the item value to select.

getItemListeners

ItemListener[] getItemListeners()

Returns all ItemListener objects registered.

Returns:

an array with the registered listeners.